docs » plugins.finalcutpro.hacks.shortcuts


Plugin that allows the user to customise the CommandPost shortcuts via the Final Cut Pro Command Editor.

API Overview

API Documentation

Constants

active

Signature plugins.finalcutpro.hacks.shortcuts.active <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the FCPX shortcuts are active.

installed

Signature plugins.finalcutpro.hacks.shortcuts.installed <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the FCPX Hacks Shortcuts are currently installed in FCPX.

onboardingRequired

Signature plugins.finalcutpro.hacks.shortcuts.onboardingRequired <cp.prop: boolean>
Type Constant
Description If true, the initial setup has been completed.

requiresActivation

Signature plugins.finalcutpro.hacks.shortcuts.requiresActivation <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the custom shortcuts are installed in FCPX but not active.

requiresDeactivation

Signature plugins.finalcutpro.hacks.shortcuts.requiresDeactivation <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the FCPX shortcuts are active but shortcuts are not installed.

setupRequired

Signature plugins.finalcutpro.hacks.shortcuts.setupRequired <cp.prop: boolean; read-only>
Type Constant
Description If true, the user needs to configure Hacks Shortcuts.

supported

Signature plugins.finalcutpro.hacks.shortcuts.supported <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the a supported version of FCPX is installed.

uninstalled

Signature plugins.finalcutpro.hacks.shortcuts.uninstalled <cp.prop: boolean; read-only>
Type Constant
Description A property that returns true if the shortcuts are neither original or installed correctly.

Functions

editCommands

Signature plugins.finalcutpro.hacks.shortcuts.editCommands() -> none
Type Function
Description Launch the Final Cut Pro Command Editor
Parameters
  • None
Returns
  • None

init

Signature plugins.finalcutpro.hacks.shortcuts.init() -> none
Type Function
Description Initialises the module.
Parameters
  • None
Returns
  • None

install

Signature plugins.finalcutpro.hacks.shortcuts.install(silently) -> none
Type Function
Description Installs the Hacks Shortcuts.
Parameters
  • `silently` - (optional) If `true`, the user will not be prompted first.
Returns
  • `true` if successful.

refresh

Signature plugins.finalcutpro.hacks.shortcuts.refresh() -> none
Type Function
Description Refresh Hacks Shortcuts if they're enabled.
Parameters
  • None
Returns
  • None

uninstall

Signature plugins.finalcutpro.hacks.shortcuts.uninstall(silently) -> none
Type Function
Description Uninstalls the Hacks Shortcuts, if they have been installed
Parameters
  • `silently` - (optional) If `true`, the user will not be prompted first.
Returns
  • `true` if successful.
Notes
  • Used by Trash Preferences menubar command.

update

Signature plugins.finalcutpro.hacks.shortcuts.update() -> none
Type Function
Description Read shortcut keys from the Final Cut Pro Preferences.
Parameters
  • None
Returns
  • None

results matching ""

    No results matching ""