Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (38 loc) · 3.4 KB

cp.apple.finalcutpro.timeline.CaptionsRole.md

File metadata and controls

50 lines (38 loc) · 3.4 KB
Raw

docs » cp.apple.finalcutpro.timeline.CaptionsRole

Extends Role

A Role representing Captions.

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • CaptionsRole
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • subrolesExpanded
  • visibleInViewer

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.timeline.CaptionsRole.matches(element) -> boolean
Type Function
Description Checks if the element is a "Captions" Role.

Constructors

CaptionsRole

Signature cp.apple.finalcutpro.timeline.CaptionsRole(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.

Fields

subrolesExpanded

Signature cp.apple.finalcutpro.timeline.CaptionsRole.subrolesExpanded <cp.ui.Button>
Type Field
Description A Button that toggles whether the sub-captions are visible.

visibleInViewer

Signature cp.apple.finalcutpro.timeline.CaptionsRole.visibleInViewer <cp.ui.CheckBox>
Type Field
Description A CheckBox that toggles whether captions are visible in the Viewer.