Class: PluginInfoMacOS

PluginInfoMacOS(config)

Discovers installed macOS audio plug-ins (VST2, VST3, and Audio Units). Must be instantiated on macOS (darwin); throws otherwise.

Constructor

new PluginInfoMacOS(config)

Parameters:
Name Type Description
config PluginInfoMacOSConfig

Plug-in search configuration.

Source:
Throws:

When not running on macOS.

Type
Error

Classes

PluginInfoMacOS

Members

map :Object

Returns a snapshot of all discovered plug-in file paths, grouped by format.

Type:
  • Object
Source:

Methods

(async) getAudioUnitPlugins(cacheopt) → {Promise.<Array.<string>>}

Returns the list of discovered Audio Unit plug-in file paths.

Parameters:
Name Type Attributes Default Description
cache boolean <optional>
true

When true, returns the cached result if available.

Source:
Returns:

Absolute paths to .component bundles.

Type
Promise.<Array.<string>>

(async) getVst2Plugins(cacheopt) → {Promise.<Array.<string>>}

Returns the list of discovered VST2 plug-in file paths.

Parameters:
Name Type Attributes Default Description
cache boolean <optional>
true

When true, returns the cached result if available.

Source:
Returns:

Absolute paths to .vst bundles.

Type
Promise.<Array.<string>>

(async) getVst3Plugins(cacheopt) → {Promise.<Array.<string>>}

Returns the list of discovered VST3 plug-in file paths.

Parameters:
Name Type Attributes Default Description
cache boolean <optional>
true

When true, returns the cached result if available.

Source:
Returns:

Absolute paths to .vst3 bundles.

Type
Promise.<Array.<string>>

(async) refresh() → {Promise.<void>}

Re-scans all plug-in directories, bypassing the in-memory cache.

Source:
Returns:
Type
Promise.<void>