# cp.blackmagic.resolve.main.PrimaryWindow

Primary Window Module.


# API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • PrimaryWindow

Fields - Variables which can only be accessed from an object returned by a constructor

  • doShow
  • resolve

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

  • show

# API Documentation

# Functions

# matches

Signature cp.blackmagic.resolve.main.PrimaryWindow.matches(w) -> boolean
Type Function
Description Checks to see if a window matches the PrimaryWindow requirements
Parameters
  • w - The window to check
Returns
  • true if matched otherwise false
Notes None
Examples None
Source src/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 23

# Constructors

# PrimaryWindow

Signature cp.blackmagic.resolve.main.PrimaryWindow(app) -> PrimaryWindow object
Type Constructor
Description Creates a new PrimaryWindow.
Parameters
  • None
Returns
  • PrimaryWindow
Notes None
Examples None
Source src/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 40

# Fields

# doShow

Signature cp.blackmagic.resolve.main.PrimaryWindow:doShow() -> PrimaryWindow
Type Field
Description A Statement that attempts to show the Primary Window.
Returns
  • The Statement, which resolves as either true or sends an error.
Notes None
Source src/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 92

# resolve

Signature cp.blackmagic.resolve.main.PrimaryWindow.resolve -> cp.blackmagic.resolve
Type Field
Description The main Resolve application root.
Notes None
Source src/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 51

# Methods

# show

Signature cp.blackmagic.resolve.main.PrimaryWindow:show() -> PrimaryWindow
Type Method
Description Shows the Primary Window.
Parameters
  • None
Returns
  • The PrimaryWindow instance.
Notes None
Examples None
Source src/extensions/cp/blackmagic/resolve/main/PrimaryWindow.lua line 75