generators

Last updated last month

Controls Final Cut Pro's Generators.

API Overview

  • Constants - Useful values which cannot be changed

  • Functions - API calls offered directly by the extension

API Documentation

Constants

FILE_NAME

Signature

plugins.finalcutpro.timeline.generators.FILE_NAME -> string

Type

Constant

Description

File name of settings file.

Signature

plugins.finalcutpro.timeline.generators.FOLDER_NAME -> string

Type

Constant

Description

Folder Name where settings file is contained.

Functions

apply

Signature

plugins.finalcutpro.timeline.generators.apply(action) -> boolean

Type

Function

Description

Applies the specified action as a generator. Expects action to be a table with the following structure:

Parameters

action - A table with the name/category/theme for the generator to apply, or a string with just the name.

Returns

true if a matching generator was found and applied to the timeline.