LibrariesList

Last updated 2 months ago

Libraries List Module.

API Overview

API Documentation

Functions

clips

Signature

`cp.apple.finalcutpro.main.LibrariesList:clips(filterFn) -> table

nil` </span>

Type

Function

Description

Gets clips using a custom filter.

Parameters

Returns

clipsUI

Signature

`cp.apple.finalcutpro.main.LibrariesList:clipsUI(filterFn) -> table

nil` </span>

Type

Function

Description

Gets clip UIs using a custom filter.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesList:deselectAll() -> boolean

Type

Function

Description

Deselect all clips.

Parameters

Returns

selectAll

Signature

cp.apple.finalcutpro.main.LibrariesList:selectAll([clips]) -> boolean

Type

Function

Description

Select all clips.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesList:selectClip(clip) -> boolean

Type

Function

Description

Selects a clip.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesList:selectClipAt(index) -> boolean

Type

Function

Description

Select clip at a specific index.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesList:selectClipTitled(title) -> boolean

Type

Function

Description

Select clip with a specific title.

Parameters

Returns

Signature

`cp.apple.finalcutpro.main.LibrariesList:selectedClips() -> table

nil` </span>

Type

Function

Description

Gets selected clips.

Parameters

Returns

Signature

`cp.apple.finalcutpro.main.LibrariesList:selectedClipsUI() -> table

nil` </span>

Type

Function

Description

Gets selected clips UI's.

Parameters

Returns

showClip

Signature

cp.apple.finalcutpro.main.LibrariesList:showClip(clip) -> boolean

Type

Function

Description

Shows a clip.

Parameters

Returns

Constructors

new

Signature

cp.apple.finalcutpro.main.LibrariesList.new(app) -> LibrariesList

Type

Constructor

Description

Creates a new LibrariesList instance.

Parameters

Returns

Methods

app

Signature

cp.apple.finalcutpro.main.LibrariesList:app() -> App

Type

Method

Description

Returns the app instance representing Final Cut Pro.

Parameters

Returns

contents

Signature

cp.apple.finalcutpro.main.LibrariesList:contents() -> Table

Type

Method

Description

Get the Libraries List Contents UI.

Parameters

Returns

parent

Signature

cp.apple.finalcutpro.main.LibrariesList:parent() -> parent

Type

Method

Description

Returns the parent object.

Parameters

Returns

playhead

Signature

cp.apple.finalcutpro.main.LibrariesList:playhead() -> Playhead

Type

Method

Description

Get the Libraries List Playhead.

Parameters

Returns

show

Signature

cp.apple.finalcutpro.main.LibrariesList:show() -> LibrariesList

Type

Method

Description

Show the Libraries List.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesList:skimmingPlayhead() -> Playhead

Type

Method

Description

Get the Libraries List Skimming Playhead.

Parameters

Returns