Module Duplex.Applications.MidiActions

MidiActions will expose most of the standard Renoise mappings to Duplex.

Inheritance: Duplex.Application > Duplex.Application.MidiActions

MidiActions will expose standard Renoise mappings as fully bi-directional mappings, with customizable scaling (exponential, logarithmic, linear) and range.

By parsing the GlobalMidiActions file, it literally provides access to hundreds of features inside Renoise, such as BPM, LPB, and even UI view presets. You will have to map each feature manually, but only once - once mapped, the target will remain accessible.

See also: Duplex.Applications.MidiActions.Bindings

Functions

__init (VarArg) Constructor method
start_app () inherited from Application
stop_app () inherited from Application
_clear_routing () Reset all properties that deal with the current mapping
_remove_notifier () Detach an existing notifier, if it exists
_update_control (skip_transmit) Bi-directional update (controller/Renoise)
_scale_value (val, method) Scale value log/exponentially
_has_value () Determine if we are able to retrieve value for the current assignment
_has_observable () Determine ability to retrieve an Observable for the current assignment
_get_value () Retrieve value for the current assignment
_get_observable () Retrieve Observable for the current assignment
_transmit (val) Transmit message when routed to MIDI, we generate an emulated 'TriggerMessage'
_get_min_max (assist) Get the min/max values for a parameter
_retrieve_assist_by_name (str_name) Locate a specific item in our "assist" table from it's name, with built-in wildcard support (entries that contain an asterisk)
_update_option_panel () Update min/max options, called after routing has been established
_reset_min_max_options () Disable min/max options
_validate_range () Validate & set the current option/user-specified min/max note that we allow inverted min/max, but not values outside this range
_establish_routing (first_run) Look up the mapping and gather as much information as possible
on_idle () inherited from Application
_build_options () Override the application method (update the options once ready)
_build_app () inherited from Application

Tables

self._controls List of UIComponents
self._assist (table), contains extra information about mapping (see MidiActions.assist_table)

Fields

self._active_map_index (int), between 1 - #midimappings, or nil if no action
self._is_switch (bool), interpreted from the MIDI action
self._is_trigger (bool), interpreted from the MIDI action
self._is_toggle (bool), control the visual state of a button
self._value (number/bool/nil), represents the current value (literal value, "64" for 64 BPM, "1.2" for 1.2 db, etc.)
self._skip_notifier (bool), set when updating a parameter which is being observed
self._revert_requested (bool), set when options should be reset
self._user_min (number), last "good" user-specified value


Functions

__init (VarArg)
Constructor method

Parameters:

  • VarArg )

See also:

start_app ()
inherited from Application

Returns:

    bool or nil

See also:

stop_app ()
inherited from Application

See also:

_clear_routing ()
Reset all properties that deal with the current mapping
_remove_notifier ()
Detach an existing notifier, if it exists
_update_control (skip_transmit)
Bi-directional update (controller/Renoise)

Parameters:

  • skip_transmit (bool)
_scale_value (val, method)
Scale value log/exponentially

Parameters:

  • val
  • method

Returns:

    bool
_has_value ()
Determine if we are able to retrieve value for the current assignment

Returns:

    bool
_has_observable ()
Determine ability to retrieve an Observable for the current assignment

Returns:

    bool
_get_value ()
Retrieve value for the current assignment

Returns:

    bool, number or nil
_get_observable ()
Retrieve Observable for the current assignment

Returns:

    bool, number or nil
_transmit (val)
Transmit message when routed to MIDI, we generate an emulated 'TriggerMessage'

Parameters:

  • val (number, bool or nil)
_get_min_max (assist)
Get the min/max values for a parameter

Parameters:

  • assist (Table) an entry from the assist table
_retrieve_assist_by_name (str_name)
Locate a specific item in our "assist" table from it's name, with built-in wildcard support (entries that contain an asterisk)

Parameters:

  • str_name
_update_option_panel ()
Update min/max options, called after routing has been established
_reset_min_max_options ()
Disable min/max options
_validate_range ()
Validate & set the current option/user-specified min/max note that we allow inverted min/max, but not values outside this range
_establish_routing (first_run)
Look up the mapping and gather as much information as possible

Parameters:

  • first_run (bool) true when app is first instantiated
on_idle ()
inherited from Application

See also:

_build_options ()
Override the application method (update the options once ready)
_build_app ()
inherited from Application

Returns:

    bool

See also:

Tables

self._controls
List of UIComponents
self._assist
(table), contains extra information about mapping (see MidiActions.assist_table)

Fields

self._active_map_index
(int), between 1 - #midimappings, or nil if no action
self._is_switch
(bool), interpreted from the MIDI action
self._is_trigger
(bool), interpreted from the MIDI action
self._is_toggle
(bool), control the visual state of a button
self._value
(number/bool/nil), represents the current value (literal value, "64" for 64 BPM, "1.2" for 1.2 db, etc.)
self._skip_notifier
(bool), set when updating a parameter which is being observed
self._revert_requested
(bool), set when options should be reset
self._user_min
(number), last "good" user-specified value
generated by LDoc 1.4.2