Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
90 lines (74 loc) · 6.66 KB

cp.apple.finalcutpro.content.Clip.md

File metadata and controls

90 lines (74 loc) · 6.66 KB
Raw

docs » cp.apple.finalcutpro.content.Clip

Represents a clip of media inside FCP.

API Overview

  • Constants - Useful values which cannot be changed
  • filmstrip
  • row
  • Functions - API calls offered directly by the extension
  • is
  • Constructors - API calls which return an object, typically one that offers API methods
  • new
  • Methods - API calls which can only be made on an object returned by a constructor
  • getTitle
  • getType
  • setTitle
  • UI

API Documentation

Constants

filmstrip

Signature cp.apple.finalcutpro.content.Clip.type.filmstrip
Type Constant
Description A constant for clips which are represented by a filmstrip.

row

Signature cp.apple.finalcutpro.content.Clip.type.row
Type Constant
Description A constant for clips which are represented by a table row.

Functions

is

Signature cp.apple.finalcutpro.content.Clip.is(thing) -> boolean
Type Function
Description Checks 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.

Constructors

new

Signature cp.apple.finalcutpro.content.Clip.new(element[, options]) -> Clip
Type Constructor
Description Creates 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.

Methods

getTitle

Signature cp.apple.finalcutpro.content.Clip:getTitle() -> String
Type Method
Description Returns the title of the clip.
Parameters
  • None
Returns
  • The clip title.

getType

Signature cp.apple.finalcutpro.content.Clip:getType() -> Clip.type
Type Method
Description Returns 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`)

setTitle

Signature cp.apple.finalcutpro.content.Clip:setTitle(title) -> none
Type Method
Description Sets the title of a clip.
Parameters
  • None
Returns
  • None

UI

Signature cp.apple.finalcutpro.content.Clip:UI() -> axuielement
Type Method
Description Returns the axuielement for the clip.
Parameters
  • None
Returns
  • The axuielement for the clip.