#cp.apple.finalcutpro.main.LibrariesFilmstrip

Libraries Filmstrip 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


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 191


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 167


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 407


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 347


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 387


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip.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/LibrariesFilmstrip.lua line 307


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 330


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 368


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 234


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 211


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip: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/LibrariesFilmstrip.lua line 247


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip:showClipAt(index) -> boolean`
Type	Function
Description	Shows a clip at a specific index.
Parameters	index - The index of the clip you want to show.
Returns	`true` if successful otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesFilmstrip.lua line 290


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip.sortClips(a,b) -> boolean`
Type	Function
Description	Determines if clip A is above clip B or not.
Parameters	a - Clip A b - Clip B
Returns	`true` if clip A is above clip B, otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesFilmstrip.lua line 115


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


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


Signature	`cp.apple.finalcutpro.main.LibrariesFilmstrip.skimmingPlayhead <Playhead>`
Type	Field
Description	The Libraries Filmstrip Skimming Playhead.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/LibrariesFilmstrip.lua line 102


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