Binaural /bus/{i}
The root OSC message for controlling a Binaural 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
Binaural processing creates 3D audio for headphone playback using Head-Related Transfer Functions (HRTFs).
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] | -- | -- | -- | ✓ |
| /headphoneeq/type | string | "AKG K1000 Closed", "AKG K1000 Open", "AKG K141MK2", "AKG K240DF", "AKG K240MK2", "AKG K271MK2", "AKG K271STUDIO", "AKG K601", "AKG K701", "AKG K702", "AudioTechnica ATH M50", "Beyerdynamic DT250", "Beyerdynamic DT770PRO 250Ohms", "Beyerdynamic DT880", "Beyerdynamic DT990PRO", "Presonus HD7", "Sennheiser HD430", "Sennheiser HD480", "Sennheiser HD560ovationII", "Sennheiser HD565ovation", "Sennheiser HD600", "Sennheiser HD650", "SHURE SRH940", "none" | -- | -- | ✓ |
| /itd/scaling | decimal | 0, 200 | % | -- | ✓ |
| /hrtf | string | -- | -- | -- | ✓ |
| /listener/orientation | [decimal, decimal, decimal, decimal] | -1, 1 | -- | -- | ✓ |
| /interpolation/time | decimal | 1, 1000 | -- | -- | ✓ |
| /preOrPost | string | "post", "pre" | -- | -- | ✓ |
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" | -- | -- | ✓ |
Delay
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /delay/bypass | boolean | -- | -- | -- | ✓ |
| /delay | decimal | 0, 5000 | -- | -- | ✓ |
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 |
|---|---|---|---|---|---|
| /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. | ✓ |