#cp.apple.finalcutpro.main.LibrariesList

Libraries List Module.

#API Overview

Functions - API calls offered directly by the extension

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

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

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

#API Documentation

#Functions

Signaturecp.apple.finalcutpro.main.LibrariesList:clips(filterFn) -> table | nil
TypeFunction
DescriptionGets clips using a custom filter.
Parameters
  • filterFn - A function to filter the UI results.
Returns
  • A table of Clip objects or nil if no clip UI could be found.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 229
Signaturecp.apple.finalcutpro.main.LibrariesList:clipsUI(filterFn) -> table | nil
TypeFunction
DescriptionGets clip UIs using a custom filter.
Parameters
  • filterFn - A function to filter the UI results.
Returns
  • A table of axuielementObject objects or nil if no clip UI could be found.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 169
Signaturecp.apple.finalcutpro.main.LibrariesList:deselectAll() -> boolean
TypeFunction
DescriptionDeselect all clips.
Parameters
  • None
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 389
Signaturecp.apple.finalcutpro.main.LibrariesList:indexOfClip(clip) -> number | nil
TypeFunction
DescriptionGets the index of a specific clip.
Parameters
  • clip - The Clip you want to get the index of.
Returns
  • The index or nil if an error occurs.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 331
Signaturecp.apple.finalcutpro.main.LibrariesList:selectAll([clips]) -> boolean
TypeFunction
DescriptionSelect all clips.
Parameters
  • clips - A optional table of Clip objects.
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 371
Signaturecp.apple.finalcutpro.main.LibrariesList:selectClip(clip) -> boolean
TypeFunction
DescriptionSelects a clip.
Parameters
  • clip - The Clip you want to select.
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 293
Signaturecp.apple.finalcutpro.main.LibrariesList:selectClipAt(index) -> boolean
TypeFunction
DescriptionSelect clip at a specific index.
Parameters
  • index - A number of where the clip appears in the list.
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 313
Signaturecp.apple.finalcutpro.main.LibrariesList:selectClipTitled(title) -> boolean
TypeFunction
DescriptionSelect clip with a specific title.
Parameters
  • title - The title of a clip.
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 352
Signaturecp.apple.finalcutpro.main.LibrariesList:selectedClips() -> table | nil
TypeFunction
DescriptionGets selected clips.
Parameters
  • None
Returns
  • A table of Clip objects or nil if no clips are selected.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 260
Signaturecp.apple.finalcutpro.main.LibrariesList:selectedClipsUI() -> table | nil
TypeFunction
DescriptionGets selected clips UI's.
Parameters
  • None
Returns
  • A table of axuielementObject objects or nil if no clips are selected.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 247
Signaturecp.apple.finalcutpro.main.LibrariesList:showClip(clip) -> boolean
TypeFunction
DescriptionShows a clip.
Parameters
  • clip - The Clip you want to show.
Returns
  • true if successful otherwise false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 273

#Constructors

Signaturecp.apple.finalcutpro.main.LibrariesList(app) -> LibrariesList
TypeConstructor
DescriptionCreates a new LibrariesList instance.
Parameters
  • parent - The parent object.
Returns
  • A new LibrariesList object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 43

#Fields

Signaturecp.apple.finalcutpro.main.LibrariesList.contents <cp.ui.OldTable>
TypeField
DescriptionThe Libraries List Contents UI.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 160
Signaturecp.apple.finalcutpro.main.LibrariesList.isFocused <cp.prop: boolean; read-only>
TypeField
DescriptionChecks if the Libraries List is currently focused within FCPX.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 90
Signaturecp.apple.finalcutpro.main.LibrariesList.isShowing <cp.prop: boolean; read-only>
TypeField
DescriptionChecks if the Libraries List is showing on screen.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 83
Signaturecp.apple.finalcutpro.main.LibrariesList.playerUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionThe axuielement for the player section of the Libraries List UI.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 72
Signaturecp.apple.finalcutpro.main.LibrariesList.playhead <Playhead>
TypeField
DescriptionThe Libraries List Playhead.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 140
Signaturecp.apple.finalcutpro.main.LibrariesList.skimmingPlayhead <Playhead>
TypeField
Descriptionthe Libraries List Skimming Playhead.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 147

#Methods

Signaturecp.apple.finalcutpro.main.LibrariesList:columns() -> Columns
TypeMethod
DescriptionGets the List View Columns object.
Parameters
  • None
Returns
  • A Columns object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 100
Signaturecp.apple.finalcutpro.main.LibrariesList:show() -> LibrariesList
TypeMethod
DescriptionShow the Libraries List.
Parameters
  • None
Returns
  • LibrariesList object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 119

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