LibrariesBrowser

Last updated 23 days ago

Libraries Browser Module.

API Overview

API Documentation

Constants

ALL_CLIPS

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.ALL_CLIPS -> number

Type

Constant

Description

All Clips ID.

FAVORITES

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.FAVORITES -> number

Type

Constant

Description

Favourites ID.

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.HIDE_REJECTED -> number

Type

Constant

Description

Hide Rejected ID.

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.NO_RATINGS_OR_KEYWORDS -> number

Type

Constant

Description

No Rating or Keywords ID.

REJECTED

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.REJECTED -> number

Type

Constant

Description

Rejected ID.

UNUSED

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.UNUSED -> number

Type

Constant

Description

Unused ID.

Functions

clips

Signature

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

nil` </span>

Type

Function

Description

Gets clips using a custom filter.

Parameters

Returns

clipsUI

Signature

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

nil` </span>

Type

Function

Description

Gets clip UIs using a custom filter.

Parameters

Returns

Signature

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

Type

Function

Description

Deselect all clips.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser.matchesSidebar(element) -> boolean

Type

Function

Description

Checks to see if an element matches the Sidebar type.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:openClipTitled(name) -> boolean

Type

Function

Description

Open a clip with a specific title.

Parameters

Returns

selectAll

Signature

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

Type

Function

Description

Select all clips.

Parameters

Returns

Signature

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

Type

Function

Description

Selects a clip.

Parameters

Returns

Signature

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

Type

Function

Description

Select clip at a specific index.

Parameters

Returns

Signature

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

Type

Function

Description

Select clip with a specific title.

Parameters

Returns

Signature

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

nil` </span>

Type

Function

Description

Gets selected clips.

Parameters

Returns

Signature

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

nil` </span>

Type

Function

Description

Gets selected clips UI's.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:selectLibrary(...) -> Table

Type

Function

Description

Selects a Library.

Parameters

Returns

showClip

Signature

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

Type

Function

Description

Shows a clip.

Parameters

Returns

Constructors

new

Signature

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

Type

Constructor

Description

Creates a new LibrariesBrowser instance.

Parameters

Returns

Methods

app

Signature

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

Type

Method

Description

Returns the app instance representing Final Cut Pro.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:appearanceAndFiltering() -> Button

Type

Method

Description

Get Appearance & Filtering Button.

Parameters

Returns

filmstrip

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:filmstrip() -> LibrariesList

Type

Method

Description

Get Libraries List object.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:filterToggle() -> Button

Type

Method

Description

The Filter Toggle Button.

Parameters

Returns

hide

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:hide() -> LibrariesBrowser

Type

Method

Description

Hide the Libraries Browser.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:loadLayout(layout) -> none

Type

Method

Description

Loads a Libraries Browser layout.

Parameters

Returns

parent

Signature

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

Type

Method

Description

Returns the parent object.

Parameters

Returns

playhead

Signature

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

Type

Method

Description

Gets the Libraries Browser Playhead.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:saveLayout() -> table

Type

Method

Description

Saves the current Libraries Browser layout to a table.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:search() -> TextField

Type

Method

Description

Get Search Text Field.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:searchToggle() -> Button

Type

Method

Description

Get Search Toggle Button.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:selectClipFiltering(filterType) -> LibrariesBrowser

Type

Method

Description

Select Clip Filtering based on Filter Type.

Parameters

Returns

show

Signature

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

Type

Method

Description

Show the Libraries Browser.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:sidebar() -> Table

Type

Method

Description

Get Libraries sidebar object.

Parameters

Returns

Signature

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

Type

Method

Description

Gets the Libraries Browser Skimming Playhead.

Parameters

Returns

Signature

cp.apple.finalcutpro.main.LibrariesBrowser:toggleViewMode() -> Button

Type

Method

Description

Get Toggle View Mode button.

Parameters

Returns