cp.apple.finalcutpro.main.LibrariesBrowser.md

docs » cp.apple.finalcutpro.main.LibrariesBrowser

---

Libraries Browser Module.

API Overview

• Functions - API calls offered directly by the extension
• deselectAll
• indexOfClip
• Constructors - API calls which return an object, typically one that offers API methods
• LibrariesBrowser
• Fields - Variables which can only be accessed from an object returned by a constructor
• clipFiltering
• filmstrip
• isFilmstripView
• isFocused
• isListView
• list
• mainGroupUI
• search
• searchToggle
• toggleViewMode
• Methods - API calls which can only be made on an object returned by a constructor
• clips
• clipsUI
• doFindClips
• doFindClipsTitled
• doHide
• doOpenClipTitled
• doSelectClipTitled
• doShow
• hide
• loadLayout
• openClipTitled
• playhead
• saveLayout
• selectAll
• selectClip
• selectClipAt
• selectClipTitled
• selectedClips
• selectedClipsUI
• selectLibrary
• show
• showClip
• sidebar
• skimmingPlayhead

API Documentation

Functions

deselectAll

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:deselectAll() -> boolean
Type	Function
Description	Deselect all clips.
Parameters	None
Returns	true if successful otherwise false.

indexOfClip

| Signature | cp.apple.finalcutpro.main.LibrariesBrowser: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.

|

Constructors

LibrariesBrowser

Signature	cp.apple.finalcutpro.main.LibrariesBrowser(app) -> LibrariesBrowser
Type	Constructor
Description	Creates a new LibrariesBrowser instance.
Parameters	parent - The parent object.
Returns	A new LibrariesBrowser object.

Fields

clipFiltering

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.clipFiltering <cp.ui.PopUpButton>
Type	Field
Description	The Clip Filtering PopUpButton.

filmstrip

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.filmstrip <LibrariesFilmstrip>
Type	Field
Description	The LibrariesFilmstrip object.

isFilmstripView

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.isFilmstripView <cp.prop: boolean; read-only>
Type	Field
Description	Indicates if the Library Browser is in 'filmstrip view' mode.

isFocused

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.isFocused <cp.prop: boolean; read-only>
Type	Field
Description	Indicates if the Libraries Browser is the current focus.

isListView

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.isListView <cp.prop: boolean; read-only>
Type	Field
Description	Indicates if the Library Browser is in 'list view' mode.

list

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.list <LibrariesList>
Type	Field
Description	The LibrariesList object.

mainGroupUI

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.mainGroupUI <cp.prop: hs._asm.axuielement; read-only>
Type	Field
Description	Returns the main group within the Libraries Browser, or nil if not available..

search

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.search <cp.ui.TextField>
Type	Field
Description	The Search TextField.

searchToggle

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.searchToggle <cp.ui.Button>
Type	Field
Description	The Search Toggle Button.

toggleViewMode

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.toggleViewMode <cp.ui.Button>
Type	Field
Description	The Toggle View Mode Button.

Methods

clips

| Signature | cp.apple.finalcutpro.main.LibrariesBrowser:clips(filterFn) -> table | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | 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.

|

clipsUI

| Signature | cp.apple.finalcutpro.main.LibrariesBrowser:clipsUI(filterFn) -> table | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | 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.

|

doFindClips

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doFindClips(filter) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will send each clip in the Libraries Browser matching the filter as an onNext signal.
Parameters	filter - a function which receives the Clip to check and returns true or false.
Returns	The Statement.

doFindClipsTitled

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doFindClipsTitled(title) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will send each clip in the Libraries Browser with the specified title as an onNext signal.
Parameters	title - The title string to check for.
Returns	The Statement.

doHide

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doHide() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will hide the Libraries Browser.
Parameters	None
Returns	The Statement.

doOpenClipTitled

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doOpenClipTitled(title) -> cp.rx.go.Statement
Type	Method
Description	A Statement that will attempt to open the named clip in the Libraries Browser in the Timeline.
Parameters	title - The title of the clip to open.
Returns	The Statement to execute.

doSelectClipTitled

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doSelectClipTitled(title) -> cp.rx.go.Statement
Type	Method
Description	A Statement which will select the first clip with a matching title.
Parameters	title - The title to select.
Returns	The Statement ready to execute.

doShow

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:doShow() -> cp.rx.go.Statement
Type	Method
Description	A Statement that will show the Libraries Browser.
Parameters	None
Returns	The Statement object.

hide

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:hide() -> LibrariesBrowser
Type	Method
Description	Hide the Libraries Browser.
Parameters	None
Returns	The LibrariesBrowser object.

loadLayout

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:loadLayout(layout) -> none
Type	Method
Description	Loads a Libraries Browser layout.
Parameters	layout - A table containing the Libraries Browser layout settings - created using cp.apple.finalcutpro.main.LibrariesBrowser:saveLayout().
Returns	None

openClipTitled

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:openClipTitled(name) -> boolean
Type	Method
Description	Open a clip with a specific title.
Parameters	name - The name of the clip you want to open.
Returns	true if successful, otherwise false.

playhead

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:playhead() -> Playhead
Type	Method
Description	Gets the Libraries Browser Playhead.
Parameters	None
Returns	A Playhead object.

saveLayout

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:saveLayout() -> table
Type	Method
Description	Saves the current Libraries Browser layout to a table.
Parameters	None
Returns	A table containing the current Libraries Browser Layout.

selectAll

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:selectAll([clips]) -> boolean
Type	Method
Description	Select all clips.
Parameters	clips - A optional table of Clip objects.
Returns	true if successful otherwise false.

selectClip

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:selectClip(clip) -> boolean
Type	Method
Description	Selects a clip.
Parameters	clip - The Clip you want to select.
Returns	true if successful otherwise false.

selectClipAt

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:selectClipAt(index) -> boolean
Type	Method
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.

selectClipTitled

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:selectClipTitled(title) -> boolean
Type	Method
Description	Select clip with a specific title.
Parameters	title - The title of a clip.
Returns	true if successful otherwise false.

selectedClips

| Signature | cp.apple.finalcutpro.main.LibrariesBrowser:selectedClips() -> table | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets selected clips. | | Parameters |

• None

| | Returns |

• A table of Clip objects or nil if no clips are selected.

|

selectedClipsUI

| Signature | cp.apple.finalcutpro.main.LibrariesBrowser:selectedClipsUI() -> table | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets selected clips UI's. | | Parameters |

• None

| | Returns |

• A table of axuielementObject objects or nil if no clips are selected.

|

selectLibrary

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:selectLibrary(...) -> Table
Type	Method
Description	Selects a Library.
Parameters	... - Libraries as string.
Returns	A Table object.

show

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:show() -> LibrariesBrowser
Type	Method
Description	Show the Libraries Browser.
Parameters	None
Returns	The LibrariesBrowser object.

showClip

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:showClip(clip) -> boolean
Type	Method
Description	Shows a clip.
Parameters	clip - The Clip you want to show.
Returns	true if successful otherwise false.

sidebar

Signature	cp.apple.finalcutpro.main.LibrariesBrowser.sidebar <cp.apple.finalcutpro.main.LibrariesSidebar>
Type	Method
Description	The LibrariesSidebar Table

skimmingPlayhead

Signature	cp.apple.finalcutpro.main.LibrariesBrowser:skimmingPlayhead() -> Playhead
Type	Method
Description	Gets the Libraries Browser Skimming Playhead.
Parameters	None
Returns	A Playhead object.