#cp.blackmagic.resolve.main.PrimaryWindow

Primary Window Module.


#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

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

#Functions

Signaturecp.blackmagic.resolve.main.PrimaryWindow.matches(w) -> boolean
TypeFunction
DescriptionChecks to see if a window matches the PrimaryWindow requirements
Parameters
  • w - The window to check
Returns
  • true if matched otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 23

#Constructors

Signaturecp.blackmagic.resolve.main.PrimaryWindow(app) -> PrimaryWindow object
TypeConstructor
DescriptionCreates a new PrimaryWindow.
Parameters
  • None
Returns
  • PrimaryWindow
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 40

#Fields

Signaturecp.blackmagic.resolve.main.PrimaryWindow:doShow() -> PrimaryWindow
TypeField
DescriptionA Statement that attempts to show the Primary Window.
Returns
  • The Statement, which resolves as either true or sends an error.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 92

Signaturecp.blackmagic.resolve.main.PrimaryWindow.resolve -> cp.blackmagic.resolve
TypeField
DescriptionThe main Resolve application root.
NotesNone
Sourcesrc/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 51

#Methods

Signaturecp.blackmagic.resolve.main.PrimaryWindow:show() -> PrimaryWindow
TypeMethod
DescriptionShows the Primary Window.
Parameters
  • None
Returns
  • The PrimaryWindow instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 75