#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

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Constants

Signaturecp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION <semver>
TypeConstant
DescriptionThe earliest version this API supports.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 23

Signaturecp.blackmagic.resolve.preferences <cp.app.prefs>
TypeConstant
DescriptionThe cp.app.prefs for DaVinci Resolve.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 35

#Fields

Signaturecp.blackmagic.resolve.Color <cp.blackmagic.resolve.Color>
TypeField
DescriptionThe Color Workspace.
Parameters
  • None
Returns
  • the Browser
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 338

Signaturecp.blackmagic.resolve.currentLocale <cp.prop: cp.i18n.localeID; live>
TypeField
DescriptionGets and sets the current locale for FCPX.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 124

Signaturecp.blackmagic.resolve:isFrontmost <cp.prop: boolean; read-only; live>
TypeField
DescriptionIs DaVinci Resolve Frontmost?
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 90

Signaturecp.blackmagic.resolve.isInstalled <cp.prop: boolean; read-only>
TypeField
DescriptionIs any version of DaVinci Resolve Installed?
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 83

Signaturecp.blackmagic.resolve:isModalDialogOpen <cp.prop: boolean; read-only>
TypeField
DescriptionIs a modal dialog currently open?
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 97

Signaturecp.blackmagic.resolve.isRunning <cp.prop: boolean; read-only>
TypeField
DescriptionIs DaVinci Resolve Running?
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 55

Signaturecp.blackmagic.resolve.isShowing <cp.prop: boolean; read-only; live>
TypeField
DescriptionIs Final Cut visible on screen?
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 76

Signaturecp.blackmagic.resolve.isSupported <cp.prop: boolean; read-only; live>
TypeField
DescriptionIs a supported version of DaVinci Resolve installed?
Notes
  • Supported version refers to any version of DaVinci Resolve equal or higher to cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 104

Signaturecp.blackmagic.resolve.isUnsupported <cp.prop: boolean; read-only>
TypeField
DescriptionIs an unsupported version of DaVinci Resolve installed?
Notes
  • Supported version refers to any version of DaVinci Resolve equal or higher to cp.blackmagic.resolve.EARLIEST_SUPPORTED_VERSION
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 145

Signaturecp.blackmagic.resolve.primaryWindow <PrimaryWindow>
TypeField
DescriptionThe DaVinci Resolve Primary Window.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 325

Signaturecp.blackmagic.resolve.supportedLocales <cp.prop: table of cp.i18n.localeID; read-only>
TypeField
DescriptionThe list of supported locales for this version of FCPX.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 117

Signaturecp.blackmagic.resolve.UI <cp.prop: hs.axuielement; read-only; live>
TypeField
DescriptionThe DaVinci Resolve axuielement, if available.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 62

Signaturecp.blackmagic.resolve.version <cp.prop: semver; read-only; live>
TypeField
DescriptionThe version number of the running or default installation of FCPX as a semver.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 131

Signaturecp.blackmagic.resolve.versionString <cp.prop: string; read-only; live>
TypeField
DescriptionThe version number of the running or default installation of FCPX as a string.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 138

Signaturecp.blackmagic.resolve.windowsUI <cp.prop: hs.axuielement; read-only; live>
TypeField
DescriptionReturns the UI containing the list of windows in the app.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 69

#Methods

Signaturecp.blackmagic.resolve:bundleID() -> string
TypeMethod
DescriptionReturns the Bundle ID for the app.
Parameters
  • None
Returns
  • The Bundle ID
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 155

Signaturecp.blackmagic.resolve:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will hide the FCP.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 266

Signaturecp.blackmagic.resolve:doLaunch() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will launch, or focus it if already running FCP.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 199

Signaturecp.blackmagic.resolve:doQuit() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will quit FCP.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 293

Signaturecp.blackmagic.resolve:doRestart() -> cp.rx.go.Statement
TypeMethod
DescriptionReturns a Statement that will restart DaVinci Resolve, if it is running. If not, nothing happens.
Parameters
  • None.
Returns
  • The FCP instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 212

Signaturecp.blackmagic.resolve:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that will show FCP on-screen.
Parameters
  • None
Returns
  • The Statement to execute.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 239

Signaturecp.blackmagic.resolve:getPath() -> string or nil
TypeMethod
DescriptionPath to DaVinci Resolve Application
Parameters
  • None
Returns
  • A string containing DaVinci Resolve's filesystem path, or nil if DaVinci Resolve's path could not be determined.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 306

Signaturecp.blackmagic.resolve:hide() -> self
TypeMethod
DescriptionHides DaVinci Resolve
Parameters
  • None
Returns
  • The FCP instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 252

Signaturecp.blackmagic.resolve:launch([waitSeconds], [path]) -> self
TypeMethod
DescriptionLaunches DaVinci Resolve, or brings it to the front if it was already running.
Parameters
  • waitSeconds - If provided, the number of seconds to wait until the launch completes. If nil, it will return immediately.
  • path - An optional full path to an application without an extension (i.e /Applications/DaVinci Resolve 10.3.4). This allows you to load previous versions of the application.
Returns
  • The FCP instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 181

Signaturecp.blackmagic.resolve:notifier() -> cp.ui.notifier
TypeMethod
DescriptionReturns a notifier that is tracking the application UI element. It has already been started.
Parameters
  • None
Returns
  • The notifier.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 168

Signaturecp.blackmagic.resolve:quit([waitSeconds]) -> self
TypeMethod
DescriptionQuits DaVinci Resolve, if it's running.
Parameters
  • waitSeconds - The number of seconds to wait for the quit to complete.
Returns
  • The FCP instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 279

Signaturecp.blackmagic.resolve:show() -> cp.blackmagic.resolve
TypeMethod
DescriptionActivate DaVinci Resolve, if it is running.
Parameters
  • None
Returns
  • The FCP instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/init.lua line 225