Internationalisation
Bundled Plugins API
plugins
Scans an entire system for Final Cut Pro Effects, Generators, Titles & Transitions.
Usage:
1
require("cp.apple.finalcutpro"):plugins():scan()
Copied!

Submodules

API Overview

API Documentation

Constants

types

Signature
cp.apple.finalcutpro.plugins.types -> table
Type
Constant
Description
Table of the different audio/video/transition/generator types.

Functions

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
Signature
cp.apple.finalcutpro.plugins:scanAppEffectsPresets(locale) -> none
Type
Function
Description
Scans Final Cut Pro Built-in Effects Presets
Parameters
  • locale - The locale to scan for.
Returns
  • None

scanned

Signature
cp.apple.finalcutpro.plugins.scanned() -> boolean
Type
Function
Description
Gets if the system has been scanned.
Parameters
  • None
Returns
  • true is scanned otherwise false.
Signature
cp.apple.finalcutpro.plugins:scanSystemAudioUnits(locale) -> none
Type
Function
Description
Scans for Validated Audio Units, and saves the results to a cache for faster subsequent startup times.
Parameters
  • locale - the locale to scan in.
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanUserColorPresets(locale) -> none
Type
Function
Description
Scans Final Cut Pro User Color Presets
Parameters
  • locale - The locale to scan for.
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanUserEffectsPresets(locale) -> none
Type
Function
Description
Scans Final Cut Pro Effects Presets
Parameters
  • locale - The locale 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.
Signature
cp.apple.finalcutpro.plugins:audioEffects([locale]) -> table
Type
Method
Description
Finds the 'audio effect' plugins.
Parameters
  • locale - The locale code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • A table of the available plugins.
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.
Signature
cp.apple.finalcutpro.plugins:effectStrings() -> table
Type
Method
Description
Returns a table of Effects Strings.
Parameters
  • None
Returns
  • A table of effect strings.
Signature
cp.apple.finalcutpro.plugins:generators([locale]) -> table
Type
Method
Description
Finds the 'generator' plugins.
Parameters
  • locale - The locale 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[, locale]) -> table
Type
Method
Description
Finds the plugins of the specified type (types.videoEffect, etc.) and if provided, locale.
Parameters
  • type - The plugin type. See types for the complete list.
  • locale - The locale code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • A table of the available plugins of the specified type.
Signature
cp.apple.finalcutpro.plugins:registerPlugin(path, type, categoryName, themeName, pluginName, locale) -> 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 locale.
  • themeName - The theme name, in the specified locale. May be nil if not in a theme.
  • pluginName - The plugin name, in the specified locale.
  • locale - The cp.i18n.localeID or string code for same (e.g. "en", "fr", "de")
Returns
  • The plugin object.
Notes
  • locale defaults to the current Final Cut Pro locale if nothing is supplied.

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 locales, loading them into memory.
Parameters
  • None
Returns
  • Nothing
Signature
cp.apple.finalcutpro.plugins:scanAppAudioEffectBundles() -> none
Type
Method
Description
Scans the Audio Effect Bundles directories.
Parameters
  • directoryPath - Directory to scan
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanAppBuiltInPlugins([locale]) -> None
Type
Method
Description
Scan Built In Plugins.
Parameters
  • locale - The cp.i18n.localeID code to search for. Defaults to the current FCPX langauge.
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanAppEdelEffects() -> none
Type
Method
Description
Scans for Soundtrack Pro EDEL Effects.
Parameters
  • None
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanAppMotionTemplates(locale) -> none
Type
Method
Description
Scans for app-provided Final Cut Pro Plugins.
Parameters
  • locale - The locale to scan for.
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanPluginCategoryDirectory(locale, 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
  • locale - The locale 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.
Signature
cp.apple.finalcutpro.plugins:scanPluginsDirectory(locale, path, filter) -> boolean
Type
Method
Description
Scans a root plugins directory. Plugins directories have a standard structure which comes in two flavours:
Parameters
  • locale - The locale 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.
Signature
cp.apple.finalcutpro.plugins:scanPluginThemeDirectory(locale, path, plugin) -> boolean
Type
Method
Description
Scans a folder as a plugin theme folder. The contents will be plugin folders.
Parameters
  • locale - The locale 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.
Signature
cp.apple.finalcutpro.plugins:scanSystemMotionTemplates(locale) -> none
Type
Method
Description
Scans for system-provided Final Cut Pro Plugins.
Parameters
  • locale - The locale to scan for.
Returns
  • None
Signature
cp.apple.finalcutpro.plugins:scanUserMotionTemplates(locale) -> none
Type
Method
Description
Scans for user-provided Final Cut Pro Plugins.
Parameters
  • locale - The locale to scan for.
Returns
  • None

titles

Signature
cp.apple.finalcutpro.plugins:titles([locale]) -> table
Type
Method
Description
Finds the 'title' plugins.
Parameters
  • locale - The locale code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • A table of the available plugins.
Signature
cp.apple.finalcutpro.plugins:transitions([locale]) -> table
Type
Method
Description
Finds the 'transitions' plugins.
Parameters
  • locale - The locale code to search for (e.g. "en"). Defaults to the current FCPX langauge.
Returns
  • A table of the available plugins.
Signature
cp.apple.finalcutpro.plugins:translateEffectBundle(input, locale) -> none
Type
Method
Description
Translates an Effect Bundle Item.
Parameters
  • input - The original name
  • locale - The locale code you want to attempt to translate to
Returns
  • The translated value for input in the specified locale, 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.
Signature
cp.apple.finalcutpro.plugins:videoEffects([locale]) -> table
Type
Method
Description
Finds the 'video effect' plugins.
Parameters
  • locale - The locale 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
Last modified 1mo ago