soir
OVERVIEW
VST3 plugin management.
This module provides functions to list and interact with VST3 plugins. Plugins are automatically scanned when the engine starts.
FUNCTION
effects
effects() -> list[dict[str, str]]
Get a list of available VST3 effect plugins.
Returns only plugins with type "effect".
Returns
– List of effect plugin information dictionaries.
instruments
instruments() -> list[dict[str, str]]
Get a list of available VST3 instrument plugins.
Returns only plugins with type "instrument".
Returns
– List of instrument plugin information dictionaries.
plugins
plugins() -> list[dict[str, str]]
Get a list of available VST3 plugins.
Returns a list of dictionaries with plugin information:
- uid: unique identifier for the plugin
- name: display name of the plugin
- vendor: plugin vendor/manufacturer
- category: plugin category (e.g., "Fx|EQ")
- path: path to the plugin bundle
Returns
– List of plugin information dictionaries.
require
require(name: str) -> None
Checks if a VST exists on the system.
Raises
| Exception | Description |
|---|---|
VSTNotFoundException |
raised when the VST does not exist. |