Class: PluginInfoWin64

PluginInfoWin64(configopt)

Discovers installed 64-bit Windows audio plug-ins (VST2 and VST3). Must be instantiated on Windows or WSL; throws otherwise.

Constructor

new PluginInfoWin64(configopt)

Parameters:
Name Type Attributes Default Description
config PluginInfoWin64Config <optional>
{}

Optional overrides for default search paths and flags.

Source:
Throws:

When not running on Windows or WSL.

Type
Error

Classes

PluginInfoWin64

Members

map :Object

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

Type:
  • Object
Source:

Methods

(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 .dll plug-in files.

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 plug-in files.

Type
Promise.<Array.<string>>

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

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

Source:
Returns:
Type
Promise.<void>