File Duplex/Browser.lua
Functions
Browser:__init (initial_configuration, start_configuration) | Initialize the Browser class |
Browser:_available_configuration_names_for_device (device_display_name) | Retrieve list of configuration-names present for the provided device |
Browser:_available_configurations_for_device (device_display_name) | Retrieve list of configurations present for the provided device |
Browser:_available_device_ports_changed () | Notifier, fired when device input or output port setting changed |
Browser:_configuration_autostart_enabled () | Check whether the current configuration should be autostarted return (Boolean) |
Browser:_configuration_index_by_name (config_name) | Retrieve index of the given configuration name |
Browser:_create_content_view () | Build and assign the application dialog |
Browser:_current_process () | Retrieve the current process |
Browser:_decorate_configuration_list () | Add/remove the "running" postfix for relevant configurations. |
Browser:_decorate_device_list () | Add/remove the "running" postfix for relevant devices. |
Browser:_device_index_by_name (device_display_name) | Retrieve index of the given device display name |
Browser:_device_ports_changed () | Notifier, fired when device input or output port setting changed |
Browser:_disable_configuration_autostart () | Remove the current configuration from the autostart prefs |
Browser:_enable_configuration_autostart () | Add the current configuration to the autostart prefs |
Browser:_process_running () | Check if any processes are running |
Browser:_strip_postfixes (name) | Remove NOT_AVAILABLE_POSTFIX and RUNNING_POSTFIX from the passed name |
Browser:_update_device_description () | Show info about the current device, as specified in the control-map |
Browser:available_configurations (device_name) | Return list of valid configurations for the given device |
Browser:available_devices () | Return a list of valid devices (plus a "None" option) existing devices (ones that we found MIDI ports for) are listed first, all others are listed as (N/A) to indicate that they are not present in the users device setup |
Browser:configuration_running (configuration) | Determine if the given config is instantiated and running |
Browser:dump_midi () | Check if we should write debug data to the std out (console) |
Browser:has_next_configuration () | Check if next configuration exist |
Browser:has_previous_configuration () | Check if previous configuration exist |
Browser:hide () | Hide the dialog |
Browser:on_idle () | Forward idle notifications to all active processes |
Browser:on_new_document () | Forward new document notifications to all active processes |
Browser:on_release_document () | Forward released document notifications to all active processes |
Browser:set_configuration (configuration, start_running) | Activate a new configuration for the currently active device |
Browser:set_device (device_display_name, configuration_hint) | Change the active input device: instantiates a new device, using the first avilable configuration for it, or reusing an already running configuration |
Browser:set_dump_midi (dump) | Set the MIDI dump status |
Browser:set_next_configuration () | Activate the next configuration (if active, has next) |
Browser:set_previous_configuration () | Activate the previous configuration (if active, has previous) |
Browser:show () | Activate and shows the dialog, or bring the existing one to front |
Browser:start_current_configuration () | Start current configuration (and all apps within it) |
Browser:stop_current_configuration () | Stop current configuration (and all apps within it) |
BrowserProcess:__eq (other) | Comparison operator (check configs only) |
BrowserProcess:__init (p_browser) | Initialize the BrowserProcess class |
BrowserProcess:_available_device_ports_changed () | Handle device hot-plugging (ports changing while Renoise is running) |
BrowserProcess:clear_display () | Clears/repaints the display, device, virtual UI |
BrowserProcess:close_settings_dialog () | Close the device settings, when open |
BrowserProcess:control_surface_visible () | Returns true when the processes control surface is currently visible (this is also an indication of whether this is the selected device) |
BrowserProcess:hide_control_surface () | Hide the device control surfaces, when showing it... |
BrowserProcess:instantiate (configuration) | Initialize a process from the passed configuration. |
BrowserProcess:instantiated () | Decide whether the process instantiated correctly |
BrowserProcess:invalidate () | Deinitialize a process actively. |
BrowserProcess:matches (device_display_name, config_name) | Check if this process matches the given device configurations |
BrowserProcess:matches_configuration (config) | Check if this process matches the given configuration |
BrowserProcess:on_idle () | Provide idle support for all active apps |
BrowserProcess:on_new_document () | Provide new document notification for all active apps |
BrowserProcess:on_release_document () | Provide document released notification for all active apps |
BrowserProcess:running () | Decide if process is running (its apps are running) |
BrowserProcess:set_dump_midi (dump) | Start/stop device midi dump |
BrowserProcess:settings_dialog_visible () | Decide whether the device settings dialog is visible |
BrowserProcess:show_control_surface (parent_view) | Show a device control surfaces in the browser gui |
BrowserProcess:show_settings_dialog () | Display, or bring the browser dialog to front |
BrowserProcess:start () | Start running a fully configured process. |
BrowserProcess:stop () | Stop a running process. |
Functions
- Browser:__init (initial_configuration, start_configuration)
-
Initialize the Browser class
Parameters:
-
initial_configuration
: (Table) set to this configuration -
start_configuration
: (Boolean) true to start the application
-
- Browser:_available_configuration_names_for_device (device_display_name)
-
Retrieve list of configuration-names present for the provided device
Parameters:
-
device_display_name
: (String) device_display_name
Return value:
- (Table) list of configuration names
-
- Browser:_available_configurations_for_device (device_display_name)
-
Retrieve list of configurations present for the provided device
Parameters:
-
device_display_name
: (String) device_display_name
Return value:
- (Table) list of configurations
-
- Browser:_available_device_ports_changed ()
- Notifier, fired when device input or output port setting changed
- Browser:_configuration_autostart_enabled ()
- Check whether the current configuration should be autostarted return (Boolean)
- Browser:_configuration_index_by_name (config_name)
-
Retrieve index of the given configuration name
Parameters:
-
config_name
: (String)
Return value:
- (Number or nil)
-
- Browser:_create_content_view ()
- Build and assign the application dialog
- Browser:_current_process ()
-
Retrieve the current process
Return value:
- (BrowserProcess object or nil)
- Browser:_decorate_configuration_list ()
- Add/remove the "running" postfix for relevant configurations. called when we start/stop apps, and choose a device/config
- Browser:_decorate_device_list ()
- Add/remove the "running" postfix for relevant devices. called when we start/stop apps, and choose a device/config
- Browser:_device_index_by_name (device_display_name)
-
Retrieve index of the given device display name
Parameters:
-
device_display_name
: (String)
Return value:
- (Number or nil)
-
- Browser:_device_ports_changed ()
- Notifier, fired when device input or output port setting changed
- Browser:_disable_configuration_autostart ()
- Remove the current configuration from the autostart prefs
- Browser:_enable_configuration_autostart ()
- Add the current configuration to the autostart prefs
- Browser:_process_running ()
-
Check if any processes are running
Return value:
- (Boolean) true when at least one process is instantiated and running
- Browser:_strip_postfixes (name)
-
Remove NOT_AVAILABLE_POSTFIX and RUNNING_POSTFIX from the passed name
Parameters:
-
name
: (String)
Return value:
- (String) the name without decoration
-
- Browser:_update_device_description ()
- Show info about the current device, as specified in the control-map
- Browser:available_configurations (device_name)
-
Return list of valid configurations for the given device
Parameters:
-
device_name
: (String) the device name
-
- Browser:available_devices ()
-
Return a list of valid devices (plus a "None" option) existing devices (ones that we found MIDI ports for) are listed first, all others are listed as (N/A) to indicate that they are not present in the users device setup
Return value:
- (Table) list of device names
- Browser:configuration_running (configuration)
-
Determine if the given config is instantiated and running
Parameters:
-
configuration
: (Table) the configuration to check
Return value:
- (Boolean) true if config is running
-
- Browser:dump_midi ()
-
Check if we should write debug data to the std out (console)
Return value:
- (Boolean)
- Browser:has_next_configuration ()
-
Check if next configuration exist
Return value:
- (Boolean)
- Browser:has_previous_configuration ()
-
Check if previous configuration exist
Return value:
- (Boolean)
- Browser:hide ()
- Hide the dialog
- Browser:on_idle ()
- Forward idle notifications to all active processes
- Browser:on_new_document ()
- Forward new document notifications to all active processes
- Browser:on_release_document ()
- Forward released document notifications to all active processes
- Browser:set_configuration (configuration, start_running)
-
Activate a new configuration for the currently active device
Parameters:
-
configuration
: (Table) -
start_running
: (Boolean)
-
- Browser:set_device (device_display_name, configuration_hint)
-
Change the active input device: instantiates a new device, using the first avilable configuration for it, or reusing an already running configuration
Parameters:
-
device_display_name
: (string) device display-name, without postfix -
configuration_hint
: (optional table) configuration that should be used to instantiate the device. when nil, a default one is selected from the available device configs
-
- Browser:set_dump_midi (dump)
-
Set the MIDI dump status
Parameters:
-
dump
: (Boolean)
-
- Browser:set_next_configuration ()
- Activate the next configuration (if active, has next)
- Browser:set_previous_configuration ()
- Activate the previous configuration (if active, has previous)
- Browser:show ()
- Activate and shows the dialog, or bring the existing one to front
- Browser:start_current_configuration ()
- Start current configuration (and all apps within it)
- Browser:stop_current_configuration ()
- Stop current configuration (and all apps within it)
- BrowserProcess:__eq (other)
-
Comparison operator (check configs only)
Parameters:
-
other
: (BrowserProcess) the process to compare against
-
- BrowserProcess:__init (p_browser)
-
Initialize the BrowserProcess class
Parameters:
-
p_browser
: (Browser), instance of Browser class
-
- BrowserProcess:_available_device_ports_changed ()
- Handle device hot-plugging (ports changing while Renoise is running)
- BrowserProcess:clear_display ()
- Clears/repaints the display, device, virtual UI
- BrowserProcess:close_settings_dialog ()
- Close the device settings, when open
- BrowserProcess:control_surface_visible ()
- Returns true when the processes control surface is currently visible (this is also an indication of whether this is the selected device)
- BrowserProcess:hide_control_surface ()
- Hide the device control surfaces, when showing it...
- BrowserProcess:instantiate (configuration)
-
Initialize a process from the passed configuration. this will only create the device, display and app, but not start it. to start a process, "start" must be called.
Parameters:
-
configuration
: (Table) the device configuration
Return value:
- (Boolean) true when instantiated
-
- BrowserProcess:instantiated ()
-
Decide whether the process instantiated correctly
Return value:
- (Boolean)
- BrowserProcess:invalidate ()
- Deinitialize a process actively. can always be called, even when initialization never happened
- BrowserProcess:matches (device_display_name, config_name)
-
Check if this process matches the given device configurations
Parameters:
-
device_display_name
: (String) -
config_name
: (String)
Return value:
- (Boolean)
-
- BrowserProcess:matches_configuration (config)
-
Check if this process matches the given configuration
Parameters:
-
config
: (String)
Return value:
- (Boolean)
-
- BrowserProcess:on_idle ()
- Provide idle support for all active apps
- BrowserProcess:on_new_document ()
- Provide new document notification for all active apps
- BrowserProcess:on_release_document ()
- Provide document released notification for all active apps
- BrowserProcess:running ()
-
Decide if process is running (its apps are running)
Return value:
- Boolean
- BrowserProcess:set_dump_midi (dump)
-
Start/stop device midi dump
Parameters:
-
dump
: (Boolean), true to start dumping MIDI
-
- BrowserProcess:settings_dialog_visible ()
-
Decide whether the device settings dialog is visible
Return value:
- (Boolean)
- BrowserProcess:show_control_surface (parent_view)
-
Show a device control surfaces in the browser gui
Parameters:
-
parent_view
: (ViewBuilder) the browser GUI
-
- BrowserProcess:show_settings_dialog ()
- Display, or bring the browser dialog to front
- BrowserProcess:start ()
- Start running a fully configured process. returns true when successfully started, else false (may happen if one of the apps failed to start)
- BrowserProcess:stop ()
- Stop a running process. will not invalidate it, just stop all apps