SPB Git

Repository Public

quickstart.md 4.2 KB

# Quick Start

This chapter gets you from nothing to a working automation in a few minutes. It assumes a track is playing on deck A and another one is loaded on deck B.

# 1. Try one line in the console

The console runs ORIX Script one line at a time. Type a parameter path to read it, or an assignment to change it.

console
> deck.A.volume
0 dB
> deck.A.volume = -8dB
OK
> deck.A.volume
-8 dB
> deck.A.volume = 0dB
OK

A path is the address of a control. deck.A.volume is the channel fader of deck A; mixer.crossfader is the crossfader; fx.echo.mix is the wet/dry knob of the echo in the master rack.

Actions are written with parentheses:

console
> deck.B.play()
OK
> deck.B.pause()
OK

Ask the console about any path:

console
> help deck.A.filter.highpass
deck.A.filter.highpass: frequency
Channel high-pass corner. 20 Hz is off.
Range: 20 Hz … 20000 Hz
Default: 20 Hz

# 2. Write a script

A script puts statements inside an automation. The name in quotes is how you start it later.

orixdj
automation "My First Fade" {
    over 4 bars {
        deck.A.volume -> -60dB
    }
    deck.A.pause()
    deck.A.volume = 0dB
}

Three ideas are enough to read it:

You write It means
path = value Set the control now.
path -> value inside over Move the control smoothly to the value during the over time.
path() Do the action now.

Statements run in order. over 4 bars { … } takes four bars, so deck.A.pause() happens four bars after the start.

# 3. Start on the bar

Add quantize bar after the name and the automation waits for the next bar line of the master clock before it does anything. You can then start it a little early and it still lands on the one.

orixdj
automation "Fade On The Bar" quantize bar {
    over 4 bars { deck.A.volume -> -60dB }
    deck.A.pause()
    deck.A.volume = 0dB
}

# 4. Wait

wait lets time pass. Durations are written the way you would say them.

orixdj
deck.A.eq.low = -26dB
wait 2 bars
deck.A.eq.low = 0dB
Duration Meaning
1beat, 4 beats Beats of the master clock.
1bar, 8 bars Bars; one bar is 4 beats.
1/2beat, 3/4beat A fraction of a beat.
500ms, 2s, 1min Clock time; converted to beats with the current tempo.

# 5. Use an effect

Effects in the master rack are fx.<name>; effects on a channel are deck.X.fx.<name>. Set the parameters, switch the effect on with enable(), and switch it off with disable() when you are done.

orixdj
fx.echo.time = 3/4beat
fx.echo.feedback = 0.5
fx.echo.mix = 0.4
fx.echo.enable()
wait 2 bars
fx.echo.disable()

# 6. Run it

  • From the console, run "My First Fade" starts a saved automation (or a preset) by name.
  • status shows what is running; stop stops everything that is running.
  • panic is the emergency stop: every automation stops and every effect is bypassed. The decks keep playing.
console
> run "Filter Sweep"
Automation scheduled (run 1)
> stop
Stopped 1 automation

# 7. When something is wrong

The compiler refuses a script that contains a mistake, and tells you where and why.

orixdj-error
deck.A.volum = -6dB
text
Unknown deck parameter 'volum' in 'deck.A.volum'. Did you mean 'volume'? [E-PATH]

Nothing has run at that point. Correct the line and try again. Every code is explained in Error Handling.

# Cheat sheet

orixdj
automation "Cheat Sheet" quantize bar {
    // set, read, act
    deck.B.volume = -6dB
    let tempo = master.bpm
    deck.B.play()

    // wait and ramp
    wait 1 bar
    over 2 bars curve smooth { mixer.crossfader -> 1 }

    // decide
    if deck.A.playing {
        deck.A.pause()
    }

    // repeat
    repeat 4 {
        deck.B.eq.high = -12dB
        wait 1/2beat
        deck.B.eq.high = 0dB
        wait 1/2beat
    }

    // schedule at a position, counted from the start of the automation
    at bar 6 { mixer.crossfader = 0.5 }

    print("tempo was", tempo)
}
Files main
Menu

Theme