#cp.apple.finalcutpro.content.Clip

Represents a clip of media inside FCP.


#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Constants

Signaturecp.apple.finalcutpro.content.Clip.type.filmstrip
TypeConstant
DescriptionA constant for clips which are represented by a filmstrip.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 18

Signaturecp.apple.finalcutpro.content.Clip.type.row
TypeConstant
DescriptionA constant for clips which are represented by a table row.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 23

#Functions

Signaturecp.apple.finalcutpro.content.Clip.is(thing) -> boolean
TypeFunction
DescriptionChecks if the specified thing is a Clip instance.
Parameters
  • thing - The thing to check.
Returns
  • true if the thing is a Clip, otherwise returns false.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 125

#Constructors

Signaturecp.apple.finalcutpro.content.Clip.new(element[, options]) -> Clip
TypeConstructor
DescriptionCreates a new Clip pointing at the specified element, with the specified options.
Parameters
  • element - The axuielement the clip represents.
  • options - A table containing the options for the clip.
Returns
  • The new Clip.
Notes
  • The options may be:
  • ** columnIndex - A number which will be used to specify the column number to find the title in, if relevant.
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 102

#Methods

Signaturecp.apple.finalcutpro.content.Clip:getTitle() -> String
TypeMethod
DescriptionReturns the title of the clip.
Parameters
  • None
Returns
  • The clip title.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 54

Signaturecp.apple.finalcutpro.content.Clip:getType() -> Clip.type
TypeMethod
DescriptionReturns the type of clip (one of the Clip.type values)
Parameters
  • None
Returns
  • The Clip.type value (e.g. Clip.type.row or Clip.type.filmstrip`)
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 41

Signaturecp.apple.finalcutpro.content.Clip:setTitle(title) -> none
TypeMethod
DescriptionSets the title of a clip.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 73

Signaturecp.apple.finalcutpro.content.Clip:UI() -> axuielement
TypeMethod
DescriptionReturns the axuielement for the clip.
Parameters
  • None
Returns
  • The axuielement for the clip.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/content/Clip.lua line 28