Higher Order Ambisonics (HOA) /bus/{i}
The root OSC message for controlling a HOA bus is /bus/{index}, where {index} is an integer starting from 1. To control any of the parameters listed below, you need to append the parameter name to the bus target address.
For example:
/bus/1/gain 0.5- Sets the gain of the bus 1 to 0.5
- 3D
- 2D
General Parameters
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /name | string | -- | -- | -- | ✓ |
| /color | [decimal, decimal, decimal, decimal] | 0, 1 | -- | -- | ✓ |
| /lock | boolean | -- | -- | -- | ✓ |
| /trim | decimal | -80, 30 | dB | -- | ✓ |
| /gain | decimal | -60, 12 | dB | -- | ✓ |
| /gain/ramptime | decimal | 1, 60000 | ms | -- | ✓ |
| /mute | integer | 0, 2 | -- | 0 = unmuted, 1 = muted, 2 = muted by solo (read-only) | ✓ |
| /solo | boolean | -- | -- | -- | ✓ |
| /format | string | "HOA", "HOA2D", "Binaural", "Transaural", "KNN", "Angular2D", "LBAP", "Stereo AB", "Stereo XY", "Stereo Pan", "Thru", "VBAP", "VBAP2D", "VBIP", "VBIP2D", "WFS" | -- | -- | ✗ |
| /monitor | boolean | -- | -- | -- | ✓ |
| /reference/xyz | [decimal, decimal, decimal] | -- | -- | -- | ✓ |
| /ramp/time | decimal | 1, 1000 | -- | -- | ✓ |
| /yaw | decimal | -180, 180 | ° | -- | ✓ |
| /pitch | decimal | -180, 180 | ° | -- | ✓ |
| /roll | decimal | -180, 180 | ° | -- | ✓ |
| /preOrPost | string | "post", "pre" | -- | -- | ✓ |
| /linkedToSpeaker | boolean | -- | -- | -- | ✓ |
Other Parameters
Equalizer
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /equalizer/bypass | boolean | -- | -- | -- | ✓ |
| /equalizer/gain | decimal | -20, 20 | dB | -- | ✓ |
| /equalizer/filter/{i}/active | boolean | -- | -- | -- | ✓ |
| /equalizer/filter/{i}/freq | decimal | 30, 22000 | Hz | -- | ✓ |
| /equalizer/filter/{i}/order | decimal | 2, 20 | -- | -- | ✓ |
| /equalizer/filter/{i}/gain | decimal | -30, 30 | dB | -- | ✓ |
| /equalizer/filter/{i}/q | decimal | 0.25, 100 | -- | -- | ✓ |
Dynamics
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /dynamics/attack | decimal | 0.01, 3000 | ms | -- | ✓ |
| /dynamics/release | decimal | 0, 5000 | ms | -- | ✓ |
| /dynamics/lookahead | decimal | 0, 50 | ms | -- | ✓ |
| /dynamics/compressor/threshold | decimal | -120, 20 | dB | -- | ✓ |
| /dynamics/compressor/ratio | decimal | 1, 100 | -- | -- | ✓ |
| /dynamics/compressor/knee | decimal | 0, 30 | dB | -- | ✓ |
| /dynamics/expander/threshold | decimal | -120, 20 | dB | -- | ✓ |
| /dynamics/expander/ratio | decimal | 0.009, 10 | -- | -- | ✓ |
| /dynamics/makeup | decimal | -40, 40 | dB | -- | ✓ |
| /dynamics/link | string | "multi mono", "link all", "link to 1st" | -- | -- | ✓ |
| /dynamics/bypass | boolean | -- | -- | -- | ✓ |
| /dynamics/reduction | decimal | -- | dB | -- | ✗ |
Levels
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /levels/input/post | boolean | -- | -- | -- | ✓ |
| /levels/input/mode | string | "rms", "peak" | -- | -- | ✓ |
| /levels/output/post | boolean | -- | -- | -- | ✓ |
| /levels/output/mode | string | "rms", "peak" | -- | -- | ✓ |
Speaker
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speaker/{i}/delay | decimal | 0, 5000 | ms | -- | ✓ |
| /speaker/{i}/gain/db | decimal | -80, 20 | dB | -- | ✓ |
| /speaker/{i}/name | string | -- | -- | -- | ✓ |
| /speaker/number | decimal | -- | -- | -- | ✓ |
Speakers
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speakers/correction/delay | string | "off", "auto", "manual" | -- | -- | ✓ |
| /speakers/correction/gain | string | "off", "auto", "manual" | -- | -- | ✓ |
| /speakers/aed | array | -- | -- | -- | ✓ |
| /speakers/visible | boolean | -- | -- | -- | ✓ |
Delay
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /delay/bypass | boolean | -- | -- | -- | ✓ |
| /delay | decimal | 0, 5000 | -- | -- | ✓ |
Focus
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /focus/dimension | decimal | 2, 3 | -- | -- | ✓ |
Blur
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /blur/bypass | boolean | -- | -- | -- | ✓ |
| /blur | decimal | 0, 100 | -- | -- | ✓ |
Decoder
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /decoder/type | string | "basic", "maxRe", "in-phase", "inphase-maxRe", "maxRe-inphase", "basic-maxRe" | -- | -- | ✓ |
| /decoder/method | string | "direct-sampling", "mode-matching", "regularized-mode-matching", "energy-preserving", "all-rad", "all-rad2", "all-radknn", "allrad+", "mvlad", "csad", "no decoding" | -- | -- | ✓ |
| /decoder/norm | string | "SN3D", "N3D", "FuMa", "MaxN" | -- | -- | ✓ |
| /decoder/crossover | decimal | 80, 16000 | -- | -- | ✓ |
| /decoder/powercompensation | boolean | -- | -- | -- | ✓ |
| /decoder/phantom/zenith | boolean | -- | -- | -- | ✓ |
| /decoder/phantom/nadir | boolean | -- | -- | -- | ✓ |
View3D
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /view3D/file3D | string | -- | -- | -- | ✓ |
| /view3D/scale | decimal | 0.01, 10 | -- | -- | ✓ |
| /view3D/visible | boolean | -- | -- | -- | ✓ |
| /view3D/label | boolean | -- | -- | -- | ✓ |
| /view3D/vumeter | boolean | -- | -- | -- | ✓ |
Routing
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speakerRouting/output/{i}/speaker | array | -- | -- | Speaker(s) assigned to output channel {i}. Send the full updated list, adding or removing one speaker per message. The application derives the matching routing/output from the assigned speakers' own outputs. | ✓ |
| /speakerRouting/output/empty | none | -- | -- | Clears every channel's speaker assignment and the derived output routing. | ✓ |
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /routing/output/{i}/master | array | -- | -- | Physical output(s) fed by output channel {i}. Send the full list each time; a message with no arguments clears the channel. | ✓ |
| /routing/output/empty | none | -- | -- | Clears the whole output routing. Also emitted by the processor when the output routing table is empty. | ✓ |
| /routing/stream/{i}/master | array | -- | -- | Sends encoded HOA stream channel {i} (one per bus input) straight to physical outputs, bypassing the decoder. | ✓ |
| /routing/stream/empty | none | -- | -- | Clears the whole HOA stream routing. Also emitted by the processor when the stream routing table is empty. | ✓ |
General Parameters
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /name | string | -- | -- | -- | ✓ |
| /color | [decimal, decimal, decimal, decimal] | 0, 1 | -- | -- | ✓ |
| /lock | boolean | -- | -- | -- | ✓ |
| /trim | decimal | -80, 30 | dB | -- | ✓ |
| /gain | decimal | -60, 12 | dB | -- | ✓ |
| /gain/ramptime | decimal | 1, 60000 | ms | -- | ✓ |
| /mute | integer | 0, 2 | -- | 0 = unmuted, 1 = muted, 2 = muted by solo (read-only) | ✓ |
| /solo | boolean | -- | -- | -- | ✓ |
| /format | string | "HOA", "HOA2D", "Binaural", "Transaural", "KNN", "Angular2D", "LBAP", "Stereo AB", "Stereo XY", "Stereo Pan", "Thru", "VBAP", "VBAP2D", "VBIP", "VBIP2D", "WFS" | -- | -- | ✗ |
| /monitor | boolean | -- | -- | -- | ✓ |
| /reference/xyz | [decimal, decimal, decimal] | -- | -- | -- | ✓ |
| /ramp/time | decimal | 1, 1000 | -- | -- | ✓ |
| /yaw | decimal | -180, 180 | ° | -- | ✓ |
| /pitch | decimal | -180, 180 | ° | -- | ✓ |
| /roll | decimal | -180, 180 | ° | -- | ✓ |
| /preOrPost | string | "post", "pre" | -- | -- | ✓ |
| /linkedToSpeaker | boolean | -- | -- | -- | ✓ |
Other Parameters
Equalizer
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /equalizer/bypass | boolean | -- | -- | -- | ✓ |
| /equalizer/gain | decimal | -20, 20 | dB | -- | ✓ |
| /equalizer/filter/{i}/active | boolean | -- | -- | -- | ✓ |
| /equalizer/filter/{i}/freq | decimal | 30, 22000 | Hz | -- | ✓ |
| /equalizer/filter/{i}/order | decimal | 2, 20 | -- | -- | ✓ |
| /equalizer/filter/{i}/gain | decimal | -30, 30 | dB | -- | ✓ |
| /equalizer/filter/{i}/q | decimal | 0.25, 100 | -- | -- | ✓ |
Dynamics
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /dynamics/attack | decimal | 0.01, 3000 | ms | -- | ✓ |
| /dynamics/release | decimal | 0, 5000 | ms | -- | ✓ |
| /dynamics/lookahead | decimal | 0, 50 | ms | -- | ✓ |
| /dynamics/compressor/threshold | decimal | -120, 20 | dB | -- | ✓ |
| /dynamics/compressor/ratio | decimal | 1, 100 | -- | -- | ✓ |
| /dynamics/compressor/knee | decimal | 0, 30 | dB | -- | ✓ |
| /dynamics/expander/threshold | decimal | -120, 20 | dB | -- | ✓ |
| /dynamics/expander/ratio | decimal | 0.009, 10 | -- | -- | ✓ |
| /dynamics/makeup | decimal | -40, 40 | dB | -- | ✓ |
| /dynamics/link | string | "multi mono", "link all", "link to 1st" | -- | -- | ✓ |
| /dynamics/bypass | boolean | -- | -- | -- | ✓ |
| /dynamics/reduction | decimal | -- | dB | -- | ✗ |
Levels
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /levels/input/post | boolean | -- | -- | -- | ✓ |
| /levels/input/mode | string | "rms", "peak" | -- | -- | ✓ |
| /levels/output/post | boolean | -- | -- | -- | ✓ |
| /levels/output/mode | string | "rms", "peak" | -- | -- | ✓ |
Speaker
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speaker/{i}/delay | decimal | 0, 5000 | ms | -- | ✓ |
| /speaker/{i}/gain/db | decimal | -80, 20 | dB | -- | ✓ |
| /speaker/{i}/name | string | -- | -- | -- | ✓ |
| /speaker/number | decimal | -- | -- | -- | ✓ |
Speakers
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speakers/correction/delay | string | "off", "auto", "manual" | -- | -- | ✓ |
| /speakers/correction/gain | string | "off", "auto", "manual" | -- | -- | ✓ |
| /speakers/aed | array | -- | -- | -- | ✓ |
| /speakers/visible | boolean | -- | -- | -- | ✓ |
Delay
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /delay/bypass | boolean | -- | -- | -- | ✓ |
| /delay | decimal | 0, 5000 | -- | -- | ✓ |
Focus
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /focus/dimension | decimal | 2, 3 | -- | -- | ✓ |
Blur
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /blur/bypass | boolean | -- | -- | -- | ✓ |
| /blur | decimal | 0, 100 | -- | -- | ✓ |
Decoder
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /decoder/type | string | "basic", "maxRe", "in-phase", "inphase-maxRe", "maxRe-inphase", "basic-maxRe" | -- | -- | ✓ |
| /decoder/method | string | "direct-sampling", "mode-matching", "regularized-mode-matching", "energy-preserving", "all-rad", "all-rad2", "all-radknn", "allrad+", "mvlad", "csad", "no decoding" | -- | -- | ✓ |
| /decoder/norm | string | "SN2D", "N2D", "FuMa", "MaxN" | -- | -- | ✓ |
| /decoder/crossover | decimal | 80, 16000 | -- | -- | ✓ |
| /decoder/powercompensation | boolean | -- | -- | -- | ✓ |
View3D
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /view3D/file3D | string | -- | -- | -- | ✓ |
| /view3D/scale | decimal | 0.01, 10 | -- | -- | ✓ |
| /view3D/visible | boolean | -- | -- | -- | ✓ |
| /view3D/label | boolean | -- | -- | -- | ✓ |
| /view3D/vumeter | boolean | -- | -- | -- | ✓ |
Routing
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speakerRouting/output/{i}/speaker | array | -- | -- | Speaker(s) assigned to output channel {i}. Send the full updated list, adding or removing one speaker per message. The application derives the matching routing/output from the assigned speakers' own outputs. | ✓ |
| /speakerRouting/output/empty | none | -- | -- | Clears every channel's speaker assignment and the derived output routing. | ✓ |
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /routing/output/{i}/master | array | -- | -- | Physical output(s) fed by output channel {i}. Send the full list each time; a message with no arguments clears the channel. | ✓ |
| /routing/output/empty | none | -- | -- | Clears the whole output routing. Also emitted by the processor when the output routing table is empty. | ✓ |
| /routing/stream/{i}/master | array | -- | -- | Sends encoded HOA stream channel {i} (one per bus input) straight to physical outputs, bypassing the decoder. | ✓ |
| /routing/stream/empty | none | -- | -- | Clears the whole HOA stream routing. Also emitted by the processor when the stream routing table is empty. | ✓ |