xLib

• Index

Contents

• Functions

Modules

• xAudioDevice
• xAudioDeviceAutomation
• xAutomation
• xBlockLoop
• xColumns
• xCursorPos
• xEffectColumn
• xEnvelope
• xInstrument
• xKeyZone
• xLFO
• xLib
• xLine
• xLineAutomation
• xLinePattern
• xMatrixSelection
• xMessage
• xMidiCommand
• xMidiInput
• xMidiIO
• xMidiMessage
• xNoteCapture
• xNoteColumn
• xOscClient
• xOscDevice
• xOscMessage
• xOscPattern
• xOscRouter
• xOscValue
• xParameter
• xParameterAutomation
• xPatternPos
• xPatternSelection
• xPatternSequencer
• xPersistentSettings
• xPhrase
• xPhraseManager
• xPhraseSelection
• xPlayPos
• xRule
• xRules
• xRuleset
• xSample
• xSampleBuffer
• xSampleBufferOperation
• xSampleDeviceChain
• xSampleMapping
• xScale
• xSequencerSelection
• xSongPos
• xStreamBuffer
• xStreamPos
• xTrack
• xTransport
• xValue
• xVoiceManager
• xVoiceRunner
• xVoiceSorter

Module xTrack

Static Methods for working with renoise.Track objects .

Functions

get_master_track_index ()	[Static] Get master track index
get_master_track ()	[Static] Get the master track
get_send_track (send_index)	[Static] Get send track with specific index
any_track_is_soloed ()	[Static] check if any track is soloed
get_tracks_by_type (track_type)	[Static] Get total number of tracks matching the "type" Necessary as renoise.song().sequencertrackcount doesn't consider group tracks
get_group_track_index (track_idx, match_self)	[Static] Get the group track index associated with the provided track
get_first_sequencer_track_in_group (track_idx)	[Static] Get the first sequencer-track associated with the provided group
determine_track_type (track_idx)	[Static] Get the type of track: sequencer/master/send
jump_to_next_sequencer_track (track_idx, wrap_pattern)	[Static] Jump to the next sequencer track - see xTrack.getnextsequencer_track()
get_next_sequencer_track (track_idx, wrap_pattern)	[Static] Get the next sequencer track (skip other types)
jump_to_previous_sequencer_track (track_idx, wrap_pattern)	[Static] Jump to the previous sequencer track - see xTrack.getprevioussequencer_track()
get_previous_sequencer_track (track_idx, wrap_pattern)	[Static] Navigate to the previous sequencer track (skip other types)
jump_to_next_track (track_idx, wrap_pattern)	[Static] Jump to the next track - see xTrack.getnexttrack()
get_next_track (track_idx, wrap_pattern)	[Static] Return the next track
jump_to_previous_track (track_idx, wrap_pattern)	[Static] Jump to the next sequencer track - see xTrack.getnextsequencer_track()
get_previous_track (track_idx, wrap_pattern)	[Static] Return the previous track
get_pattern_track (seq_idx, trk_idx)	[Static] Obtain a specific pattern-track
get_selected_column_index ()	[Static] Get column_index, based on visible columns (similar to e.g.
set_selected_column_index (track, col_idx)	[Static] Set column_index, based on visible columns (similar to e.g.
set_column_mute (col_idx)	[Static] Set mute state for a note column in the selected track
get_device_index (track, device)

Functions

get_master_track_index ()

[Static] Get master track index

Returns:

number

get_master_track ()

[Static] Get the master track

Returns:

renoise.Track

get_send_track (send_index)

[Static] Get send track with specific index

Parameters:

• send_index (int), 1 == first, 2 == second, etc.

Returns:

renoise.Track or nil

any_track_is_soloed ()

[Static] check if any track is soloed

Returns:

boolean

get_tracks_by_type (track_type)

[Static] Get total number of tracks matching the "type" Necessary as renoise.song().sequencertrackcount doesn't consider group tracks

Parameters:

• track_type (renoise.Track.TRACKTYPExxx)

Returns:

table

get_group_track_index (track_idx, match_self)

[Static] Get the group track index associated with the provided track

Parameters:

• track_idx (number)
• match_self (boolean), allow matching the provided track

Returns:

number or nil

get_first_sequencer_track_in_group (track_idx)

[Static] Get the first sequencer-track associated with the provided group

Parameters:

• track_idx (number)

Returns:

number or nil, [error message (string)]

determine_track_type (track_idx)

[Static] Get the type of track: sequencer/master/send

Parameters:

• track_idx (int)

Returns:

renoise.Track.TRACKTYPExxx or nil

jump_to_next_sequencer_track (track_idx, wrap_pattern)

[Static] Jump to the next sequencer track - see xTrack.getnextsequencer_track()

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

get_next_sequencer_track (track_idx, wrap_pattern)

[Static] Get the next sequencer track (skip other types)

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

Returns:

boolean, true when able to navigate

jump_to_previous_sequencer_track (track_idx, wrap_pattern)

[Static] Jump to the previous sequencer track - see xTrack.getprevioussequencer_track()

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

get_previous_sequencer_track (track_idx, wrap_pattern)

[Static] Navigate to the previous sequencer track (skip other types)

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

Returns:

number

jump_to_next_track (track_idx, wrap_pattern)

[Static] Jump to the next track - see xTrack.getnexttrack()

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

get_next_track (track_idx, wrap_pattern)

[Static] Return the next track

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

Returns:

boolean, true when able to navigate

jump_to_previous_track (track_idx, wrap_pattern)

[Static] Jump to the next sequencer track - see xTrack.getnextsequencer_track()

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

get_previous_track (track_idx, wrap_pattern)

[Static] Return the previous track

Parameters:

• track_idx ], start from this track (use selected if not specified)
• wrap_pattern ], boolean (wrap around at pattern edges - default is true)

Returns:

boolean, true when able to navigate

get_pattern_track (seq_idx, trk_idx)

[Static] Obtain a specific pattern-track

Parameters:

• seq_idx (number)
• trk_idx (number)

Returns:

1. PatternTrack or nil (when failed)
2. string, error message when failed

get_selected_column_index ()

[Static] Get columnindex, based on visible columns (similar to e.g. renoise.song().selectionin_pattern)

set_selected_column_index (track, col_idx)

[Static] Set columnindex, based on visible columns (similar to e.g. renoise.song().selectionin_pattern)

Parameters:

• track (renoise.Track)
• col_idx (number)

Returns:

string, error message when failed

set_column_mute (col_idx)

[Static] Set mute state for a note column in the selected track

Parameters:

• col_idx (number)

Returns:

number or nil

get_device_index (track, device)

Parameters:

• track (renoise.Track)
• device (AudioDevice)

Returns:

number or nil