# cp.apple.finalcutpro.timeline.IndexRolesList

Timeline Index Roles List.

# API Overview

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

  • allRoles
  • audioRoles
  • doActivate
  • doDeactivate
  • doFocusInTimeline
  • doHideSubroleLanes
  • doShowSubroleLanes
  • doUnfocusInTimeline
  • filterRoles
  • findRoleTitled
  • videoRoles

# API Documentation

# Methods

# allRoles

Signature cp.apple.finalcutpro.timeline.IndexRolesList:allRoles([includeSubroles]) -> table of Roles
Type Method
Description Returns the list of caption Roles in the current list.
Parameters
  • includeSubroles - if true, include Subroles, otherwise exclude them.
Returns
  • A table of Roles, or nil if no UI is available currently.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 111

# audioRoles

Signature cp.apple.finalcutpro.timeline.IndexRolesList:audioRoles([includeSubroles]) -> table of Roles
Type Method
Description Returns the list of all audio Roles in the current list.
Parameters
  • includeSubroles - if true, include Subroles, otherwise exclude them.
Returns
  • A table of Roles, or nil if no UI is available currently.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 98

# doActivate

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doActivate(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will activate the provided role, if it is available.
Parameters
  • title - The title of the Role to activate.
Returns
Notes
  • The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 144

# doDeactivate

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doDeactivate(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will deactivate the provided role, if it is available.
Parameters
  • title - The title of the Role to deactivate.
Returns
Notes
  • The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 165

# doFocusInTimeline

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doFocusInTimeline(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will focus the provided AudioRole, if it is available.
Parameters
  • title - The title of the Role to activate.
Returns
Notes
  • The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 186

# doHideSubroleLanes

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doHideSubroleLanes(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will hide subrole lanes for the provided AudioRole, if it is available.
Parameters
  • title - The title of the Role.
Returns
Notes
  • The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 249

# doShowSubroleLanes

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doShowSubroleLanes(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will show subrole lanes for the provided AudioRole, if it is available.
Parameters
  • title - The title of the Role.
Returns
Notes
  • The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 228

# doUnfocusInTimeline

Signature cp.apple.finalcutpro.timeline.IndexRolesList:doUnfocusInTimeline(title) -> cp.rx.go.Statement
Type Method
Description Returns a Statement that will unfocus the provided AudioRole, if it is available.
Parameters
  • title - The title of the Role to activate.
Returns
Notes
  • The title can be the English name (eg. "Dialogue", "Music", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 207

# filterRoles

Signature cp.apple.finalcutpro.timeline.IndexRolesList:filterRoles([matcherFn]) -> table of Roles or nil
Type Method
Description Filters the current list of Roles based on the given matchesFn predicate.
Parameters
  • matchesFn - the matcher function. If not provided, no additional filtering occurs.
Returns
  • The table of Role, or nil if no UI is currently available.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 50

# findRoleTitled

Signature cp.apple.finalcutpro.timeline.IndexRolesList:findRoleTitled(title) -> Role or nil
Type Method
Description Returns the Role with the specified title.
Parameters
  • title - The title of the role to find.
Returns
  • The Role, or nil if it can't be found.
Notes
  • The title can be the English name (eg. "Video", "Titles", etc.) for default Roles, and it will find the correct role in the current FCPX language.
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 124

# videoRoles

Signature cp.apple.finalcutpro.timeline.IndexRolesList:videoRoles([includeSubroles]) -> table of Roles
Type Method
Description Returns the list of all video Roles in the current list.
Parameters
  • includeSubroles - if true, include Subroles, otherwise exclude them.
Returns
  • A table of Roles, or nil if no UI is available currently.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/timeline/IndexRolesList.lua line 85

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