docs » cp.apple.finalcutpro.main.Viewer


Viewer Module.

API Overview

  • Constructors - API calls which return an object, typically one that offers API methods
  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Constructors

new

Signature cp.apple.finalcutpro.main.Viewer.new(app, eventViewer) -> Viewer
Type Constructor
Description Creates a new Viewer instance.
Parameters
  • * app - The FCP application.
  • * eventViewer - If `true`, the viewer is the Event Viewer.
Returns
  • * The new `Viewer` instance.

Methods

app

Signature cp.apple.finalcutpro.main.Viewer:app() -> application
Type Method
Description Returns the application.
Parameters
  • * None
Returns
  • * The application.

isEventViewer

Signature cp.apple.finalcutpro.main.Viewer:isEventViewer() -> boolean
Type Method
Description Returns true if this is the Event Viewer.
Parameters
  • * None
Returns
  • * `true` if this is the Event Viewer.

isMainViewer

Signature cp.apple.finalcutpro.main.Viewer:isMainViewer() -> boolean
Type Method
Description Returns true if this is the main Viewer.
Parameters
  • * None
Returns
  • * `true` if this is the main Viewer.

results matching ""

    No results matching ""