Module Duplex.Applications.Effect
The Effect application enables control of DSP chain parameters.
View the README.md (github)
Functions
| __init (VarArg) | Constructor method |
| set_parameter (control_index, value, skip_event) | parameter value changed from Renoise |
| update () | update: set all controls to current values from renoise |
| _build_app () | inherited from Application |
| _set_selected_device_index (idx) | set device index, will only succeed when device exist |
| _get_selected_device () | return the currently selected device (can be nil) |
| _update_prev_next_device_buttons (device_idx) | update display for prev/next device-navigation buttons |
| _update_prev_next_preset_buttons (device_idx) | update display for prev/next device-preset buttons |
| start_app () | inherited from Application |
| _get_parameter_by_index (idx) | get specific effect parameter from current parameter-set |
| _get_next_device_index (idx) | obtain next device index (supports parameter subsets) |
| _get_previous_device_index (idx) | obtain previous device index (supports parameter subsets) |
| _get_device_index_by_ctrl (idx) | obtain actual device index by specifying the control index (useful when dealing with parameter subsets) |
| _get_ctrl_index_by_device (idx) | obtain control index by specifying the actual device index (useful when dealing with parameter subsets) |
| on_new_document () | inherited from Application |
| _modify_ceiling (obj, prm) | in grid mode, when encountering a quantized parameter that has a larger range than the number of buttons we lower the ceiling for the slider, so only the 'settable' range is displayed (called when modifying and attaching parameter) |
| _get_quant_max (prm) | in non-grid mode, if the parameters is quantized and has a range of 255, we provide the 7-bit value as maximum - otherwise, we'd only be able to access every second value |
| _normalized_value_to_parameter_value (parameter, value) | convert a [0-1] value to the given parameter value-range |
| _parameter_value_to_normalized_value (parameter, value) | convert a parameter value to a [0-1] value |
| on_idle () | inherited from Application |
| _define_parameters () | update the current parameter set (updates Effect.numdevices) |
| _get_num_devices () | update the number of devices in the current parameter set (updates Effect.numdevices) |
| update_param_page () | update display of the parameter navigation buttons |
| _attach_to_song () | adds notifiers to song invoked when a new document becomes available |
| _attach_to_track_devices (track, new_song) | attach notifier methods to devices & parameters... |
| _attach_to_parameters (new_song) | detect when a parameter set has changed |
| _remove_notifiers (new_song, observables) | detach all previously attached notifiers first but don't even try to detach when a new song arrived. |
Tables
| self._param_names | (table) references to various UI controls |
Fields
| self._slider_group_size | (int) the number of controls assigned as sliders |
| self._slider_max_size | (int or nil) the maximum size of a slider |
| self._slider_grid_mode | (bool) true if sliders are in grid mode |
| self._parameter_set |
(table) indexed table, each entry contains: |
| self._num_devices | (int) how many devices are included in our parameter set? |
| self._parameter_offset | (int) offset of the whole parameter mapping, controlled by the page navigator |
| self._parameter_observables | list of parameters we are currently listening to |
Functions
- __init (VarArg)
-
Constructor method
Parameters:
- VarArg )
See also:
- set_parameter (control_index, value, skip_event)
-
parameter value changed from Renoise
Parameters:
- control_index (int)
- value (number) mostly between 0 and 1
- skip_event (bool) do not trigger event
- update ()
- update: set all controls to current values from renoise
- _build_app ()
-
inherited from Application
Returns:
-
bool
See also:
- _set_selected_device_index (idx)
-
set device index, will only succeed when device exist
Parameters:
- idx (int)
- _get_selected_device ()
-
return the currently selected device (can be nil)
Returns:
-
renoise.AudioDevice
- _update_prev_next_device_buttons (device_idx)
-
update display for prev/next device-navigation buttons
Parameters:
- device_idx (int)
- _update_prev_next_preset_buttons (device_idx)
-
update display for prev/next device-preset buttons
Parameters:
- device_idx (int)
- start_app ()
-
inherited from Application
Returns:
-
bool or nil
See also:
- _get_parameter_by_index (idx)
-
get specific effect parameter from current parameter-set
Parameters:
- idx (int)
Returns:
-
renoise.DeviceParameter
- _get_next_device_index (idx)
-
obtain next device index (supports parameter subsets)
Parameters:
- idx (int)
Returns:
-
int
- _get_previous_device_index (idx)
-
obtain previous device index (supports parameter subsets)
Parameters:
- idx (int)
Returns:
-
int
- _get_device_index_by_ctrl (idx)
-
obtain actual device index by specifying the control index
(useful when dealing with parameter subsets)
Parameters:
- idx (int)
Returns:
-
int
- _get_ctrl_index_by_device (idx)
-
obtain control index by specifying the actual device index
(useful when dealing with parameter subsets)
Parameters:
- idx (int)
Returns:
-
int
- on_new_document ()
-
inherited from Application
See also:
- _modify_ceiling (obj, prm)
-
in grid mode, when encountering a quantized parameter that
has a larger range than the number of buttons we lower the ceiling
for the slider, so only the 'settable' range is displayed
(called when modifying and attaching parameter)
Parameters:
- obj (Duplex.UISlider)
- prm (renoise.DeviceParameter)
- _get_quant_max (prm)
-
in non-grid mode, if the parameters is quantized and has a range of 255,
we provide the 7-bit value as maximum - otherwise, we'd only be able to
access every second value
Parameters:
- prm (renoise.DeviceParameter)
- _normalized_value_to_parameter_value (parameter, value)
-
convert a [0-1] value to the given parameter value-range
Parameters:
- parameter (renoise.DeviceParameter)
- value (number)
- _parameter_value_to_normalized_value (parameter, value)
-
convert a parameter value to a [0-1] value
Parameters:
- parameter (renoise.DeviceParameter)
- value (number)
- on_idle ()
-
inherited from Application
See also:
- _define_parameters ()
- update the current parameter set (updates Effect.numdevices)
- _get_num_devices ()
- update the number of devices in the current parameter set (updates Effect.numdevices)
- update_param_page ()
- update display of the parameter navigation buttons
- _attach_to_song ()
- adds notifiers to song invoked when a new document becomes available
- _attach_to_track_devices (track, new_song)
-
attach notifier methods to devices & parameters...
Parameters:
- track (renoise.Track)
- new_song (bool)
- _attach_to_parameters (new_song)
-
detect when a parameter set has changed
Parameters:
- new_song (bool) true to leave existing notifiers alone
- _remove_notifiers (new_song, observables)
-
detach all previously attached notifiers first
but don't even try to detach when a new song arrived. old observables
will no longer be alive then...
Parameters:
- new_song (bool), true to leave existing notifiers alone
- observables (table), list of observables
Tables
Fields
- self._slider_group_size
- (int) the number of controls assigned as sliders
- self._slider_max_size
- (int or nil) the maximum size of a slider
- self._slider_grid_mode
- (bool) true if sliders are in grid mode
- self._parameter_set
-
(table) indexed table, each entry contains:
device_index (int) ref (renoise.DeviceParameter) - self._num_devices
- (int) how many devices are included in our parameter set?
- self._parameter_offset
- (int) offset of the whole parameter mapping, controlled by the page navigator
- self._parameter_observables
- list of parameters we are currently listening to