# cp.apple.finalcutpro.timeline.VideoRole

Extends Role

A Role representing Video clips.


# API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • VideoRole

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

  • subrolesExpanded

# API Documentation

# Functions

# matches

Signature cp.apple.finalcutpro.timeline.VideoRole.matches(element) -> boolean
Type Function
Description Checks if the element is a "Video" Role.
Parameters
  • element - An element to check
Returns
  • A boolean
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 21

# Constructors

# VideoRole

Signature cp.apple.finalcutpro.timeline.VideoRole(parent, uiFinder)
Type Constructor
Description Creates 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.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 36

# Fields

# subrolesExpanded

Signature cp.apple.finalcutpro.timeline.VideoRole.subrolesExpanded <cp.ui.Button>
Type Field
Description A Button that toggles whether the sub-captions are visible.
Notes
  • This Button is only visible when the pointer is hovering over the Role.
Source src/extensions/cp/apple/finalcutpro/timeline/VideoRole.lua line 50