#cp.apple.finalcutpro.timeline.VideoRole

Extends Role

A Role representing Video clips.


#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


#API Documentation

#Functions

Signaturecp.apple.finalcutpro.timeline.VideoRole.matches(element) -> boolean
TypeFunction
DescriptionChecks if the element is a "Video" Role.
Parameters
  • element - An element to check
Returns
  • A boolean
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 21

#Constructors

Signaturecp.apple.finalcutpro.timeline.VideoRole(parent, uiFinder)
TypeConstructor
DescriptionCreates a new instance with the specified parent and uiFinder.
Parameters
  • parent - the parent Element.
  • uiFinder - a function or cp.prop containing the axuielement
Returns
  • The new Row.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 36

#Fields

Signaturecp.apple.finalcutpro.timeline.VideoRole.subrolesExpanded <cp.ui.Button>
TypeField
DescriptionA Button that toggles whether the sub-captions are visible.
Notes
  • This Button is only visible when the pointer is hovering over the Role.
Sourcesrc/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 50