docs » plugins.finalcutpro.timeline.pluginshortcuts


Controls for Final Cut Pro's Plugin Shortcuts (for use with Hack Shortcuts).

API Overview

API Documentation

Functions

applyShortcut

Signature plugins.finalcutpro.timeline.pluginshortcuts.applyShortcut(handlerId, shortcutNumber) -> boolean
Type Function
Description Applies a shortcut.
Parameters
  • * `handlerId` - The action handler ID.
  • * `shortcutNumber` - The shortcut number, between 1 and 5, which is being assigned.
Returns
  • * `true` if successful otherwise `false`

assignShortcut

Signature plugins.finalcutpro.timeline.pluginshortcuts.assignShortcut(shortcutNumber, handlerId) -> nothing
Type Function
Description Asks the user to assign the specified video effect shortcut number to a selected effect.
Parameters
  • * `handlerId` - The action handler ID.
  • * `shortcutNumber` - The shortcut number, between 1 and 5, which is being assigned.
Returns
  • * Nothing

getShortcut

Signature plugins.finalcutpro.timeline.pluginshortcuts.getShortcut(handlerId, shortcutNumber) -> boolean
Type Function
Description Gets a shortcut.
Parameters
  • * `handlerId` - The action handler ID.
  • * `shortcutNumber` - The shortcut number, between 1 and 5, which is being assigned.
Returns
  • * `true` if successful otherwise `false`

init

Signature plugins.finalcutpro.timeline.pluginshortcuts.init(handlerId, action, shortcutNumber) -> none
Type Function
Description Initialise the module.
Parameters
  • * `deps` - Dependancies
Returns
  • * The module

setShortcut

Signature plugins.finalcutpro.timeline.pluginshortcuts.setShortcut(handlerId, action, shortcutNumber) -> none
Type Function
Description Sets a shortcut.
Parameters
  • * `handlerId` - The action handler ID.
  • * `action` - The action.
  • * `shortcutNumber` - The shortcut number, between 1 and 5, which is being assigned.
Returns
  • * `true` if successful otherwise `false`

results matching ""

    No results matching ""