Global

Members

(constant) LIVE_APP_BUNDLES

Map of internal keys to Ableton Live .app bundle names. @type {Object.<string, string>}

Source:

(constant) LIVE_PREFS_PATHS

Known Ableton preferences directory paths on macOS. @type {Object.<string, string>}

Source:

Methods

isRunningInWsl() → {boolean}

Detects whether the current process is running inside Windows Subsystem for Linux (WSL).

Source:
Returns:

true when running under WSL, false otherwise.

Type
boolean

runPowerShellCommand(command) → {string}

Executes a PowerShell command synchronously and returns its trimmed output.

Parameters:
Name Type Description
command string

The PowerShell command string to execute.
Source:
Throws:

When PowerShell exits with a non-zero status.

Type
Error
Returns:

The stdout output, trimmed of surrounding whitespace.

Type
string

Type Definitions

AuPluginConfig

Type:
  • Object
Properties:
Name Type Description
isEnabled boolean

Whether Audio Units are enabled in Ableton Live.
Source:

LiveVersion

Type:
  • Object
Properties:
Name Type Description
version string

The version string (e.g. "12.0.5").
build string | null

The build identifier, or null if not present.
Source:

PluginConfig

Type:
  • Object
Properties:
Name Type Description
vst3 VstPluginConfig

VST3 plug-in configuration.
vst2 VstPluginConfig

VST2 plug-in configuration.
au AuPluginConfig

Audio Unit configuration.
Source:

PluginInfoMacOSConfig

Type:
  • Object
Properties:
Name Type Attributes Default Description
default string <optional>
 '/Library/Audio/Plug-Ins/'

Base directory for system plug-ins.
vst2 Object <optional>

VST2 configuration.

Properties
Name Type Attributes Description
isEnabled boolean <optional>

Whether VST2 scanning is enabled.
isCustomPathEnabled boolean <optional>

Whether the VST2 custom path is active.
customPath string | null <optional>

Custom VST2 search path.
vst3 Object <optional>

VST3 configuration.

Properties
Name Type Attributes Description
isEnabled boolean <optional>

Whether VST3 scanning is enabled.
isCustomPathEnabled boolean <optional>

Whether the VST3 custom path is active.
customPath string | null <optional>

Custom VST3 search path.
au.enabled boolean <optional>
 false

Whether Audio Units are enabled.
Source:

PluginInfoWin64Config

Type:
  • Object
Properties:
Name Type Attributes Description
vst2 Object <optional>

VST2 configuration overrides.

Properties
Name Type Attributes Description
enabled boolean <optional>

Whether VST2 scanning is enabled.
systemPaths Array.<string> <optional>

Default system search paths for VST2 plug-ins.
customEnabled boolean <optional>

Whether the VST2 custom path is active.
customPath string | null <optional>

Custom VST2 search path.
vst3 Object <optional>

VST3 configuration overrides.

Properties
Name Type Attributes Description
enabled boolean <optional>

Whether VST3 scanning is enabled.
systemPaths Array.<string> <optional>

Default system search paths for VST3 plug-ins.
customEnabled boolean <optional>

Whether the VST3 custom path is active.
customPath string | null <optional>

Custom VST3 search path.
Source:

VstPluginConfig

Type:
  • Object
Properties:
Name Type Description
isEnabled boolean

Whether the plug-in format is enabled in Ableton Live.
customPath string | null

The user-configured custom search path, or null.
isCustomPathEnabled boolean | null

Whether the custom path is active, or null when undetermined.
Source:

WindowsVersionInfo

Type:
  • Object
Properties:
Name Type Description
majorVersion number

The Windows major version number.
buildNumber number

The OS build number.
productName string

Human-readable product name ("Windows 10" or "Windows 11").
Source: