Module xLine

This class is used to describe a single line in the song .

  • Includes patterns, phrases or automation
  • Limited to a single track at a time

Functions

__init (args) constructor method
apply_descriptor (xline) convert descriptors into class instances (empty tables are left as-is)
do_write (sequence, line, track_idx, phrase, ptrack_auto, patt_num_lines, tokens, include_hidden, expand_columns, clear_undefined) write to pattern/phrase/automation - all defined types of data
clear_pattern_line (sequence, line, track_idx, phrase)
do_read (sequence, line, include_hidden, track_idx, phrase) read from song, return a descriptive table
resolve_pattern_line (sequence, line, track_idx) resolvepatternline: MUST be valid
resolve_phrase_line (line, phrase) resolvephraseline: MUST be valid

Fields

self.automation xLineAutomation


Functions

__init (args)
constructor method

Parameters:

  • args (table)
apply_descriptor (xline)
convert descriptors into class instances (empty tables are left as-is)

Parameters:

  • xline (xLine or table) will create xLine instance if table

Returns:

    xLine
do_write (sequence, line, track_idx, phrase, ptrack_auto, patt_num_lines, tokens, include_hidden, expand_columns, clear_undefined)
write to pattern/phrase/automation - all defined types of data

Parameters:

  • sequence (int)
  • line (int)
  • track_idx (int)
  • phrase (renoise.InstrumentPhrase)
  • ptrack_auto (renoise.PatternTrackAutomation)
  • patt_num_lines (int), length of the playpos pattern
  • tokens (table)
  • include_hidden (bool)
  • expand_columns (bool)
  • clear_undefined (bool)
clear_pattern_line (sequence, line, track_idx, phrase)

Parameters:

  • sequence (int)
  • line (int)
  • track_idx (int), when writing to pattern
  • phrase (renoise.InstrumentPhrase)
do_read (sequence, line, include_hidden, track_idx, phrase)
read from song, return a descriptive table

Parameters:

  • sequence (int)
  • line (int)
  • include_hidden (bool),
  • track_idx (int), when reading from pattern
  • phrase (renoise.InstrumentPhrase) TODO @param deviceindex (int), include automation TODO @param paramindex (int), include automation

Returns:

    table
resolve_pattern_line (sequence, line, track_idx)
resolvepatternline: MUST be valid

Parameters:

  • sequence (int)
  • line (int)
  • track_idx (int)

Returns:

  1. rns_line (renoise.PatternLine)
  2. patt_idx (int),
  3. rns_patt (renoise.Pattern)
  4. rns_track (renoise.Track)
  5. rns_ptrack (renoise.PatternTrack)
resolve_phrase_line (line, phrase)
resolvephraseline: MUST be valid

Parameters:

  • line (int)
  • phrase (renoise.Phrase)

Returns:

    rns_line (renoise.PatternLine)

Fields

self.automation
xLineAutomation
generated by LDoc 1.4.2