SPB Git

Repository Public

effects-api.md 12.6 KB 226 lines markdown

1# Effects commands23> This chapter is generated from the language schema (`swift run orix-dj-bench docs`). Do not edit it by hand.45## Racks67`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.89## Actions1011| Action | Arguments | Description |12| --- | --- | --- |13| `fx.<effect>.enable()` | – | Adds the effect to the rack when needed and switches it on. |14| `fx.<effect>.disable()` | – | Switches the effect off (it stays in the rack). |15| `fx.<effect>.toggle()` | – | Switches the effect on or off. |1617## Reverb — `fx.reverb`1819Algorithmic room reverb (feedback comb and all-pass network).2021| Path | Type | Range | Default | Access | Description |22| --- | --- | --- | --- | --- | --- |23| `fx.reverb.size` | number | 0 … 1 | `0.55` | read, write, ramp | Room size: longer decay as it grows. |24| `fx.reverb.damping` | number | 0 … 1 | `0.45` | read, write, ramp | High-frequency absorption inside the tail. |25| `fx.reverb.predelay` | duration | 0 … 200 ms | `15ms` | read, write | Gap before the first reflections. |26| `fx.reverb.width` | number | 0 … 1 | `1` | read, write, ramp | Stereo spread of the tail. |27| `fx.reverb.mix` | number | 0 … 1 | `0.3` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |28| `fx.reverb.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |2930## Delay — `fx.delay`3132Clean beat-synchronised stereo delay.3334| Path | Type | Range | Default | Access | Description |35| --- | --- | --- | --- | --- | --- |36| `fx.delay.time` | duration | 0.062 … 4 beats | `0.5beats` | read, write | Delay length in beats. Seconds are converted with the current tempo. |37| `fx.delay.feedback` | number | 0 … 0.95 | `0.35` | read, write, ramp | Amount of the delayed signal fed back. |38| `fx.delay.pingpong` | bool | true / false | `false` | read, write | Alternate repeats between left and right. |39| `fx.delay.mix` | number | 0 … 1 | `0.25` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |40| `fx.delay.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |4142## Echo — `fx.echo`4344Tape-style echo: repeats get darker through a low-pass in the feedback path.4546| Path | Type | Range | Default | Access | Description |47| --- | --- | --- | --- | --- | --- |48| `fx.echo.time` | duration | 0.062 … 4 beats | `0.75beats` | read, write | Echo length in beats. Seconds are converted with the current tempo. |49| `fx.echo.feedback` | number | 0 … 0.95 | `0.5` | read, write, ramp | Amount of each repeat fed back. |50| `fx.echo.tone` | frequency | 200 Hz … 12000 Hz | `4kHz` | read, write, ramp | Low-pass applied to every repeat. |51| `fx.echo.mix` | number | 0 … 1 | `0.35` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |52| `fx.echo.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |5354## Flanger — `fx.flanger`5556Short modulated delay with feedback (jet sweep).5758| Path | Type | Range | Default | Access | Description |59| --- | --- | --- | --- | --- | --- |60| `fx.flanger.rate` | frequency | 0.02 Hz … 5 Hz | `0.25Hz` | read, write, ramp | Sweep speed. |61| `fx.flanger.depth` | number | 0 … 1 | `0.7` | read, write, ramp | Sweep range. |62| `fx.flanger.feedback` | number | -0.95 … 0.95 | `0.5` | read, write, ramp | Resonance of the comb; negative inverts it. |63| `fx.flanger.mix` | number | 0 … 1 | `0.5` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |64| `fx.flanger.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |6566## Phaser — `fx.phaser`6768Six-stage all-pass phaser.6970| Path | Type | Range | Default | Access | Description |71| --- | --- | --- | --- | --- | --- |72| `fx.phaser.rate` | frequency | 0.02 Hz … 5 Hz | `0.4Hz` | read, write, ramp | Sweep speed. |73| `fx.phaser.depth` | number | 0 … 1 | `0.8` | read, write, ramp | Sweep range. |74| `fx.phaser.feedback` | number | 0 … 0.9 | `0.5` | read, write, ramp | Notch resonance. |75| `fx.phaser.mix` | number | 0 … 1 | `0.5` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |76| `fx.phaser.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |7778## Chorus — `fx.chorus`7980Three-voice stereo chorus.8182| Path | Type | Range | Default | Access | Description |83| --- | --- | --- | --- | --- | --- |84| `fx.chorus.rate` | frequency | 0.05 Hz … 5 Hz | `0.8Hz` | read, write, ramp | Modulation speed. |85| `fx.chorus.depth` | number | 0 … 1 | `0.5` | read, write, ramp | Pitch modulation amount. |86| `fx.chorus.mix` | number | 0 … 1 | `0.5` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |87| `fx.chorus.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |8889## Distortion — `fx.distortion`9091Soft-clipping overdrive with tone control and level compensation.9293| Path | Type | Range | Default | Access | Description |94| --- | --- | --- | --- | --- | --- |95| `fx.distortion.drive` | gain | 0 dB … 36 dB | `12dB` | read, write, ramp | Gain into the clipper. |96| `fx.distortion.tone` | frequency | 500 Hz … 16000 Hz | `8kHz` | read, write, ramp | Low-pass after the clipper. |97| `fx.distortion.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |98| `fx.distortion.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |99100## Bitcrusher — `fx.bitcrusher`101102Bit-depth and sample-rate reduction.103104| Path | Type | Range | Default | Access | Description |105| --- | --- | --- | --- | --- | --- |106| `fx.bitcrusher.bits` | number | 2 … 16 | `8` | read, write, ramp | Quantisation depth. |107| `fx.bitcrusher.downsample` | number | 1 … 40 | `4` | read, write, ramp | Sample-and-hold factor. |108| `fx.bitcrusher.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |109| `fx.bitcrusher.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |110111## High-pass — `fx.highpass`112113Resonant 12 dB/octave high-pass filter.114115| Path | Type | Range | Default | Access | Description |116| --- | --- | --- | --- | --- | --- |117| `fx.highpass.cutoff` | frequency | 20 Hz … 20000 Hz | `200Hz` | read, write, ramp | Corner frequency. |118| `fx.highpass.resonance` | number | 0.5 … 10 | `0.707` | read, write, ramp | Filter Q. |119| `fx.highpass.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |120| `fx.highpass.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |121122## Low-pass — `fx.lowpass`123124Resonant 12 dB/octave low-pass filter.125126| Path | Type | Range | Default | Access | Description |127| --- | --- | --- | --- | --- | --- |128| `fx.lowpass.cutoff` | frequency | 20 Hz … 20000 Hz | `8kHz` | read, write, ramp | Corner frequency. |129| `fx.lowpass.resonance` | number | 0.5 … 10 | `0.707` | read, write, ramp | Filter Q. |130| `fx.lowpass.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |131| `fx.lowpass.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |132133## Band-pass — `fx.bandpass`134135Resonant band-pass filter.136137| Path | Type | Range | Default | Access | Description |138| --- | --- | --- | --- | --- | --- |139| `fx.bandpass.cutoff` | frequency | 20 Hz … 20000 Hz | `1kHz` | read, write, ramp | Centre frequency. |140| `fx.bandpass.resonance` | number | 0.5 … 10 | `1.2` | read, write, ramp | Filter Q (narrower as it grows). |141| `fx.bandpass.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |142| `fx.bandpass.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |143144## Tremolo — `fx.tremolo`145146Beat-locked amplitude modulation.147148| Path | Type | Range | Default | Access | Description |149| --- | --- | --- | --- | --- | --- |150| `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. |151| `fx.tremolo.depth` | number | 0 … 1 | `0.8` | read, write, ramp | Modulation depth. |152| `fx.tremolo.shape` | number | 0 … 1 | `0` | read, write, ramp | 0 = sine, 1 = square. |153| `fx.tremolo.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |154| `fx.tremolo.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |155156## Auto-pan — `fx.autopan`157158Beat-locked left/right panning.159160| Path | Type | Range | Default | Access | Description |161| --- | --- | --- | --- | --- | --- |162| `fx.autopan.rate` | duration | 0.031 … 8 beats | `1beat` | read, write | Length of one cycle in beats. Seconds are converted with the current tempo. |163| `fx.autopan.depth` | number | 0 … 1 | `1` | read, write, ramp | Pan range. |164| `fx.autopan.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |165| `fx.autopan.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |166167## Beat Gate — `fx.gate`168169Rhythmic gate locked to the beat grid.170171| Path | Type | Range | Default | Access | Description |172| --- | --- | --- | --- | --- | --- |173| `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. |174| `fx.gate.duty` | number | 0.05 … 0.95 | `0.5` | read, write, ramp | Open fraction of each cycle. |175| `fx.gate.depth` | number | 0 … 1 | `1` | read, write, ramp | Attenuation while closed. |176| `fx.gate.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |177| `fx.gate.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |178179## Compressor — `fx.compressor`180181Feed-forward stereo-linked compressor.182183| Path | Type | Range | Default | Access | Description |184| --- | --- | --- | --- | --- | --- |185| `fx.compressor.threshold` | gain | -60 dB … 0 dB | `-18dB` | read, write, ramp | Level above which gain reduction starts. |186| `fx.compressor.ratio` | number | 1 … 20 | `4` | read, write, ramp | Compression ratio n:1. |187| `fx.compressor.attack` | duration | 0.1 … 200 ms | `10ms` | read, write | Attack time. |188| `fx.compressor.release` | duration | 10 … 2000 ms | `150ms` | read, write | Release time. |189| `fx.compressor.makeup` | gain | 0 dB … 24 dB | `0dB` | read, write, ramp | Gain applied after compression. |190| `fx.compressor.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |191| `fx.compressor.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |192193## Limiter — `fx.limiter`194195Look-ahead peak limiter.196197| Path | Type | Range | Default | Access | Description |198| --- | --- | --- | --- | --- | --- |199| `fx.limiter.ceiling` | gain | -24 dB … 0 dB | `-1dB` | read, write, ramp | Maximum output peak. |200| `fx.limiter.release` | duration | 10 … 1000 ms | `100ms` | read, write | Recovery time. |201| `fx.limiter.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |202| `fx.limiter.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |203204## Beat Repeat — `fx.beatrepeat`205206Captures the last slice and repeats it while enabled.207208| Path | Type | Range | Default | Access | Description |209| --- | --- | --- | --- | --- | --- |210| `fx.beatrepeat.length` | duration | 0.031 … 4 beats | `0.25beats` | read, write | Slice length in beats. Seconds are converted with the current tempo. |211| `fx.beatrepeat.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |212| `fx.beatrepeat.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |213214## Noise Sweep — `fx.noise`215216Filtered white noise added to the signal, for risers and sweeps.217218| Path | Type | Range | Default | Access | Description |219| --- | --- | --- | --- | --- | --- |220| `fx.noise.level` | gain | -60 dB … 0 dB | `-18dB` | read, write, ramp | Noise level. |221| `fx.noise.cutoff` | frequency | 100 Hz … 16000 Hz | `1kHz` | read, write, ramp | Band-pass centre of the noise. |222| `fx.noise.resonance` | number | 0.5 … 10 | `2` | read, write, ramp | Sharpness of the noise band. |223| `fx.noise.mix` | number | 0 … 1 | `1` | read, write, ramp | Wet/dry balance: 0 is dry, 1 is fully wet. |224| `fx.noise.enabled` | bool | true / false | `false` | read, write | True while the effect is switched on. |225226
Files main
Menu

Theme