#cp.blackmagic.resolve
The Blackmagic DaVinci Resolve Extension.
#Submodules
#API Overview
Constants - Useful values which cannot be changed
Fields - Variables which can only be accessed from an object returned by a constructor
- Color
- currentLocale
- isFrontmost
- isInstalled
- isModalDialogOpen
- isRunning
- isShowing
- isSupported
- isUnsupported
- primaryWindow
- supportedLocales
- UI
- version
- versionString
- windowsUI
Methods - API calls which can only be made on an object returned by a constructor
#API Documentation
#Constants
Signature | cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION <semver> |
Type | Constant |
Description | The earliest version this API supports. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 23 |
Signature | cp.blackmagic.resolve.preferences <cp.app.prefs> |
Type | Constant |
Description | The cp.app.prefs for DaVinci Resolve. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 35 |
#Fields
Signature | cp.blackmagic.resolve.Color <cp.blackmagic.resolve.Color> |
Type | Field |
Description | The Color Workspace. |
Parameters |
|
Returns |
|
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 338 |
Signature | cp.blackmagic.resolve.currentLocale <cp.prop: cp.i18n.localeID; live> |
Type | Field |
Description | Gets and sets the current locale for FCPX. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 124 |
Signature | cp.blackmagic.resolve:isFrontmost <cp.prop: boolean; read-only; live> |
Type | Field |
Description | Is DaVinci Resolve Frontmost? |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 90 |
Signature | cp.blackmagic.resolve.isInstalled <cp.prop: boolean; read-only> |
Type | Field |
Description | Is any version of DaVinci Resolve Installed? |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 83 |
Signature | cp.blackmagic.resolve:isModalDialogOpen <cp.prop: boolean; read-only> |
Type | Field |
Description | Is a modal dialog currently open? |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 97 |
Signature | cp.blackmagic.resolve.isRunning <cp.prop: boolean; read-only> |
Type | Field |
Description | Is DaVinci Resolve Running? |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 55 |
Signature | cp.blackmagic.resolve.isShowing <cp.prop: boolean; read-only; live> |
Type | Field |
Description | Is Final Cut visible on screen? |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 76 |
Signature | cp.blackmagic.resolve.isSupported <cp.prop: boolean; read-only; live> |
Type | Field |
Description | Is a supported version of DaVinci Resolve installed? |
Notes |
|
Source | src/extensions/cp/blackmagic/resolve/init.lua line 104 |
Signature | cp.blackmagic.resolve.isUnsupported <cp.prop: boolean; read-only> |
Type | Field |
Description | Is an unsupported version of DaVinci Resolve installed? |
Notes |
|
Source | src/extensions/cp/blackmagic/resolve/init.lua line 145 |
Signature | cp.blackmagic.resolve.primaryWindow <PrimaryWindow> |
Type | Field |
Description | The DaVinci Resolve Primary Window. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 325 |
Signature | cp.blackmagic.resolve.supportedLocales <cp.prop: table of cp.i18n.localeID; read-only> |
Type | Field |
Description | The list of supported locales for this version of FCPX. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 117 |
Signature | cp.blackmagic.resolve.UI <cp.prop: hs.axuielement; read-only; live> |
Type | Field |
Description | The DaVinci Resolve axuielement , if available. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 62 |
Signature | cp.blackmagic.resolve.version <cp.prop: semver; read-only; live> |
Type | Field |
Description | The version number of the running or default installation of FCPX as a semver . |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 131 |
Signature | cp.blackmagic.resolve.versionString <cp.prop: string; read-only; live> |
Type | Field |
Description | The version number of the running or default installation of FCPX as a string . |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 138 |
Signature | cp.blackmagic.resolve.windowsUI <cp.prop: hs.axuielement; read-only; live> |
Type | Field |
Description | Returns the UI containing the list of windows in the app. |
Notes | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 69 |
#Methods
Signature | cp.blackmagic.resolve:bundleID() -> string |
Type | Method |
Description | Returns the Bundle ID for the app. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 155 |
Signature | cp.blackmagic.resolve:doHide() -> cp.rx.go.Statement |
Type | Method |
Description | A Statement that will hide the FCP. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 266 |
Signature | cp.blackmagic.resolve:doLaunch() -> cp.rx.go.Statement |
Type | Method |
Description | A Statement that will launch, or focus it if already running FCP. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 199 |
Signature | cp.blackmagic.resolve:doQuit() -> cp.rx.go.Statement |
Type | Method |
Description | A Statement that will quit FCP. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 293 |
Signature | cp.blackmagic.resolve:doRestart() -> cp.rx.go.Statement |
Type | Method |
Description | Returns a Statement that will restart DaVinci Resolve, if it is running. If not, nothing happens. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 212 |
Signature | cp.blackmagic.resolve:doShow() -> cp.rx.go.Statement |
Type | Method |
Description | A Statement that will show FCP on-screen. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 239 |
Signature | cp.blackmagic.resolve:getPath() -> string or nil |
Type | Method |
Description | Path to DaVinci Resolve Application |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 306 |
Signature | cp.blackmagic.resolve:hide() -> self |
Type | Method |
Description | Hides DaVinci Resolve |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 252 |
Signature | cp.blackmagic.resolve:launch([waitSeconds], [path]) -> self |
Type | Method |
Description | Launches DaVinci Resolve, or brings it to the front if it was already running. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 181 |
Signature | cp.blackmagic.resolve:notifier() -> cp.ui.notifier |
Type | Method |
Description | Returns a notifier that is tracking the application UI element. It has already been started. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 168 |
Signature | cp.blackmagic.resolve:quit([waitSeconds]) -> self |
Type | Method |
Description | Quits DaVinci Resolve, if it's running. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 279 |
Signature | cp.blackmagic.resolve:show() -> cp.blackmagic.resolve |
Type | Method |
Description | Activate DaVinci Resolve, if it is running. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/blackmagic/resolve/init.lua line 225 |