renoise.InstrumentPluginProperties InstrumentPluginProperties

Properties
Functions
- load_plugin (self, string) -> boolean
Structs
- PluginInfo
  - Properties
    - path : string
    - name : string
    - short_name : string
    - favorite_name : string
    - is_favorite : string
    - is_bridged : string

Properties

available_plugins : `string[]`

List of all currently available plugins. This is a list of unique plugin names which also contains the plugin’s type (VST/AU/DSSI/…), not including the vendor names as visible in Renoise’s GUI. So its an identifier, and not the name as visible in the GUI. When no plugin is loaded, the identifier is an empty string. READ-ONLY

available_plugin_infos : `PluginInfo[]`

Returns a list of tables containing more information about the plugins. READ-ONLY

plugin_loaded : `boolean`

Returns true when a plugin is present; loaded successfully. READ-ONLY

plugin_device : `renoise.AudioDevice` | `renoise.InstrumentPluginDevice`

Valid object for successfully loaded plugins, otherwise nil. Alias plugin instruments of FX will return the resolved device, will link to the device the alias points to. The observable is fired when the device changes: when a plugin gets loaded or unloaded or a plugin alias is assigned or unassigned. READ-ONLY

plugin_device_observable : `renoise.Document.Observable`

READ-ONLY

alias_instrument_index : `integer`

Valid for loaded and unloaded plugins, 0 when no alias instrument is set. READ-ONLY

alias_instrument_index_observable : `renoise.Document.Observable`

READ-ONLY

alias_fx_track_index : `integer`

0 when no alias FX is set READ-ONLY

alias_fx_track_index_observable : `renoise.Document.Observable`

READ-ONLY

alias_fx_device_index : `integer`

0 when no alias FX is set READ-ONLY

alias_fx_device_index_observable : `renoise.Document.Observable`

READ-ONLY

midi_output_routing_index : `integer`

0 when no routing is set

midi_output_routing_index_observable : `renoise.Document.Observable`

READ-ONLY

channel : `integer`

Valid for loaded and unloaded plugins. Range: (1 - 16)

channel_observable : `renoise.Document.Observable`

READ-ONLY

transpose : `integer`

Range: (-120 - 120)

transpose_observable : `renoise.Document.Observable`

READ-ONLY

volume : `number`

Valid for loaded and unloaded plugins. Range: (0.0 - 4.0) linear gain

volume_observable : `renoise.Document.Observable`

READ-ONLY

auto_suspend : `boolean`

Valid for loaded and unloaded plugins.

auto_suspend_observable : `renoise.Document.Observable`

READ-ONLY

Functions

load_plugin(self, plugin_path : `string`)

->success : boolean

Load an existing, new, non aliased plugin. Pass an empty string to unload an already assigned plugin. plugin_path must be one of the available plugins See: renoise.InstrumentPluginProperties.available_plugins