renoise.Transport

Transport component of the Renoise song.

Constants
Properties
Functions

Constants

PlayMode

{
    PLAYMODE_RESTART_PATTERN: integer = 1,
    PLAYMODE_CONTINUE_PATTERN: integer = 2,
}

RecordParameterMode

{
    RECORD_PARAMETER_MODE_PATTERN: integer = 1,
    RECORD_PARAMETER_MODE_AUTOMATION: integer = 2,
}

TimingModel

{
    TIMING_MODEL_SPEED: integer = 1,
    TIMING_MODEL_LPB: integer = 2,
}

SyncMode

{
    SYNC_MODE_INTERNAL: integer = 1,
    SYNC_MODE_MIDI_CLOCK: integer = 2,
    SYNC_MODE_ABLETON_LINK: integer = 3,
    SYNC_MODE_JACK: integer = 4,
}

Properties

playing : `boolean`

Playing

playing_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

sync_mode : `renoise.Transport.SyncMode`

Transport sync mode. Note: SYNC_MODE_JACK only is available on Linux. Trying to enable it on other platforms will fire an error.

sync_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

timing_model : `renoise.Transport.TimingModel`

READ-ONLY Old school speed or new LPB timing used? With TIMING_MODEL_SPEED, tpl is used as speed factor. The lpb property is unused then. With TIMING_MODEL_LPB, tpl is used as event rate for effects only and lpb defines relationship between pattern lines and beats.

bpm : `number`

Range: (32 - 999) Beats per Minute

bpm_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

lpb : `integer`

Range: (1 - 256) Lines per Beat

lpb_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

tpl : `integer`

Range: (1 - 16) Ticks per Line

tpl_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

playback_pos : `renoise.SongPos`

Playback position

playback_pos_beats : `number`

Range: (0 - song_end_beats) Song position in beats

edit_pos : `renoise.SongPos`

Edit position

edit_pos_beats : `number`

Range: (0 - song_end_beats) Song position in beats

song_length : `renoise.SongPos`

READ-ONLY

song_length_beats : `number`

READ-ONLY

loop_start : `renoise.SongPos`

READ-ONLY

loop_end : `renoise.SongPos`

READ-ONLY

loop_range : `renoise.SongPos`[]

{loop start, loop end}

loop_start_beats : `number`

READ-ONLY Range: (0 - song_end_beats)

loop_end_beats : `number`

READ-ONLY Range: (0 - song_end_beats)

loop_range_beats : `number`[]

{loop start beats, loop end beats}

loop_sequence_start : `integer`

READ-ONLY 0 or Range: (1 - sequence length)

loop_sequence_end : `integer`

READ-ONLY 0 or Range: (1 - sequence length)

loop_sequence_range : `integer`[]

{} or Range(sequence start, sequence end)

loop_pattern : `boolean`

Pattern Loop On/Off

loop_pattern_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_block_enabled : `boolean`

Block Loop On/Off

loop_block_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_block_range_coeff : `integer`

Range: (2 - 16)

loop_block_range_coeff_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

loop_block_start_pos : `renoise.SongPos`

Start of block loop

edit_mode : `boolean`

Pattern edit/record mode On/Off

edit_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

edit_step : `integer`

Range: (0 - 64)

edit_step_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

octave : `integer`

Range: (0 - 8)

octave_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

octave_enabled : `boolean`

Enabled for MIDI keyboards

octave_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_enabled : `boolean`

Metronome playback On/Off

metronome_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_beats_per_bar : `integer`

Range: (1 - 16) or 0 = guess from pattern length

metronome_beats_per_bar_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_lines_per_beat : `integer`

Range: (1 - 256) or 0 = songs current LPB

metronome_lines_per_beat_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_precount_enabled : `boolean`

Metronome precount playback On/Off

metronome_precount_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_precount_bars : `integer`

Range: (1 - 4)

metronome_precount_bars_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

metronome_volume : `number`

Range: (0 - math.db2lin(6))

metronome_volume_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

record_quantize_enabled : `boolean`

Record note quantization On/Off

record_quantize_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

record_quantize_lines : `integer`

Range: (1 - 32)

record_quantize_lines_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

record_parameter_mode : `renoise.Transport.RecordParameterMode`

Record parameter

record_parameter_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

follow_player : `boolean`

Follow, wrapped pattern, single track modes

follow_player_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

wrapped_pattern_edit : `boolean`

wrapped_pattern_edit_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

single_track_edit_mode : `boolean`

single_track_edit_mode_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

groove_enabled : `boolean`

Groove (aka Shuffle)

groove_enabled_observable : `renoise.Document.Observable`

Track changes to document properties or general states by attaching listener functions to it.

groove_amounts : `number`[]

table with 4 numbers in Range: (0 - 1)

groove_assignment_observable : `renoise.Document.Observable`

Will be called as soon as any groove value changed.

track_headroom : `number`

Global Track Headroom To convert to dB: dB = math.lin2db(renoise.Transport.track_headroom) To convert from dB: renoise.Transport.track_headroom = math.db2lin(dB) Range: (math.db2lin(-12) - math.db2lin(0))