Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

renoise.InstrumentTriggerOptions

Constants

QuantizeMode

{
    QUANTIZE_NONE: integer = 1,
    QUANTIZE_LINE: integer = 2,
    QUANTIZE_BEAT: integer = 3,
    QUANTIZE_BAR: integer = 4,
}

Properties

available_scale_modes : string[]

READ-ONLY List of all available scale modes.

scale_mode : string

one of 'available_scales']

scale_mode_observable : renoise.Document.Observable

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

scale_key : integer

Scale-key to use when transposing (1=C, 2=C#, 3=D, ...)

scale_key_observable : renoise.Document.Observable

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

mts_esp_tuning : boolean

When true, act as MTS ESP client. Disables custom tunings.

mts_esp_tuning_observable : renoise.Document.Observable

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

tuning : number[]

Array of custom pitch values relative to 1/1, used as custom tuning values for instrument sample playback. The root key is assumed to be middle C (48 in Renoise), The scale will be repeated, so only one octave of values should be defined. An octave may contain more or less than 12 notes.

When set mts_esp_tuning is disabled. Set an empty table to disable custom tuning using default 12-TET tuning instead.

Use property tuning_name to give your custom tuning a name.

examples:

-- Andreas Werckmeister's temperament III (the most famous one, 1681)
local well_tempered_tuning = {
  256/243, 1.117403, 32/27, 1.252827, 4/3, 1024/729,
  1.494927, 128/81, 1.670436, 16/9, 1.879241, 2/1
}
instrument.tuning = well_tempered_tuning

tuning_observable : renoise.Document.Observable

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

tuning_name : string

Name, as displayed in the UI for a custom tuning or a tuning loaded from a file.

tuning_name_observable : renoise.Document.Observable

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

quantize : renoise.InstrumentTriggerOptions.QuantizeMode

Trigger quantization mode.

quantize_observable : renoise.Document.Observable

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

monophonic : boolean

Mono/Poly mode.

monophonic_observable : renoise.Document.Observable

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

monophonic_glide : integer

Glide amount when monophonic. 0 == off, 255 = instant

monophonic_glide_observable : renoise.Document.Observable

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


Functions

load_tuning(self, filename : string)

->success : boolean

Load and apply a scala tuning file as custom tuning. Disables mts_esp_tuning. Any errors during the export are shown to the user.