# cp.apple.finalcutpro.main.LibrariesList

Libraries List Module.

# API Overview

Functions - API calls offered directly by the extension

clips
clipsUI
deselectAll
indexOfClip
selectAll
selectClip
selectClipAt
selectClipTitled
selectedClips
selectedClipsUI
showClip

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

LibrariesList

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

contents
isFocused
isShowing
playerUI
playhead
skimmingPlayhead

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

columns
show

# API Documentation

# Functions

# clips


Signature	`cp.apple.finalcutpro.main.LibrariesList:clips(filterFn) -> table \| nil`
Type	Function
Description	Gets 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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 229

# clipsUI


Signature	`cp.apple.finalcutpro.main.LibrariesList:clipsUI(filterFn) -> table \| nil`
Type	Function
Description	Gets 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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 169

# deselectAll


Signature	`cp.apple.finalcutpro.main.LibrariesList:deselectAll() -> boolean`
Type	Function
Description	Deselect all clips.
Parameters	None
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 389

# indexOfClip


Signature	`cp.apple.finalcutpro.main.LibrariesList:indexOfClip(clip) -> number \| nil`
Type	Function
Description	Gets 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.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 331

# selectAll


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectAll([clips]) -> boolean`
Type	Function
Description	Select all clips.
Parameters	clips - A optional table of `Clip` objects.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 371

# selectClip


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectClip(clip) -> boolean`
Type	Function
Description	Selects a clip.
Parameters	clip - The `Clip` you want to select.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 293

# selectClipAt


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectClipAt(index) -> boolean`
Type	Function
Description	Select clip at a specific index.
Parameters	index - A number of where the clip appears in the list.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 313

# selectClipTitled


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectClipTitled(title) -> boolean`
Type	Function
Description	Select clip with a specific title.
Parameters	title - The title of a clip.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 352

# selectedClips


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectedClips() -> table \| nil`
Type	Function
Description	Gets selected clips.
Parameters	None
Returns	A table of `Clip` objects or `nil` if no clips are selected.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 260

# selectedClipsUI


Signature	`cp.apple.finalcutpro.main.LibrariesList:selectedClipsUI() -> table \| nil`
Type	Function
Description	Gets selected clips UI's.
Parameters	None
Returns	A table of `axuielementObject` objects or `nil` if no clips are selected.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 247

# showClip


Signature	`cp.apple.finalcutpro.main.LibrariesList:showClip(clip) -> boolean`
Type	Function
Description	Shows a clip.
Parameters	clip - The `Clip` you want to show.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 273

# Constructors

# LibrariesList


Signature	`cp.apple.finalcutpro.main.LibrariesList(app) -> LibrariesList`
Type	Constructor
Description	Creates a new `LibrariesList` instance.
Parameters	parent - The parent object.
Returns	A new `LibrariesList` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 43

# Fields

# contents


Signature	`cp.apple.finalcutpro.main.LibrariesList.contents <cp.ui.OldTable>`
Type	Field
Description	The Libraries List Contents UI.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 160

# isFocused


Signature	`cp.apple.finalcutpro.main.LibrariesList.isFocused <cp.prop: boolean; read-only>`
Type	Field
Description	Checks if the Libraries List is currently focused within FCPX.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 90

# isShowing


Signature	`cp.apple.finalcutpro.main.LibrariesList.isShowing <cp.prop: boolean; read-only>`
Type	Field
Description	Checks if the Libraries List is showing on screen.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 83

# playerUI


Signature	`cp.apple.finalcutpro.main.LibrariesList.playerUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	The `axuielement` for the player section of the Libraries List UI.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 72

# playhead


Signature	`cp.apple.finalcutpro.main.LibrariesList.playhead <Playhead>`
Type	Field
Description	The Libraries List Playhead.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 140

# skimmingPlayhead


Signature	`cp.apple.finalcutpro.main.LibrariesList.skimmingPlayhead <Playhead>`
Type	Field
Description	the Libraries List Skimming Playhead.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 147

# Methods

# columns


Signature	`cp.apple.finalcutpro.main.LibrariesList:columns() -> Columns`
Type	Method
Description	Gets the List View Columns object.
Parameters	None
Returns	A `Columns` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 100

# show


Signature	`cp.apple.finalcutpro.main.LibrariesList:show() -> LibrariesList`
Type	Method
Description	Show the Libraries List.
Parameters	None
Returns	`LibrariesList` object
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesList.lua line 119