Console Usage
The console is a command line for the live rig. Type a line, press Return, and it acts on the decks, the mixer and the effects at once. It accepts two kinds of input: ORIX Script, and a small set of console commands.
Script lines
Any statement that is valid inside an automation can be typed in the console.
> deck.B.volume = -8dB
OK
> deck.B.play()
OK
> fx.echo.enable()
OK
> fx.echo.disable()
OKOK means the line was compiled and executed completely, without printing anything.
Reading values
A line that is only an expression prints its value. This is the quickest way to look at the state of the rig.
> deck.B.volume
-8 dB
> master.bpm
128
> deck.A.playing
true
> deck.A.remaining
240 s
> master.deck
A
> 4 bars + 2 beats
18 beats
> min(3, 4) + 1
4
> toSeconds(8 bars)
15A call to a builtin or to a value function typed alone prints its result, like any other expression.
print(…) works too and can show several values:
> print("A:", deck.A.bpm, "B:", deck.B.bpm)
A: 128 B: 128Lines that take time
A line may contain timing statements. If it is not finished at once, the console answers Automation scheduled with a run number, and the line carries on as a running automation named console.
> over 4 bars { deck.A.filter.highpass -> 2kHz }
Automation scheduled (run 3)
> wait nextBar; deck.B.play()
Automation scheduled (run 4)
> at nextBar { deck.A.filter.highpass = 20Hz }
Automation scheduled (run 5)Several statements can be written on one line separated by semicolons, and blocks can be written on one line with braces.
> deck.B.sync(true); deck.B.volume = -60dB; deck.B.play()
OK
> repeat 4 { deck.A.eq.high = -26dB; wait 1/2beat; deck.A.eq.high = 0dB; wait 1/2beat }
Automation scheduled (run 6)
> if deck.B.playing { print("B is playing") } else { print("B is paused") }
B is playingWhat is different from a script file
- Each line is its own automation. A variable declared on one line does not exist on the next. Put everything that belongs together on one line, or save a script.
- No quantizing. A console line starts immediately. Use
wait nextBarorat nextBar { … }to land on the grid. fnandautomationcannot be usefully typed in the console. Write them in a script and start it withrun.- Some words are commands first. A line that begins with one of the command words below is taken as that command, not as script. In particular
stoptyped alone is the console command that stops running automations, andfxtyped alone lists the racks. A script line that starts withfx.(for examplefx.echo.enable()) is still script, because the word is followed by a dot.
Errors
A line with a mistake is refused and nothing runs. The console shows the message and the code.
For example, typing deck.Z.play() and then deck.A.volume = 20Hz gives:
Unknown deck 'Z'. Decks are A, B, C and D. [E-DECK]
'deck.A.volume' expects gain, not frequency. Write a gain such as -6dB. [E-TYPE]An error that occurs while the line runs is shown the same way:
> deck.A.eject()
Deck A is playing; pause it before ejecting. [E-ACTION]Warnings produced while the line runs are shown as information lines.
Console commands
| Command | What it does |
|---|---|
help |
Lists the console commands. |
help <path> |
Shows the reference entry for a path, an action, an event, an effect or a builtin function. |
list |
Lists the saved automations, then the bundled presets. |
run "Name" |
Compiles and starts a saved automation or a preset. |
stop |
Stops every running automation. |
stop all |
The same. |
stop "Name" |
Stops the running automations with that name. |
pause |
Freezes every running automation. |
pause "Name" |
Freezes the running automations with that name. |
resume, resume "Name" |
Resumes paused automations. |
status |
Shows the master clock and the running automations. |
decks |
Shows the state of every deck. |
fx |
Shows the effects in every rack. |
trigger <n> |
Fires automation trigger n (1 to 16). |
panic |
Emergency stop: stops every automation and bypasses every effect. |
clear |
Clears the console. |
version |
Shows the ORIX Script version. |
Command words are not case-sensitive. The quotes around a name are optional.
help
> help deck.A.volume
deck.A.volume: gain
Channel fader. -60 dB is silence. A plain number or percentage is taken as a linear fader position.
Range: -60 dB … 0 dB
Default: 0 dB
> help deck.A.loop
deck.A.loop(length: duration)
Starts a loop of the given length at the playhead.
length: Loop length, e.g. 4beats.
> help fx.delay
Delay: Clean beat-synchronised stereo delay.
Parameters: time, feedback, pingpong, mix, enabled
Actions: enable(), disable(), toggle()
> help lerp
lerp(a, b, t: number) -> same type
Linear interpolation between a and b.A topic that is not in the reference gives an error line:
> help deck.A.wobble
No reference entry for 'deck.A.wobble'. Try a path such as deck.A.volume or fx.delay. list and run
> list
My Bass Swap
Eight Bar Transition
Bass Swap
Harmonic Transition
> run "My Bass Swap"
Automation scheduled (run 7)list shows your saved automations first, then the presets that you have not replaced by a script of the same name (the transcript above is shortened).
run compiles the script before starting it. If it does not compile, nothing runs and the first errors are shown with their line:
line 4: Unknown deck parameter 'volum' in 'deck.A.volum'. Did you mean 'volume'? [E-PATH]If the saved script contains several automations, run "Name" starts the automation of that name when there is one, and otherwise the first automation of the file. An unknown name gives:
> run "No Such Thing"
No saved automation named "No Such Thing". Type 'list' to see them.An automation started with run respects its own quantize setting.
status
> status
Clock: beat 412.25, 128.00 BPM, master deck A
#7 "My Bass Swap" running, beat 6.2 of 32, 1 pending, 1 ramps
> stop "My Bass Swap"
Stopped 1 automation
> status
Clock: beat 431.50, 128.00 BPM, master deck A
No automation is running.For each automation: its run number, name and state (running or paused), its position in beats (and its total length when the compiler could determine it), the number of pending tasks and the number of active ramps. When no deck drives the clock, the first line ends with master free-running.
decks and fx
> decks
Deck A: playing "Night Drive" 62.4 s / 301.0 s, 128.00 BPM, master
Deck B: paused "Solar Wind" 0.0 s / 284.6 s, 126.00 BPM, sync
Deck C: empty
Deck D: empty
> fx
Master: echo → reverb (on)
Deck A: gatefx lists each rack that contains effects, in chain order, with (on) after those that are switched on. With nothing in any rack it prints Every rack is empty.
trigger
> trigger 1
Trigger 1 firedThis is the same as hitting a pad mapped to "Automation trigger 1". Every running automation that has an on trigger(1) handler runs it. If no automation is listening, nothing happens. See MIDI Integration.
pause, resume, stop
> pause
Paused
> resume
Resumed
> stop
Stopped 2 automationsStopping does not put controls back. See Automation Scheduling.
panic
> panic
Emergency stop: automations stopped, effects bypassedEvery automation stops and every effect in every rack is bypassed. Decks keep playing; faders, EQ and filters are not touched.
Recipes
Check that a transition can start:
> print(deck.A.playing, deck.B.loaded, deck.B.playing, deck.B.trackBpm)
true true false 126A one-line fade-out on the next bar:
> wait nextBar; over 4 bars { deck.A.volume -> -60dB }; deck.A.pause(); deck.A.volume = 0dB
Automation scheduled (run 8)A quick echo throw:
> fx.echo.mix = 0.7; fx.echo.enable(); wait 1 beat; fx.echo.mix = 0; wait 2 bars; fx.echo.disable()
Automation scheduled (run 9)Put a channel back after an interrupted script:
> deck.A.volume = 0dB; deck.A.eq.low = 0dB; deck.A.eq.mid = 0dB; deck.A.eq.high = 0dB; deck.A.filter.highpass = 20Hz; deck.A.filter.lowpass = 20kHz
OKHow many bars are left on deck A:
> print(floor(toBeats(deck.A.remaining) / 4))
112