renoise.DeviceParameter
A single parameter within an audio DSP effect (renoise.AudioDevice)
- Constants
- Properties
- name :
string - name_observable :
renoise.Document.ObservableString - polarity :
renoise.DeviceParameter.Polarity - value_min :
number - value_max :
number - value_quantum :
number - value_default :
number - time_quantum :
number - is_automatable :
boolean - is_automated :
boolean - is_automated_observable :
renoise.Document.Observable - is_midi_mapped :
boolean - is_midi_mapped_observable :
renoise.Document.Observable - show_in_mixer :
boolean - show_in_mixer_observable :
renoise.Document.Observable - value :
number - value_observable :
renoise.Document.Observable - value_string :
string - value_string_observable :
renoise.Document.Observable
- name :
- Functions
Constants
Polarity
{ POLARITY_UNIPOLAR: integer = 1, POLARITY_BIPOLAR: integer = 2, }
Properties
name : string
Device parameters. READ-ONLY
name_observable : renoise.Document.ObservableString
READ-ONLY
polarity : renoise.DeviceParameter.Polarity
READ-ONLY
value_min : number
READ-ONLY
value_max : number
READ-ONLY
value_quantum : number
The step size for the parameter:
- continuous parameters will have
0for this- discrete parameters like integers, enums or booleans will have either
1, or a smaller fraction if the parameter is normalized (for external plugins). For the latter group, this value is the smallest meaningful delta you can apply to change the parameter to a different value. READ-ONLY
value_default : number
READ-ONLY
time_quantum : number
The minimum interval in pattern lines (as a number) at which a parameter can have automation points. It is 1/256 for most parameters, but 1 for e.g. song tempo, LPB and TPL which can only be automated once per pattern line. READ-ONLY
is_automatable : boolean
Not valid for parameters of instrument devices. Returns true if creating envelope automation is possible for the parameter (see also renoise.song().patterns[].tracks[]:create_automation) READ-ONLY
is_automated : boolean
Is automated. Not valid for parameters of instrument devices. READ-ONLY
is_automated_observable : renoise.Document.Observable
READ-ONLY
is_midi_mapped : boolean
Parameter has a custom MIDI mapping in the current song. READ-ONLY
is_midi_mapped_observable : renoise.Document.Observable
READ-ONLY
show_in_mixer : boolean
Show in mixer. Not valid for parameters of instrument devices.
show_in_mixer_observable : renoise.Document.Observable
READ-ONLY
value : number
value in Range: (value_min - value_max)
value_observable : renoise.Document.Observable
READ-ONLY
value_string : string
value_string_observable : renoise.Document.Observable
READ-ONLY
Functions
record_value(self, value : number)
Set a new value and write automation when the MIDI mapping “record to automation” option is set. Only works for parameters of track devices, not for instrument devices.