cp.apple.finalcutpro.timeline.CaptionsSubrole.md

docs » cp.apple.finalcutpro.timeline.CaptionsSubrole

---

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
• CaptionsSubrole
• Fields - Variables which can only be accessed from an object returned by a constructor
• format
• visibleInTimeline

API Documentation

Functions

matches

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

Constructors

CaptionsSubrole

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

format

Signature	cp.apple.finalcutpro.timeline.CaptionsSubrole.format <cp.ui.StaticText>
Type	Field
Description	A StaticText which represents the subtitle format (e.g. "ITT", "SRT").

visibleInTimeline

Signature	cp.apple.finalcutpro.timeline.CaptionsSubrole.visibleInTimeline <cp.ui.CheckBox>
Type	Field
Description	A CheckBox that indicates if the subtitle track is visible in the Viewer.