This repository was archived by the owner on Jun 9, 2023. It is now read-only.

41 lines (32 loc) · 2.53 KB

docs » plugins.finalcutpro.actions.custom

Creates a bunch of commands that can be used to assign actions to. This allows you to assign any action to a shortcut key in CommandPost.

API Overview

Variables - Configurable values
shortcuts
Functions - API calls offered directly by the extension
apply
assign

API Documentation

Variables

shortcuts

Signature	`plugins.finalcutpro.actions.custom.shortcuts <cp.prop: table>`
Type	Variable
Description	Table of shortcuts.

Functions

apply

Signature	`plugins.finalcutpro.actions.custom.apply(id) -> none`
Type	Function
Description	Applies a shortcut.
Parameters	`id` - The Custom Action ID.
Returns	None

assign

Signature	`plugins.finalcutpro.actions.custom.assign(id, handlerId) -> none`
Type	Function
Description	Assigns an Action to a Shortcut via a Console.
Parameters	`id` - The Custom Action ID. `completionFn` - An optional completion function that triggers when a selection is made.
Returns	None