Module Duplex.RoamingDSP
Extend this class for 'roaming' control of a DSP device
Functions
| __init (VarArg) | Constructor method |
| start_app () | |
| initial_select () | Initial select, performed on application start: if not in locked mode: use the currently focused track->device if we are in locked mode: recognize any locked devices, but fall back to the focused track->device if no locked device was found |
| goto_previous_device () | Goto previous device search from locked device (if available), otherwise use the selected device |
| goto_next_device () | Goto next device search from locked device (if available), otherwise use the selected device |
| search_previous_device (track_index, device_index) | Locate the prior device |
| search_next_device (track_index, device_index) | Locate the next device |
| goto_device (track_index, device_index, device, skip_tag) | Attach to a device, transferring the 'tag' if needed this is the final step of a "previous/next device" operation, or called during the initial search |
| update_prev_next (track_index, device_index) | Update the lit state of the previous/next device buttons |
| do_device_search () | Look for a device that match the provided name it is called right after the target device has been removed, or by initial_select() |
| get_unique_name () | Get the unique name of the device, as specified in options |
| device_is_valid (device) | Test if the device is a valid target |
| tag_device (device) | Tag device (add unique identifier), clearing existing one(s) |
| on_idle () | |
| get_selected_device () | Return the currently focused track->device in Renoise |
| attach_to_selected_device () | Attempt to select the current device failing to do so will clear the target device |
| attach_to_device (track_idx, device_idx, device) | Attach notifier to the device called when we use previous/next device, set the initial device or are freely roaming the tracks |
| get_device_param (param_name) | Retrieve a parameter from the target device by name |
| update_automation (track_idx, param, value, playmode) | Update automation |
| _attach_to_track_devices (track) | Keep track of devices (insert,remove,swap...)
invoked by attachtodevice() |
| follow_device_pos () | Select track + device, but only when follow_pos is enabled |
| update_lock_button () | Update the state of the lock button |
| _build_app () | |
| on_new_document () | |
| on_release_document () | |
| clear_device () | De-attach from the device |
| _attach_to_song () | Attach notifiers to the song, handle changes |
| _remove_notifiers (observables) | "brute force" removal of registered notifiers |
Tables
| default_options | Options |
| available_mappings | Mappings |
Fields
| self.target_device | (renoise.AudioDevice) the device we are currently controlling |
| self._blink | (bool) current blink-state (lock button) |
| self.track_index | (int) the target track index |
| self.device_index | (int) the target device index |
| self.current_device_requested | (bool), set when we should attempt to attach to the current device (althought we might not succeed) |
| self._parameter_observables | (table) list of observable parameters |
| self._device_observables | (table) list of observable device parameters |
Functions
- __init (VarArg)
-
Constructor method
Parameters:
- VarArg ), see Application/Automateable to learn more
- start_app ()
-
Returns:
-
bool or nil
See also:
- initial_select ()
- Initial select, performed on application start: if not in locked mode: use the currently focused track->device if we are in locked mode: recognize any locked devices, but fall back to the focused track->device if no locked device was found
- goto_previous_device ()
-
Goto previous device
search from locked device (if available), otherwise use the selected device
Returns:
-
bool
- goto_next_device ()
-
Goto next device
search from locked device (if available), otherwise use the selected device
Returns:
-
bool
- search_previous_device (track_index, device_index)
-
Locate the prior device
Parameters:
- track_index (int) start search from here
- device_index (int) start search from here
Returns:
-
table or nil
- search_next_device (track_index, device_index)
-
Locate the next device
Parameters:
- track_index (int) start search from here
- device_index (int) start search from here
Returns:
-
table or nil
- goto_device (track_index, device_index, device, skip_tag)
-
Attach to a device, transferring the 'tag' if needed
this is the final step of a "previous/next device" operation,
or called during the initial search
Parameters:
- track_index (int) start search from here
- device_index (int) start search from here
- device (renoise.AudioDevice)
- skip_tag (bool) don't tag device
- update_prev_next (track_index, device_index)
-
Update the lit state of the previous/next device buttons
Parameters:
- track_index (int)
- device_index (int)
- do_device_search ()
- Look for a device that match the provided name it is called right after the target device has been removed, or by initial_select()
- get_unique_name ()
-
Get the unique name of the device, as specified in options
Returns:
-
string
- device_is_valid (device)
-
Test if the device is a valid target
Parameters:
- device (renoise.AudioDevice)
Returns:
-
bool
- tag_device (device)
-
Tag device (add unique identifier), clearing existing one(s)
Parameters:
- device (renoise.AudioDevice), leave out to simply clear
- on_idle ()
-
See also:
- get_selected_device ()
-
Return the currently focused track->device in Renoise
Returns:
-
Device
- attach_to_selected_device ()
- Attempt to select the current device failing to do so will clear the target device
- attach_to_device (track_idx, device_idx, device)
-
Attach notifier to the device
called when we use previous/next device, set the initial device
or are freely roaming the tracks
Parameters:
- track_idx
- device_idx
- device clear the previous device references
- get_device_param (param_name)
-
Retrieve a parameter from the target device by name
Parameters:
- param_name (string)
Returns:
-
DeviceParameter or nil
- update_automation (track_idx, param, value, playmode)
-
Update automation
Parameters:
- track_idx , int
- param , DeviceParameter
- value , number
- playmode ] renoise.PatternTrackAutomation.PLAYMODE_XX
- _attach_to_track_devices (track)
-
Keep track of devices (insert,remove,swap...)
invoked by
attachtodevice()Parameters:
- track (renoise.Track)
- follow_device_pos ()
- Select track + device, but only when follow_pos is enabled
- update_lock_button ()
-
Update the state of the lock button
Returns:
-
bool
- _build_app ()
-
Returns:
-
bool
See also:
- on_new_document ()
-
See also:
- on_release_document ()
-
See also:
- clear_device ()
- De-attach from the device
- _attach_to_song ()
-
Attach notifiers to the song, handle changes
See also:
- _remove_notifiers (observables)
-
"brute force" removal of registered notifiers
Parameters:
- observables
- list of observables
- observables
Tables
- default_options
-
Options
Fields:
- locked Enable/Disable locking
- record_method Determine how to record automation
- follow_pos Follow the selected device in the DSP chain
- available_mappings
-
Mappings
Fields:
- lock_button control the locked state of the selected device
- next_device used for locating a device across tracks
- prev_device used for locating a device across tracks
Fields
- self.target_device
- (renoise.AudioDevice) the device we are currently controlling
- self._blink
- (bool) current blink-state (lock button)
- self.track_index
- (int) the target track index
- self.device_index
- (int) the target device index
- self.current_device_requested
- (bool), set when we should attempt to attach to the current device (althought we might not succeed)
- self._parameter_observables
- (table) list of observable parameters
- self._device_observables
- (table) list of observable device parameters