renoise.InstrumentPluginProperties

Properties

available_plugins : string[]

READ-ONLY 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.

available_plugin_infos : PluginInfo[]

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

plugin_loaded : boolean

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

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.

plugin_device_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

alias_instrument_index : integer

0 when no alias instrument is set

alias_instrument_index_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

alias_fx_track_index : integer

READ-ONLY 0 when no alias FX is set

alias_fx_track_index_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

alias_fx_device_index : integer

READ-ONLY 0 when no alias FX is set

alias_fx_device_index_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

midi_output_routing_index : integer

0 when no routing is set

midi_output_routing_index_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

channel : integer

Range: (1 - 16)

channel_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

transpose : integer

Range: (-120 - 120)

transpose_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

volume : number

Range: (0.0 - 4.0) linear gain

volume_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

auto_suspend : boolean

Valid for loaded and unloaded plugins.

auto_suspend_observable : renoise.Document.Observable

Track changes to document properties or general states by attaching listener functions to it.

Local Structs

PluginInfo

Properties

path : string

The plugin's path used by load_plugin()

name : string

The plugin's name

short_name : string

The plugin's name as displayed in shortened lists

favorite_name : string

The plugin's name as displayed in favorites

is_favorite : string

true if the plugin is a favorite

is_bridged : string

true if the plugin is a bridged plugin