renoise.Transport

Transport component of the Renoise song.

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,
}

Properties

playing : boolean

Playing

playing_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_start_pos : renoise.SongPos

Start of block loop

loop_block_range_coeff : integer

Range: (2 - 16)

edit_mode : boolean

Edit modes

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.

metronome_enabled : boolean

Metronome

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)

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

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.

record_quantize_enabled : boolean

Quantize

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

Attach notifiers that will be called as soon as any groove value changed.

track_headroom : number

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

track_headroom_observable : renoise.Document.Observable

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

keyboard_velocity_enabled : boolean

Computer Keyboard Velocity.

keyboard_velocity_enabled_observable : renoise.Document.Observable

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

keyboard_velocity : integer

Range: (0 - 127)

keyboard_velocity_observable : renoise.Document.Observable

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

Functions

panic(self)

Panic.

start(self, mode : renoise.Transport.PlayMode)

Start playing in song or pattern mode.

start_at(self, line : integer)

Start playing the currently edited pattern at the given line offset

start_at(self, song_pos : renoise.SongPos)

Start playing a the given renoise.SongPos (sequence pos and line)

stop(self)

Stop playing. When already stopped this just stops all playing notes.

trigger_sequence(self, sequence_pos : integer)

Immediately start playing at the given sequence position.

add_scheduled_sequence(self, sequence_pos : integer)

Append the sequence to the scheduled sequence list. Scheduled playback positions will apply as soon as the currently playing pattern play to end.

set_scheduled_sequence(self, sequence_pos : integer)

Replace the scheduled sequence list with the given sequence.

loop_block_move_forwards(self)

Move the block loop one segment forwards, when possible.

loop_block_move_backwards(self)

Move the block loop one segment backwards, when possible.

start_stop_sample_recording(self)

Start a new sample recording when the sample dialog is visible, otherwise stop and finish it.

cancel_sample_recording(self)

Cancel a currently running sample recording when the sample dialog is visible, otherwise do nothing.