plugins.finalcutpro.fullscreen.shortcuts.md

docs » plugins.finalcutpro.fullscreen.shortcuts

---

Fullscreen Shortcuts

API Overview

• Variables - Configurable values
• enabled
• Functions - API calls offered directly by the extension
• checkCommand
• ninjaKeyStroke
• performCommand
• update

API Documentation

Variables

enabled

Signature	plugins.finalcutpro.fullscreen.shortcuts.enabled <cp.prop: boolean>
Type	Variable
Description	Is the module enabled?

Functions

checkCommand

Signature	plugins.finalcutpro.fullscreen.shortcuts.checkCommand(whichModifier, whichKey) -> none
Type	Function
Description	Checks to see if a shortcut has been pressed, then processes.
Parameters	whichModifier - Which modifier key to check. whichKey - Which key to check.
Returns	None

ninjaKeyStroke

Signature	plugins.finalcutpro.fullscreen.shortcuts.ninjaKeyStroke(whichModifier, whichKey) -> none
Type	Function
Description	Performs a Ninja Key Stoke.
Parameters	whichModifier - Modifier Key whichKey - Key
Returns	None

performCommand

Signature	plugins.finalcutpro.fullscreen.shortcuts.performCommand(cmd, whichModifier, whichKey) -> boolean
Type	Function
Description	Performs a command.
Parameters	cmd - The Command. whichModifier - Which modifier key to check. whichKey - Which key to check.
Returns	true if successful otherwise false

update

Signature	plugins.finalcutpro.fullscreen.shortcuts.update() -> none
Type	Function
Description	Toggles the watches for monitoring fullscreen playback.
Parameters	None
Returns	None