cp.apple.finalcutpro.timeline.IndexClips.md

docs » cp.apple.finalcutpro.timeline.IndexClips

---

Extends IndexSection

Provides access to the 'Clips' section of the Timeline Index

Submodules

• cp.apple.finalcutpro.timeline.IndexClips.Type

API Overview

• Constructors - API calls which return an object, typically one that offers API methods
• IndexClips
• Fields - Variables which can only be accessed from an object returned by a constructor
• activate
• all
• audio
• list
• titles
• type
• video
• Methods - API calls which can only be made on an object returned by a constructor
• doFindAuditions
• doFindClipsContaining
• doFindCompoundClips
• doFindMissingMedia
• doFindMulticams
• doFindSynchronized
• doLayout
• doShowAll
• doShowAudio
• doShowTitles
• doShowVideo
• saveLayout

API Documentation

Constructors

IndexClips

Signature	cp.apple.finalcutpro.timeline.IndexClips(index) -> IndexClips
Type	Constructor
Description	Creates the IndexClips instance.
Parameters	index - The Index instance.

Fields

activate

Signature	cp.apple.finalcutpro.timeline.IndexClips.activate <cp.ui.RadioButton>
Type	Field
Description	The RadioButton that activates the 'Clips' section.

all

Signature	cp.apple.finalcutpro.timeline.IndexClips.all <cp.ui.RadioButton>
Type	Field
Description	The RadioButton that will show "All" types of media.

audio

Signature	cp.apple.finalcutpro.timeline.IndexClips.audio <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Audio" filter.

list

Signature	cp.apple.finalcutpro.timeline.IndexClips.list <cp.ui.Table>
Type	Field
Description	The list of clips as a Table.

titles

Signature	cp.apple.finalcutpro.timeline.IndexClips.titles <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Titles" filter.

type

Signature	cp.apple.finalcutpro.timeline.IndexClips.type <cp.apple.finalcutpro.timeline.IndexClips.Type>
Type	Field
Description	The IndexClips.Type.

video

Signature	cp.apple.finalcutpro.timeline.IndexClips.video <cp.ui.RadioButton>
Type	Field
Description	The RadioButton for the "Video" filter.

Methods

doFindAuditions

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindAuditions() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for all "Auditions".

doFindClipsContaining

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindClipsContaining(text) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for clips containing the specified text.
Parameters	text - The text to search for.
Returns	The Statement
Notes	Because the text can change each time, this result is not cached automatically. However as long as you are searching for the same text the result can be safely cached. The [#toFindMissingMedia] method does this, for example.

doFindCompoundClips

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindCompoundClips() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for all "Compound Clips".

doFindMissingMedia

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindMissingMedia() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for all "Missing Media".

doFindMulticams

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindMulticams() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for all "Multicam" clips.

doFindSynchronized

Signature	cp.apple.finalcutpro.timeline.IndexClips:doFindSynchronized() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will use the index to search for all "Synchronized" Clips.

doLayout

Signature	cp.apple.finalcutpro.timeline.IndexClips:doLayout(layout) -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will apply the layout provided, if possible.
Parameters	layout - the table containing the layout configuration. Usually created via the [#saveLayout] method.
Returns	The Statement.

doShowAll

Signature	cp.apple.finalcutpro.timeline.IndexClips:doShowAll() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will set the clip index to "All" media types.

doShowAudio

Signature	cp.apple.finalcutpro.timeline.IndexClips:doShowAudio() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will set the clip index to "Audio" media types.

doShowTitles

Signature	cp.apple.finalcutpro.timeline.IndexClips:doShowTitles() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will set the clip index to "Titles" media types.

doShowVideo

Signature	cp.apple.finalcutpro.timeline.IndexClips:doShowVideo() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will set the clip index to "Video" media types.

saveLayout

Signature	cp.apple.finalcutpro.timeline.IndexClips:saveLayout() -> table
Type	Method
Description	Returns a table containing the layout configuration for this class.
Returns	The layout configuration table.