docs » cp.apple.finalcutpro.plugins


Scan Final Cut Pro bundle for Effects, Generators, Titles & Transitions.

Usage: require("cp.apple.finalcutpro"):plugins():scan()

API Overview

API Documentation

Functions

clearCaches

Signature cp.apple.finalcutpro.plugins.clearCaches() -> boolean
Type Function
Description Clears any local caches created for tracking the plugins.
Parameters
  • * None
Returns
  • * `true` if the caches have been cleared successfully.

scan

Signature cp.apple.finalcutpro.plugins:scan() -> none
Type Function
Description Scans Final Cut Pro for Effects, Transitions, Generators & Titles
Parameters
  • fcp - the `cp.apple.finalcutpro` instance
Returns
  • None

Methods

audioEffects

Signature cp.apple.finalcutpro.plugins:audioEffects([language]) -> table
Type Method
Description Finds the 'audio effect' plugins.
Parameters
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins.

generators

Signature cp.apple.finalcutpro.plugins:generators([language]) -> table
Type Method
Description Finds the 'generator' plugins.
Parameters
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins.

ofType

Signature cp.apple.finalcutpro.plugins:ofType(type[, language]) -> table
Type Method
Description Finds the plugins of the specified type (types.videoEffect, etc.) and if provided, language.
Parameters
  • * `type` - The plugin type. See `types` for the complete list.
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins of the specified type.

registerPlugin

Signature cp.apple.finalcutpro.plugins:registerPlugin(path, type, categoryName, themeName, pluginName, language) -> plugin
Type Method
Description Registers a plugin with the specified details.
Parameters
  • `path` - The path to the plugin directory.
  • `type` - The type of plugin
  • `categoryName` - The category name, in the specified language.
  • `themeName` - The theme name, in the specified language. May be `nil` if not in a theme.
  • `pluginName` - The plugin name, in the specified language.
  • `language` - The language code (e.g. "en", "fr", "de")

scanAll

Signature cp.apple.finalcutpro.plugins:scanAll() -> nil
Type Method
Description Scans all supported languages, loading them into memory.
Parameters
  • * None
Returns
  • * Nothing

titles

Signature cp.apple.finalcutpro.plugins:titles([language]) -> table
Type Method
Description Finds the 'title' plugins.
Parameters
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins.

transitions

Signature cp.apple.finalcutpro.plugins:transitions([language]) -> table
Type Method
Description Finds the 'transitions' plugins.
Parameters
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins.

videoEffects

Signature cp.apple.finalcutpro.plugins:videoEffects([language]) -> table
Type Method
Description Finds the 'video effect' plugins.
Parameters
  • * `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • * A table of the available plugins.

watch

Signature cp.apple.finalcutpro.plugins:watch(events) -> id
Type Method
Description Adds a watcher for the provided events table. The table can have the following functions:

results matching ""

    No results matching ""