renoise.Instrument

Constants
Properties
Functions

Constants

Layer

{
    LAYER_NOTE_DISABLED: integer = 0,
    LAYER_NOTE_ON: integer = 1,
    LAYER_NOTE_OFF: integer = 2,
}

OverlapMode

{
    OVERLAP_MODE_ALL: integer = 0,
    OVERLAP_MODE_CYCLED: integer = 1,
    OVERLAP_MODE_RANDOM: integer = 2,
}

PhrasePlaybackMode

{
    PHRASES_OFF: integer = 1,
    PHRASES_PLAY_SELECTIVE: integer = 2,
    PHRASES_PLAY_KEYMAP: integer = 3,
}

Tab

{
    TAB_SAMPLES: integer = 1,
    TAB_PLUGIN: integer = 2,
    TAB_EXT_MIDI: integer = 3,
}

MAX_NUMBER_OF_PHRASES : `integer`

NUMBER_OF_MACROS : `integer`

Properties

active_tab : `renoise.Instrument.Tab`

Currently active tab in the instrument GUI (samples, plugin or MIDI).

active_tab_observable : `renoise.Document.Observable`

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

channel_pressure_macro : `renoise.InstrumentMacro`

Access the MIDI channel pressure macro

comments : `string`[]

Instrument's comment list. See renoise.song().comments for more info on how to get notified on changes and how to change it.

comments_assignment_observable : `renoise.Document.Observable`

Notifier which is called as soon as any paragraph in the comments change.

comments_observable : `renoise.Document.Observable`

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

macros : `renoise.InstrumentMacro`[]

READ-ONLY Macro parameters. Array with size Instrument.NUMBER_OF_MACROS.

macros_visible : `boolean`

Macro parameter pane visibility in the GUI.

macros_visible_observable : `renoise.Document.Observable`

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

midi_input_properties : `renoise.InstrumentMidiInputProperties`

READ-ONLY MIDI input properties.

midi_output_properties : `renoise.InstrumentMidiOutputProperties`

READ-ONLY MIDI output properties.

modulation_wheel_macro : `renoise.InstrumentMacro`

Access the MIDI modulation-wheel macro

name : `string`

Instrument's name.

name_observable : `renoise.Document.Observable`

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

phrase_editor_visible : `boolean`

Phrase editor pane visibility in the GUI.

phrase_editor_visible_observable : `renoise.Document.Observable`

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

phrase_mappings : `renoise.InstrumentPhraseMapping`[]

READ-ONLY Phrase mappings.

phrase_mappings_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

phrase_playback_mode : `renoise.Instrument.PhrasePlaybackMode`

Phrase playback.

phrase_playback_mode_observable : `renoise.Document.Observable`

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

phrase_program : `integer`

Phrase playback program: 0 = Off, 1-126 = specific phrase, 127 = keymap.

phrase_program_observable : `renoise.Document.Observable`

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

phrases : `renoise.InstrumentPhrase`[]

READ-ONLY Phrases.

phrases_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

pitchbend_macro : `renoise.InstrumentMacro`

Access the MIDI pitch-bend macro

plugin_properties : `renoise.InstrumentPluginProperties`

READ-ONLY Plugin properties.

sample_device_chains : `renoise.SampleDeviceChain`[]

READ-ONLY Sample device chains.

sample_device_chains_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

sample_mapping_overlap_mode : `renoise.Instrument.OverlapMode`

Sample mapping's overlap trigger mode.

sample_mapping_overlap_mode_observable : `renoise.Document.Observable`

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

sample_mappings : `renoise.SampleMapping`[]

READ-ONLY Sample mappings (key/velocity to sample slot mappings). sample_mappings[LAYER_NOTE_ON/OFF][]. Sample mappings also can be accessed via ---@field samples[].sample_mapping

sample_mappings_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

sample_modulation_sets : `renoise.SampleModulationSet`[]

READ-ONLY Sample modulation sets.

sample_modulation_sets_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

samples : `renoise.Sample`[]

READ-ONLY Samples slots.

samples_observable : `renoise.Document.ObservableList`

Track changes to document lists by attaching listener functions to it. NB: Notifiers will not broadcast changes made to list items, but only changes to the lists layout (items got added, removed, swapped).

show_comments_after_loading : `boolean`

Set this to true to show the comments dialog after loading a song

show_comments_after_loading_observable : `renoise.Document.Observable`

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

transpose : `integer`

Range: (-120 - 120). Global relative pitch in semi tones. Applied to all samples, MIDI and plugins in the instrument.

transpose_observable : `renoise.Document.Observable`

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

trigger_options : `renoise.InstrumentTriggerOptions`

Global trigger options (quantization and scaling options).

volume : `number`

Range: (0 - math.db2lin(6))

volume_observable : `renoise.Document.Observable`

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

Functions

can_insert_phrase_mapping_at(self, index : `integer`)

->boolean

Returns true if a new phrase mapping can be inserted at the given phrase mapping index (see See renoise.song().instruments[].phrase_mappings). Passed phrase must exist and must not have a mapping yet. Phrase note mappings may not overlap and are sorted by note, so there can be max 119 phrases per instrument when each phrase is mapped to a single key only. To make up room for new phrases, access phrases by index, adjust their note_range, then call 'insert_phrase_mapping_at' again.

clear(self)

Reset, clear all settings and all samples.

copy_from(self, instrument : `renoise.Instrument`)

Copy all settings from the other instrument, including all samples.

delete_phrase_at(self, index : `integer`)

Delete a new phrase at the given phrase index.

delete_phrase_mapping_at(self, index : `integer`)

Delete a new phrase mapping at the given phrase mapping index.

delete_sample_at(self, index : `integer`)

Delete an existing sample.

delete_sample_device_chain_at(self, index : `integer`)

Delete an existing sample device chain at the given index.

delete_sample_modulation_set_at(self, index : `integer`)

Delete an existing modulation set at the given index.

insert_phrase_at(self, index : `integer`)

->new_phrase : renoise.InstrumentPhrase

Insert a new phrase behind the given phrase index (1 for the first one).

insert_phrase_mapping_at(self, index : `integer`, phrase : `renoise.InstrumentPhrase`)

->new_mapping : renoise.InstrumentPhraseMapping

Insert a new phrase mapping behind the given phrase mapping index. The new phrase mapping will by default use the entire free (note) range between the previous and next phrase (if any). To adjust the note range of the new phrase change its 'new_phrase_mapping.note_range' property.

insert_sample_at(self, index : `integer`)

->new_sample : renoise.Sample

Insert a new empty sample. returns the new renoise.Sample object. Every newly inserted sample has a default mapping, which covers the entire key and velocity range, or it gets added as drum kit mapping when the instrument used a drum-kit mapping before the sample got added.