Module xAutomation

Easy control of parameter automation.

Functions

__init (...) [Constructor] accepts a single argument for initializing the class
record (track_idx, param, value, value_mode) [Class] Add automation point at current time
has_automation (track_idx, param) [Class] Check if automation exists for the given parameter
clear_range (pos_from, length, ptrack_auto) [Class] Clear automation for the given range
get_position () [Class] Retrieve the correct SongPos object according to FOLLOW_MODE
get_or_create_automation (ptrack, param) [Static] Get or create the parameter automation
get_scaled_value (value, value_mode) [Static] Scale an incoming value to the automation range (0-1)

Tables

WRITE_MODE How to write data into an envelope - INTERLEAVE: leave existing data as-is (renoise default) - PUNCH_IN: remove existing data (using writeahead)
PLAYMODE Envelope interpolation AUTOMATIC: use existing mode POINTS: set to points mode LINEAR: set to linear mode CUBIC: set to cubic mode

Fields

self.follow_mode xAutomation.FOLLOW_MODE
self.write_mode xAutomation.WRITE_MODE
self.playmode renoise.PatternTrackAutomation.PLAYMODE_xx (leave undefined to use current interpolation mode)
self.highres_mode boolean, whether to use fractional line-index or not


Functions

__init (...)
[Constructor] accepts a single argument for initializing the class

Parameters:

  • ...
record (track_idx, param, value, value_mode)
[Class] Add automation point at current time

Parameters:

  • track_idx (int)
  • param (renoise.DeviceParameter)
  • value (number) the input value
  • value_mode ] (xMidiMessage.MODE) - apply scaling to the input value
has_automation (track_idx, param)
[Class] Check if automation exists for the given parameter

Parameters:

  • track_idx (number)
  • param (renoise.DeviceParameter)
clear_range (pos_from, length, ptrack_auto)
[Class] Clear automation for the given range

Parameters:

  • pos_from (int)
  • length (number), can be fractional
  • ptrack_auto (renoise.PatternTrackAutomation)
get_position ()
[Class] Retrieve the correct SongPos object according to FOLLOW_MODE

Returns:

    int or nil
get_or_create_automation (ptrack, param)
[Static] Get or create the parameter automation

Parameters:

  • ptrack (renoise.PatternTrack)
  • param (renoise.DeviceParameter)
get_scaled_value (value, value_mode)
[Static] Scale an incoming value to the automation range (0-1)

Parameters:

  • value (number)
  • value_mode (xMidiMessage.MODE), abs/rel + #bits

Returns:

    number

Tables

WRITE_MODE
How to write data into an envelope - INTERLEAVE: leave existing data as-is (renoise default) - PUNCH_IN: remove existing data (using writeahead)

Fields:

  • INTERLEAVE
  • PUNCH_IN
PLAYMODE
Envelope interpolation AUTOMATIC: use existing mode POINTS: set to points mode LINEAR: set to linear mode CUBIC: set to cubic mode

Fields:

  • AUTOMATIC
  • POINTS
  • LINEAR
  • CUBIC

Fields

self.follow_mode
xAutomation.FOLLOW_MODE
self.write_mode
xAutomation.WRITE_MODE
self.playmode
renoise.PatternTrackAutomation.PLAYMODE_xx (leave undefined to use current interpolation mode)
self.highres_mode
boolean, whether to use fractional line-index or not
generated by LDoc 1.4.2