shortcuts

Last updated 2 months ago

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.

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.

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.

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.

Signature

plugins.finalcutpro.hacks.shortcuts.uninstalled <cp.prop: boolean; read-only>

Type

Constant

Description

A property that returns true if shortcuts is working on something.

Functions

init

Signature

plugins.finalcutpro.hacks.shortcuts.init() -> none

Type

Function

Description

Initialises the module.

Parameters

Returns

install

Signature

plugins.finalcutpro.hacks.shortcuts.install(silently) -> none

Type

Function

Description

Installs the Hacks Shortcuts.

Parameters

Returns

refresh

Signature

plugins.finalcutpro.hacks.shortcuts.refresh() -> none

Type

Function

Description

Refresh Hacks Shortcuts if they're enabled.

Parameters

Returns

uninstall

Signature

plugins.finalcutpro.hacks.shortcuts.uninstall(silently) -> none

Type

Function

Description

Uninstalls the Hacks Shortcuts, if they have been installed

Parameters

Returns

Notes

update

Signature

plugins.finalcutpro.hacks.shortcuts.update() -> none

Type

Function

Description

Read shortcut keys from the Final Cut Pro Preferences.

Parameters

Returns