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

  • 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.
Returns
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 27

    Fields

    activate

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.activate <cp.ui.RadioButton>
    Type Field
    Description The RadioButton that activates the 'Clips' section.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 34

    all

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.all <cp.ui.RadioButton>
    Type Field
    Description The RadioButton that will show "All" types of media.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 55

    audio

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.audio <cp.ui.RadioButton>
    Type Field
    Description The RadioButton for the "Audio" filter.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 158

    list

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.list <cp.ui.OldTable>
    Type Field
    Description The list of clips as a Table.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 41

    titles

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.titles <cp.ui.RadioButton>
    Type Field
    Description The RadioButton for the "Titles" filter.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 165

    type

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.type <cp.apple.finalcutpro.timeline.IndexClips.Type>
    Type Field
    Description The IndexClips.Type.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 144

    video

       
    Signature cp.apple.finalcutpro.timeline.IndexClips.video <cp.ui.RadioButton>
    Type Field
    Description The RadioButton for the "Video" filter.
    Notes None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 151

    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".
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 268

    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
    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.
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 232

    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".
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 294

    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".
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 255

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 281

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 307

    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
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 339

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 172

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 202

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 217

    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.
    Parameters
    • None
    Returns
    • A Statement
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 187

    saveLayout

       
    Signature cp.apple.finalcutpro.timeline.IndexClips:saveLayout() -> table
    Type Method
    Description Returns a table containing the layout configuration for this class.
    Parameters
    • None
    Returns
    • The layout configuration table.
    Notes None
    Examples None
    Source src/extensions/cp/apple/finalcutpro/timeline/IndexClips.lua line 320

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