docs » cp.apple.finalcutpro.plugins


Scans an entire system for Final Cut Pro Effects, Generators, Titles & Transitions.

Usage:

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

API Overview

API Documentation

Constants

appBuiltinPlugins

Signature cp.apple.finalcutpro.plugins.appBuiltinPlugins
Type Constant
Description Table of built-in plugins

appEdelEffects

Signature cp.apple.finalcutpro.plugins.appEdelEffects
Type Constant
Description Table of Built-in Soundtrack Pro EDEL Effects.

audioUnitsCache

Signature cp.apple.finalcutpro.plugins.audioUnitsCache
Type Constant
Description Path to the Audio Units Cache

coreAudioPreferences

Signature cp.apple.finalcutpro.plugins.coreAudioPreferences
Type Constant
Description Core Audio Preferences File Path

types

Signature cp.apple.finalcutpro.plugins.types
Type Constant
Description Table of the different Motion Template Extensions

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.
Notes
  • Does not uninstall any of the actual plugins.

new

Signature cp.apple.finalcutpro.plugins.new(fcp) -> plugins object
Type Function
Description Creates a new Plugins Object.
Parameters
  • fcp - The `cp.apple.finalcutpro` object
Returns
  • The plugins object

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

scanSystemAudioUnits

Signature cp.apple.finalcutpro.plugins:scanSystemAudioUnits() -> none
Type Function
Description Scans for Validated Audio Units, and saves the results to a cache for faster subsequent startup times.
Parameters
  • None
Returns
  • None

scanUserEffectsPresets

Signature cp.apple.finalcutpro.plugins:scanUserEffectsPresets(language) -> none
Type Function
Description Scans Final Cut Pro Effects Presets
Parameters
  • `language` - The language to scan for.
Returns
  • None

Methods

app

Signature cp.apple.finalcutpro.plugins:app() -> plugins
Type Method
Description Returns the cp.apple.finalcutpro object.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro` object.

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.

effectBundleStrings

Signature cp.apple.finalcutpro.plugins:effectBundleStrings() -> table
Type Method
Description Returns all the Effect Bundle Strings.
Parameters
  • None
Returns
  • The effect bundle strings in a table.

effectStrings

Signature cp.apple.finalcutpro.plugins:effectStrings() -> table
Type Method
Description Returns a table of Effects Strings.
Parameters
  • None
Returns
  • A table of effect strings.

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.

init

Signature cp.apple.finalcutpro.plugins:init() -> plugins
Type Method
Description Initialises the module.
Parameters
  • None
Returns
  • The plugins object.

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")
Returns
  • The plugin object.

reset

Signature cp.apple.finalcutpro.plugins:reset() -> none
Type Method
Description Resets all the cached plugins.
Parameters
  • None
Returns
  • None

scanAll

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

scanAppAudioEffectBundles

Signature cp.apple.finalcutpro.plugins:scanAppAudioEffectBundles() -> none
Type Method
Description Scans the Audio Effect Bundles directories.
Parameters
  • directoryPath - Directory to scan
Returns
  • None

scanAppBuiltInPlugins

Signature cp.apple.finalcutpro.plugins:scanAppBuiltInPlugins([language]) -> None
Type Method
Description Scan Built In Plugins.
Parameters
  • `language` - The language code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • None

scanAppEdelEffects

Signature cp.apple.finalcutpro.plugins:scanAppEdelEffects() -> none
Type Method
Description Scans for Soundtrack Pro EDEL Effects.
Parameters
  • None
Returns
  • None

scanAppMotionTemplates

Signature cp.apple.finalcutpro.plugins:scanAppMotionTemplates(language) -> none
Type Method
Description Scans for app-provided Final Cut Pro Plugins.
Parameters
  • `language` - The language to scan for.
Returns
  • None

scanPluginCategoryDirectory

Signature cp.apple.finalcutpro.plugins:scanPluginCategoryDirectory(language, path, plugin) -> boolean
Type Method
Description Scans a folder as a plugin category folder. The contents will be folders that are either theme folders or actual plugins.
Parameters
  • `language` - The language to scan with.
  • `path` - The path to the plugin type directory
  • `plugin` - A table containing the plugin details collected so far.
Returns
  • `true` if the folder was scanned successfully.

scanPluginsDirectory

Signature cp.apple.finalcutpro.plugins:scanPluginsDirectory(language, path, filter) -> boolean
Type Method
Description Scans a root plugins directory. Plugins directories have a standard structure which comes in two flavours:
Parameters
  • `language` - The language code to scan for (e.g. "en" or "fr").
  • `path` - The path of the root plugin directory to scan.
  • `checkFn` - A function which will receive the path being scanned and return `true` if it should be scanned.
Returns
  • `true` if the plugin directory was successfully scanned.

scanPluginThemeDirectory

Signature cp.apple.finalcutpro.plugins:scanPluginThemeDirectory(language, path, plugin) -> boolean
Type Method
Description Scans a folder as a plugin theme folder. The contents will be plugin folders.
Parameters
  • `language` - The language to scan with.
  • `path` - The path to the plugin type directory
  • `plugin` - A table containing the plugin details collected so far.
Returns
  • `true` if the folder was scanned successfully.

scanSystemMotionTemplates

Signature cp.apple.finalcutpro.plugins:scanSystemMotionTemplates(language) -> none
Type Method
Description Scans for system-provided Final Cut Pro Plugins.
Parameters
  • `language` - The language to scan for.
Returns
  • None

scanUserMotionTemplates

Signature cp.apple.finalcutpro.plugins:scanUserMotionTemplates(language) -> none
Type Method
Description Scans for user-provided Final Cut Pro Plugins.
Parameters
  • `language` - The language to scan for.
Returns
  • None

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.

translateEffectBundle

Signature cp.apple.finalcutpro.plugins:translateEffectBundle(input, language) -> none
Type Method
Description Translates an Effect Bundle Item
Parameters
  • input - The original name
  • language - The language code you want to attempt to translate to
Returns
  • The translated value for `input` in the specified language, if present.

unwatch

Signature cp.apple.finalcutpro.plugins:unwatch(id) -> watcher
Type Method
Description Unwatches a watcher with a specific ID.
Parameters
  • id - The ID of the watcher to stop watching.
Returns
  • The watcher object.

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) -> watcher
Type Method
Description Adds a watcher for the provided events table.
Parameters
  • events - A table of events to watch.
Returns
  • The watcher object
Notes
  • The events can be:
  • ** videoEffects
  • ** audioEffects
  • ** transitions
  • ** titles
  • ** generators

results matching ""

    No results matching ""