Module Duplex.Applications.Mlrx.Mlrx_group

Mlrx_group - this class represent a logical group in mlrx the group takes care of administering updates to it's child tracks

Functions

__init (main) Constructor method
collect_group_tracks (self_idx) collect all Mlrx_tracks assigned to this group
__eq (other) compare to another class instance (check for object identity)
group_output (on_idle) this method will call track output in all child tracks
set_grp_panning (val, skip_output) specify the group panning level
set_grp_velocity (val, skip_output) specify the group velocity level
set_grp_automation (param_type) record current group velocity/panning into active track/envelope
update_mixer_params () when updating automation in READ mode, we need to set the panning and velocity of all group tracks
toggle () disable activity for the group (stop active tracks), or toggle mute state
switch_to_track (trk_idx) when switching track, check if we should output note-off for other tracks
cancel_notes () stop group, triggered when stopping playback (will not write anything to pattern but simply cancel notes)

Tables

color (table) the color assigned to this group
color_dimmed (table) a darker version of the color, black when monochrome

Fields

self.velocity (int) group velocity (between 0-255)
self.panning (int) group panning (between 0-255)
self.tracks () updated whenever tracks are reassigned
self.automation (Automation) instance of Duplex automation class
self.grp_latch_velocity (bool) true when 'latched' automation is being recorded (this will cause the group button to blink)
self.active_track_index (int) index of the track that most recently wrote to a pattern in the group (used by the WRITE mode to determine if we should keep wiping tracks after any notes have stopped playing)
self.void_mutes (bool) a special 'void' type group that bypass mute groups


Functions

__init (main)
Constructor method

Parameters:

  • main (Mlrx) reference to main application
collect_group_tracks (self_idx)
collect all Mlrx_tracks assigned to this group

Parameters:

  • self_idx (int) this group's index, as the main application know it
__eq (other)
compare to another class instance (check for object identity)

Parameters:

  • other
group_output (on_idle)
this method will call track output in all child tracks

Parameters:

  • on_idle (bool) true when method is invoked by idle loop
set_grp_panning (val, skip_output)
specify the group panning level

Parameters:

  • val (float) value between 0 and 255
  • skip_output (bool) do not write automation
set_grp_velocity (val, skip_output)
specify the group velocity level

Parameters:

  • val (float) value between 0 and 255
  • skip_output (bool) do not write automation
set_grp_automation (param_type)
record current group velocity/panning into active track/envelope

Parameters:

  • param_type (enum) Mlrxtrack.PARAMVELOCITY or Mlrxtrack.PARAMPANNING
update_mixer_params ()
when updating automation in READ mode, we need to set the panning and velocity of all group tracks
toggle ()
disable activity for the group (stop active tracks), or toggle mute state
switch_to_track (trk_idx)
when switching track, check if we should output note-off for other tracks

Parameters:

  • trk_idx
cancel_notes ()
stop group, triggered when stopping playback (will not write anything to pattern but simply cancel notes)

Tables

color
(table) the color assigned to this group

Fields:

  • red
  • green
  • blue
color_dimmed
(table) a darker version of the color, black when monochrome

Fields:

  • red
  • green
  • blue

Fields

self.velocity
(int) group velocity (between 0-255)
self.panning
(int) group panning (between 0-255)
self.tracks
() updated whenever tracks are reassigned
self.automation
(Automation) instance of Duplex automation class
self.grp_latch_velocity
(bool) true when 'latched' automation is being recorded (this will cause the group button to blink)
self.active_track_index
(int) index of the track that most recently wrote to a pattern in the group (used by the WRITE mode to determine if we should keep wiping tracks after any notes have stopped playing)
self.void_mutes
(bool) a special 'void' type group that bypass mute groups
generated by LDoc 1.4.2