Module Duplex.BrowserProcess
Duplex.BrowserProcess [[--
Functions
| __init (p_browser) | Initialize the BrowserProcess class |
| matches (device_display_name, config_name) | Check if this process matches the given device configurations |
| matches_configuration (config) | Check if this process matches the given configuration |
| instantiated () | Decide whether the process instantiated correctly |
| instantiate (configuration) | Initialize a process from the passed configuration. |
| _available_device_ports_changed () | Handle device hot-plugging (ports changing while Renoise is running) |
| settings_dialog_visible () | Decide whether the device settings dialog is visible |
| invalidate () | Deinitialize a process actively. |
| running () | Decide if process is running (its apps are running) |
| start (start_running) | Start running a fully configured process. |
| stop () | Stop a running process. |
| 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) |
| show_control_surface (parent_view) | Show a device control surfaces in the browser gui |
| show_settings_dialog () | Display, or bring the browser dialog to front |
| close_settings_dialog () | Close the device settings, when open |
| hide_control_surface () | Hide the device control surfaces, when showing it... |
| clear_display () | Clears/repaints the display, device, virtual UI |
| set_dump_midi (dump) | Start/stop device midi dump |
| set_dump_osc (dump) | Start/stop device osc dump |
| on_idle () | Provide idle support for all active apps |
| on_release_document () | Provide document released notification for all active apps |
| on_new_document () | Provide new document notification for all active apps |
| on_window_became_active () | Provide window active notification for all active apps |
| on_window_resigned_active () | Provide window resigned notification for all active apps |
| __eq (other) | Comparison operator (check configs only) |
Fields
| self.configuration | (table) the full configuration we got instantiated with (if any) |
| self.settings | (table) shortcut for the configurations user settings |
| self.device | (Device), instance of Duplex.MidiDevice or Duplex.OscDevice class |
| self.display | (Duplex.Display) |
| self._message_stream | (Duplex.MessageStream) |
| self._control_surface_view | (renoise.Views.View) built by the display for the device |
| self._applications | (table) list of instantiated apps for the current configuration |
| self._was_running | (bool) true when this process was running at least once after instantiated |
| self._vb | (Renoise.ViewBuilder) |
| self.browser | (Duplex.Browser) |
| self.configuration | assign the config and settings |
| self._message_stream | instantiate the device |
Functions
- __init (p_browser)
-
Initialize the BrowserProcess class
Parameters:
- p_browser (Duplex.Browser)
- matches (device_display_name, config_name)
-
Check if this process matches the given device configurations
Parameters:
- device_display_name (String)
- config_name (String)
Returns:
-
(bool)
- matches_configuration (config)
-
Check if this process matches the given configuration
Parameters:
- config (String)
Returns:
-
(bool)
- instantiated ()
-
Decide whether the process instantiated correctly
Returns:
-
(bool)
- 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
Returns:
-
(bool) true when instantiated
- _available_device_ports_changed ()
- Handle device hot-plugging (ports changing while Renoise is running)
- settings_dialog_visible ()
-
Decide whether the device settings dialog is visible
Returns:
-
(bool)
- invalidate ()
- Deinitialize a process actively. can always be called, even when initialization never happened
- running ()
-
Decide if process is running (its apps are running)
Returns:
-
bool
- start (start_running)
-
Start running a fully configured process. returns true when successfully
started, else false (may happen if one of the apps failed to start)
Parameters:
- start_running
- stop ()
- Stop a running process. will not invalidate it, just stop all apps
- 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)
- show_control_surface (parent_view)
-
Show a device control surfaces in the browser gui
Parameters:
- parent_view (ViewBuilder) the browser GUI
- show_settings_dialog ()
- Display, or bring the browser dialog to front
- close_settings_dialog ()
- Close the device settings, when open
- hide_control_surface ()
- Hide the device control surfaces, when showing it...
- clear_display ()
- Clears/repaints the display, device, virtual UI
- set_dump_midi (dump)
-
Start/stop device midi dump
Parameters:
- dump (bool), true to start dumping MIDI
- set_dump_osc (dump)
-
Start/stop device osc dump
Parameters:
- dump (bool), true to start dumping OSC
- on_idle ()
- Provide idle support for all active apps
- on_release_document ()
- Provide document released notification for all active apps
- on_new_document ()
- Provide new document notification for all active apps
- on_window_became_active ()
- Provide window active notification for all active apps
- on_window_resigned_active ()
- Provide window resigned notification for all active apps
- __eq (other)
-
Comparison operator (check configs only)
Parameters:
- other (BrowserProcess) the process to compare against
Fields
- self.configuration
- (table) the full configuration we got instantiated with (if any)
- self.settings
- (table) shortcut for the configurations user settings
- self.device
- (Device), instance of Duplex.MidiDevice or Duplex.OscDevice class
- self.display
- (Duplex.Display)
- self._message_stream
- (Duplex.MessageStream)
- self._control_surface_view
- (renoise.Views.View) built by the display for the device
- self._applications
- (table) list of instantiated apps for the current configuration
- self._was_running
- (bool) true when this process was running at least once after instantiated
- self._vb
- (Renoise.ViewBuilder)
- self.browser
- (Duplex.Browser)
- self.configuration
- assign the config and settings
- self._message_stream
- instantiate the device