Effects commands
This chapter is generated from the language schema (
swift run orix-dj-bench docs). Do not edit it by hand.
Racks
fx.<effect> addresses the master rack. deck.X.fx.<effect> addresses the rack of a channel. A rack holds at most one unit of each effect and eight units in total. Writing a parameter of an effect that is not in the rack adds it, switched off.
Actions
| Action | Arguments | Description |
|---|---|---|
fx.<effect>.enable() |
– | Adds the effect to the rack when needed and switches it on. |
fx.<effect>.disable() |
– | Switches the effect off (it stays in the rack). |
fx.<effect>.toggle() |
– | Switches the effect on or off. |
Reverb — fx.reverb
Algorithmic room reverb (feedback comb and all-pass network).
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.reverb.size |
number | 0 … 1 | 0.55 |
read, write, ramp | Room size: longer decay as it grows. |
fx.reverb.damping |
number | 0 … 1 | 0.45 |
read, write, ramp | High-frequency absorption inside the tail. |
fx.reverb.predelay |
duration | 0 … 200 ms | 15ms |
read, write | Gap before the first reflections. |
fx.reverb.width |
number | 0 … 1 | 1 |
read, write, ramp | Stereo spread of the tail. |
fx.reverb.mix |
number | 0 … 1 | 0.3 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.reverb.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Delay — fx.delay
Clean beat-synchronised stereo delay.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.delay.time |
duration | 0.062 … 4 beats | 0.5beats |
read, write | Delay length in beats. Seconds are converted with the current tempo. |
fx.delay.feedback |
number | 0 … 0.95 | 0.35 |
read, write, ramp | Amount of the delayed signal fed back. |
fx.delay.pingpong |
bool | true / false | false |
read, write | Alternate repeats between left and right. |
fx.delay.mix |
number | 0 … 1 | 0.25 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.delay.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Echo — fx.echo
Tape-style echo: repeats get darker through a low-pass in the feedback path.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.echo.time |
duration | 0.062 … 4 beats | 0.75beats |
read, write | Echo length in beats. Seconds are converted with the current tempo. |
fx.echo.feedback |
number | 0 … 0.95 | 0.5 |
read, write, ramp | Amount of each repeat fed back. |
fx.echo.tone |
frequency | 200 Hz … 12000 Hz | 4kHz |
read, write, ramp | Low-pass applied to every repeat. |
fx.echo.mix |
number | 0 … 1 | 0.35 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.echo.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Flanger — fx.flanger
Short modulated delay with feedback (jet sweep).
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.flanger.rate |
frequency | 0.02 Hz … 5 Hz | 0.25Hz |
read, write, ramp | Sweep speed. |
fx.flanger.depth |
number | 0 … 1 | 0.7 |
read, write, ramp | Sweep range. |
fx.flanger.feedback |
number | -0.95 … 0.95 | 0.5 |
read, write, ramp | Resonance of the comb; negative inverts it. |
fx.flanger.mix |
number | 0 … 1 | 0.5 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.flanger.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Phaser — fx.phaser
Six-stage all-pass phaser.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.phaser.rate |
frequency | 0.02 Hz … 5 Hz | 0.4Hz |
read, write, ramp | Sweep speed. |
fx.phaser.depth |
number | 0 … 1 | 0.8 |
read, write, ramp | Sweep range. |
fx.phaser.feedback |
number | 0 … 0.9 | 0.5 |
read, write, ramp | Notch resonance. |
fx.phaser.mix |
number | 0 … 1 | 0.5 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.phaser.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Chorus — fx.chorus
Three-voice stereo chorus.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.chorus.rate |
frequency | 0.05 Hz … 5 Hz | 0.8Hz |
read, write, ramp | Modulation speed. |
fx.chorus.depth |
number | 0 … 1 | 0.5 |
read, write, ramp | Pitch modulation amount. |
fx.chorus.mix |
number | 0 … 1 | 0.5 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.chorus.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Distortion — fx.distortion
Soft-clipping overdrive with tone control and level compensation.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.distortion.drive |
gain | 0 dB … 36 dB | 12dB |
read, write, ramp | Gain into the clipper. |
fx.distortion.tone |
frequency | 500 Hz … 16000 Hz | 8kHz |
read, write, ramp | Low-pass after the clipper. |
fx.distortion.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.distortion.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Bitcrusher — fx.bitcrusher
Bit-depth and sample-rate reduction.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.bitcrusher.bits |
number | 2 … 16 | 8 |
read, write, ramp | Quantisation depth. |
fx.bitcrusher.downsample |
number | 1 … 40 | 4 |
read, write, ramp | Sample-and-hold factor. |
fx.bitcrusher.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.bitcrusher.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
High-pass — fx.highpass
Resonant 12 dB/octave high-pass filter.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.highpass.cutoff |
frequency | 20 Hz … 20000 Hz | 200Hz |
read, write, ramp | Corner frequency. |
fx.highpass.resonance |
number | 0.5 … 10 | 0.707 |
read, write, ramp | Filter Q. |
fx.highpass.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.highpass.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Low-pass — fx.lowpass
Resonant 12 dB/octave low-pass filter.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.lowpass.cutoff |
frequency | 20 Hz … 20000 Hz | 8kHz |
read, write, ramp | Corner frequency. |
fx.lowpass.resonance |
number | 0.5 … 10 | 0.707 |
read, write, ramp | Filter Q. |
fx.lowpass.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.lowpass.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Band-pass — fx.bandpass
Resonant band-pass filter.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.bandpass.cutoff |
frequency | 20 Hz … 20000 Hz | 1kHz |
read, write, ramp | Centre frequency. |
fx.bandpass.resonance |
number | 0.5 … 10 | 1.2 |
read, write, ramp | Filter Q (narrower as it grows). |
fx.bandpass.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.bandpass.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Tremolo — fx.tremolo
Beat-locked amplitude modulation.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.tremolo.rate |
duration | 0.031 … 4 beats | 0.25beats |
read, write | Length of one cycle in beats. Seconds are converted with the current tempo. |
fx.tremolo.depth |
number | 0 … 1 | 0.8 |
read, write, ramp | Modulation depth. |
fx.tremolo.shape |
number | 0 … 1 | 0 |
read, write, ramp | 0 = sine, 1 = square. |
fx.tremolo.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.tremolo.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Auto-pan — fx.autopan
Beat-locked left/right panning.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.autopan.rate |
duration | 0.031 … 8 beats | 1beat |
read, write | Length of one cycle in beats. Seconds are converted with the current tempo. |
fx.autopan.depth |
number | 0 … 1 | 1 |
read, write, ramp | Pan range. |
fx.autopan.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.autopan.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Beat Gate — fx.gate
Rhythmic gate locked to the beat grid.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.gate.rate |
duration | 0.031 … 4 beats | 0.25beats |
read, write | Length of one gate cycle in beats. Seconds are converted with the current tempo. |
fx.gate.duty |
number | 0.05 … 0.95 | 0.5 |
read, write, ramp | Open fraction of each cycle. |
fx.gate.depth |
number | 0 … 1 | 1 |
read, write, ramp | Attenuation while closed. |
fx.gate.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.gate.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Compressor — fx.compressor
Feed-forward stereo-linked compressor.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.compressor.threshold |
gain | -60 dB … 0 dB | -18dB |
read, write, ramp | Level above which gain reduction starts. |
fx.compressor.ratio |
number | 1 … 20 | 4 |
read, write, ramp | Compression ratio n:1. |
fx.compressor.attack |
duration | 0.1 … 200 ms | 10ms |
read, write | Attack time. |
fx.compressor.release |
duration | 10 … 2000 ms | 150ms |
read, write | Release time. |
fx.compressor.makeup |
gain | 0 dB … 24 dB | 0dB |
read, write, ramp | Gain applied after compression. |
fx.compressor.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.compressor.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Limiter — fx.limiter
Look-ahead peak limiter.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.limiter.ceiling |
gain | -24 dB … 0 dB | -1dB |
read, write, ramp | Maximum output peak. |
fx.limiter.release |
duration | 10 … 1000 ms | 100ms |
read, write | Recovery time. |
fx.limiter.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.limiter.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Beat Repeat — fx.beatrepeat
Captures the last slice and repeats it while enabled.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.beatrepeat.length |
duration | 0.031 … 4 beats | 0.25beats |
read, write | Slice length in beats. Seconds are converted with the current tempo. |
fx.beatrepeat.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.beatrepeat.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |
Noise Sweep — fx.noise
Filtered white noise added to the signal, for risers and sweeps.
| Path | Type | Range | Default | Access | Description |
|---|---|---|---|---|---|
fx.noise.level |
gain | -60 dB … 0 dB | -18dB |
read, write, ramp | Noise level. |
fx.noise.cutoff |
frequency | 100 Hz … 16000 Hz | 1kHz |
read, write, ramp | Band-pass centre of the noise. |
fx.noise.resonance |
number | 0.5 … 10 | 2 |
read, write, ramp | Sharpness of the noise band. |
fx.noise.mix |
number | 0 … 1 | 1 |
read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |
fx.noise.enabled |
bool | true / false | false |
read, write | True while the effect is switched on. |