# cp.apple.finalcutpro.timeline.AudioRole

Extends Role

A Role representing Audio.

# API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • AudioRole

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

  • focusedInTimeline
  • subroleLanes
  • subrolesExpanded

Methods - API calls which can only be made on an object returned by a constructor

  • doFocusInTimeline
  • doHideSubroleLanes
  • doShowSubroleLanes
  • doUnfocusInTimeline

# API Documentation

# Functions

# matches

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

# Constructors

# AudioRole

Signature cp.apple.finalcutpro.timeline.AudioRole(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/AudioRole.lua line 35

# Fields

# focusedInTimeline

Signature cp.apple.finalcutpro.timeline.AudioRole.focusedInTimeline <cp.ui.CheckBox>
Type Field
Description A CheckBox that toggles this role is larger than the other audio roles on the timeline.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 49

# subroleLanes

Signature cp.apple.finalcutpro.timeline.AudioRole.subroleLanes <cp.ui.CheckButton>
Type Field
Description A CheckButton that toggles whether the subroles are visible in the Timeline.
Notes None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 70

# subrolesExpanded

Signature cp.apple.finalcutpro.timeline.AudioRole.subrolesExpanded <cp.ui.CheckButton>
Type Field
Description A CheckButton that toggles whether the roles are visible in the Index.
Notes
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 58

# Methods

# doFocusInTimeline

Signature cp.apple.finalcutpro.timeline.AudioRole:doFocusInTimeline() -> cp.rx.go.Statement
Type Method
Description A Statement that will attempt to focus on this audio role in the timeline.
Parameters
  • None
Returns
  • A Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 79

# doHideSubroleLanes

Signature cp.apple.finalcutpro.timeline.AudioRole:doHideSubroleLanes() -> cp.rx.go.Statement
Type Method
Description A Statement that will attempt to hide the subrole lanes on this audio role in the timeline.
Parameters
  • None
Returns
  • A Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 118

# doShowSubroleLanes

Signature cp.apple.finalcutpro.timeline.AudioRole:doShowSubroleLanes() -> cp.rx.go.Statement
Type Method
Description A Statement that will attempt to show the subrole lanes on this audio role in the timeline.
Parameters
  • None
Returns
  • A Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 105

# doUnfocusInTimeline

Signature cp.apple.finalcutpro.timeline.AudioRole:doUnfocusInTimeline() -> cp.rx.go.Statement
Type Method
Description A Statement that will attempt to unfocus on this audio role in the timeline.
Parameters
  • None
Returns
  • A Statement
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/AudioRole.lua line 92

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.