#cp.apple.finalcutpro.timeline.IndexClips

Extends IndexSection

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

#Submodules

#API Overview

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

#API Documentation

#Constructors

Signaturecp.apple.finalcutpro.timeline.IndexClips(index) -> IndexClips
TypeConstructor
DescriptionCreates the IndexClips instance.
Parameters
  • index - The Index instance.
Returns
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 27

    #Fields

    Signaturecp.apple.finalcutpro.timeline.IndexClips.activate <cp.ui.RadioButton>
    TypeField
    DescriptionThe RadioButton that activates the 'Clips' section.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 34
    Signaturecp.apple.finalcutpro.timeline.IndexClips.all <cp.ui.RadioButton>
    TypeField
    DescriptionThe RadioButton that will show "All" types of media.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 55
    Signaturecp.apple.finalcutpro.timeline.IndexClips.audio <cp.ui.RadioButton>
    TypeField
    DescriptionThe RadioButton for the "Audio" filter.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 158
    Signaturecp.apple.finalcutpro.timeline.IndexClips.list <cp.ui.OldTable>
    TypeField
    DescriptionThe list of clips as a Table.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 41
    Signaturecp.apple.finalcutpro.timeline.IndexClips.titles <cp.ui.RadioButton>
    TypeField
    DescriptionThe RadioButton for the "Titles" filter.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 165
    Signaturecp.apple.finalcutpro.timeline.IndexClips.type <cp.apple.finalcutpro.timeline.IndexClips.Type>
    TypeField
    DescriptionThe IndexClips.Type.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 144
    Signaturecp.apple.finalcutpro.timeline.IndexClips.video <cp.ui.RadioButton>
    TypeField
    DescriptionThe RadioButton for the "Video" filter.
    NotesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 151

    #Methods

    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindAuditions() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for all "Auditions".
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 268
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindClipsContaining(text) -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for clips containing the specified text.
    Parameters
    • text - The text to search for.
    Returns
    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.
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 232
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindCompoundClips() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for all "Compound Clips".
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 294
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindMissingMedia() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for all "Missing Media".
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 255
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindMulticams() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for all "Multicam" clips.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 281
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doFindSynchronized() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will use the index to search for all "Synchronized" Clips.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 307
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doLayout(layout) -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns 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
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 339
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doShowAll() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will set the clip index to "All" media types.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 172
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doShowAudio() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will set the clip index to "Audio" media types.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 202
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doShowTitles() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will set the clip index to "Titles" media types.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 217
    Signaturecp.apple.finalcutpro.timeline.IndexClips:doShowVideo() -> cp.rx.go.Statement
    TypeMethod
    DescriptionReturns a Statement that will set the clip index to "Video" media types.
    Parameters
    • None
    Returns
    • A Statement
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 187
    Signaturecp.apple.finalcutpro.timeline.IndexClips:saveLayout() -> table
    TypeMethod
    DescriptionReturns a table containing the layout configuration for this class.
    Parameters
    • None
    Returns
    • The layout configuration table.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 320

    © Copyright 2025 LateNite Films Pty Ltd. All rights reserved.