Renoise OSC API
This file documents the API exposed in Renoise ^3.0.1.
v3.0
RenoiseOSC.luaeval — Functionluaeval(expr::AbstractString)Evaluate a Lua expression inside Renoise's scripting environment.
Example
luaeval("renoise.song().transport.bpm = 132")RenoiseOSC.tempo — Functiontempo(bpm::Integer)Set the song's current bpm value. The valid tempo range is 32:999 for <v3.4, 20:999 for >=v3.4.
RenoiseOSC.editmode — Functioneditmode(on::Bool)Set the song's global edit mode on or off.
RenoiseOSC.octave — Functionoctave(oct::Integer)Sets the song's current octave 0:8.
RenoiseOSC.patternfollow — Functionpatternfollow(on::Bool)Enable or disable the global pattern follow mode.
RenoiseOSC.editstep — Functioneditstep(step::Integer)Set the song's current edit step [0:8].
RenoiseOSC.linesperbeat — Functionlinesperbeat(lpb::Integer)Set the song's current lines per beat 1:255.
RenoiseOSC.metronome — Functionmetronome(on::Bool)Enable or disable the metronome.
RenoiseOSC.metronomeprecount — Functionmetronomeprecount(on::Bool)Enable or disable the global metronome precount.
RenoiseOSC.quantization — Functionquantization(on::Bool)Enable or disable the global record quantization.
RenoiseOSC.quantizationstep — Functionquantizationstep(step::Integer)Set the global record quantization step 1:32.
RenoiseOSC.scheduleadd — Functionscheduleadd(sequence::Integer)Add a scheduled sequence playback position.
RenoiseOSC.scheduleset — Functionscheduleset(sequence::Integer)Replace the current scheduled sequence playback position.
RenoiseOSC.slotmute — Functionslotmute(track::Integer, sequence::Integer)
slotmute(mute::Bool, track::Integer, sequence::Integer)Mute the specified track at the specified sequence slot in the matrix.
RenoiseOSC.slotunmute — Functionslotunmute(track::Integer, sequence::Integer)Unmute the specified track at the specified sequence slot in the matrix.
RenoiseOSC.trigger — Functiontrigger(sequence::Integer)Set playback pos to the specified sequence position.
RenoiseOSC.bypass — Functionbypass(bypassed::Bool; track::Integer=-1, device::Integer=-1)Enable or disable the bypassing of an effect device, set true to bypass the device. When unspecified, track and device default to the currently selected track and device.
RenoiseOSC.setparam — Functionsetparam(key::Union{AbstractString,Integer}, value::Real; track::Integer=-1, device::Integer=-1)Set the parameter of any effect device by its name or index. value is clamped between 0.0 and 1.0. When unspecified, track and device default to the currently selected track and device.
RenoiseOSC.outputdelay — Functionoutputdelay(δt::Real; track::Integer)Set the given track's pre-FX output delay in milliseconds [-100:100]. Default to the currently selected track.
RenoiseOSC.postfxpanning — Functionpostfxpanning(pan::Integer; track::Integer=-1)Set track's post-FX panning, -50:50 left to right. Default to the currently selected track.
RenoiseOSC.postfxvolume — Functionpostfxvolume(level::Real; track::Integer=-1)Set tracks post-FX volume, 0.0:db2lin(6.0), -Inf:+6dB. Default to the currently selected track.
RenoiseOSC.postfxvolumedb — Functionpostfxvolumedb(level::Real; track::Integer=-1)Set tracks post-FX volume in decibels, -200.0:3.0. Default to the currently selected track.
RenoiseOSC.prefxpanning — Functionprefxpanning(pan::Integer; track::Integer=-1)Set track's pre-FX panning, [-50:50] left to right. Default to the currently selected track.
RenoiseOSC.prefxvolume — Functionprefxvolume(level::Real; track::Integer=-1)Set tracks pre-FX volume, [0.0:db2lin(6.0)], -Inf:+6dB. Default to the currently selected track.
RenoiseOSC.prefxvolumedb — Functionprefxvolumedb(level::Real; track::Integer=-1)Set tracks pre-FX volume in decibels, -200.0:3.0. Default to the currently selected track.
RenoiseOSC.prefxwidth — Functionprefxwidth(width::Real; track::Integer=-1)Set track's pre-FX width 0.0:1.0. Default to the currently selected track.
RenoiseOSC.solo — Functionsolo(; track::Integer)Toggle solo for the given track. Default to the currently selected track.
RenoiseOSC.mute — Functionmute(muted::Bool = true; track::Integer = -1)Mute the given track. Default to the currently selected track.
RenoiseOSC.unmute — Functionunmute(; track::Integer=-1)
mute(false; track::Integer=-1)Unmute the given track. Default to the currently selected track.
RenoiseOSC.panic — Functionpanic()Stop playback and reset all playing instruments and DSPs
RenoiseOSC.resume — Functionresume()Continue playback. Called continue in the Renoise docs, but this name can't be used as continue is a reserved word in Julia.
RenoiseOSC.start — Functionstart()Start song playback or restart playing the current pattern.
RenoiseOSC.stop — Functionstop()Stop song playback.
RenoiseOSC.midievent — Functionmidievent(portid::UInt8, status::UInt8, data1::UInt8, data2::UInt8)
midievent(event::Union{UInt32,UInt64,Array{<:Integer},NTuple{4,<:Integer}})Fire a raw MIDI event.
RenoiseOSC.noteon — Functionnoteon(pitch::Integer, velocity::Integer; instrument::Integer=-1, track::Integer=-1)Turn on the note with the velocity. Default to the currently selected instrument and track.
RenoiseOSC.noteoff — Functionnoteoff(pitch::Integer, velocity::Integer; instrument::Integer=-1, track::Integer=-1)Trigger a note off.
v3.3
Below are the functions added between Renoise 3.0.1 and 3.3.0.
RenoiseOSC.setmacroparam — Functionsetmacroparam(param::Integer, value::Real; instrument::Integer = -1)Set instrument's macro parameter value 0.0:1.0. Defaults to the currently selected instrument and macro 1.
RenoiseOSC.monophonic — Functionmonophonic(mono::Bool; instrument::Integer=-1)Enable or disable instrument's mono mode. Default to the currently selected instrument.
RenoiseOSC.monophonicglide — Functionmonophonicglide(glide::Integer; instrument::Integer=-1)Set instrument's glide amount 0:255. Default to the currently selected instrument.
RenoiseOSC.phraseplayback — Functionphraseplayback(mode::AbstractString; instrument::Integer=-1)Set instrument's phrase playback mode ["Off", "Program", "Keymap"] Default to the currently selected instrument.
RenoiseOSC.phraseprogram — Functionphraseprogram(program::Integer; instrument::Integer=-1)Set instrument's phrase program number 0:127. Default to the currently selected instrument.
RenoiseOSC.quantizationmode — Functionquantizationmode(mode::AbstractString; instrument::Integer=-1)Set instrument's quantization method, one of "None", "Line", "Beat", "Bar". Default to the currently selected instrument.
RenoiseOSC.scalekey — Functionscalekey(key::AbstractString; instrument::Integer=-1)Set instrument's note scaling key ["C", "C#"..., "B"]. Default to the currently selected instrument.
RenoiseOSC.scalemode — Functionscalemode(mode::AbstractString; instrument::Integer=-1)Set instrument's note scaling mode. Default to the currently selected instrument.
RenoiseOSC.transpose — Functiontranspose(pitch::Integer; instrument::Integer=-1)Set instrument's global pitch transpose -120:120. Default to the currently selected instrument.
RenoiseOSC.volume — Functionvolume(level::Real; instrument::Integer=-1)Set instrument's global volume to level [0.0:db2lin(6)]≈[0.0:2.0]. Default to the currently selected instrument.
RenoiseOSC.volumedb — Functionvolumedb(level::Real; instrument::Integer=-1)Set instrument's global volume to level in decibels [0.0:6.0]. Default to the currently selected instrument.
RenoiseOSC.ticksperline — Functionticksperline(tpl::Integer)Set the song's current ticks per line 1:16.
RenoiseOSC.loopblock — Functionloopblock(loop::Bool)Enable or disable pattern block loop.
RenoiseOSC.loopblockmovebackwards — Functionloopblockmovebackwards()Move the block loop one segment backwards.
RenoiseOSC.loopblockmoveforwards — Functionloopblockmoveforwards()Move the block loop one segment forwards.
RenoiseOSC.looppattern — Functionlooppattern(loop::Bool)Enable or disable looping the current pattern.
v3.4
Below are functions added in v3.4.
loopsequence