K-Nearest Neighbor (KNN) /bus/{i}
The root OSC message for controlling a KNN 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/k 4- Sets the number of nearest neighbors to 4
KNN is a panning method that uses the K nearest speakers to the desired source position, providing smooth transitions between speakers.
General Parameters
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /name | string | -- | -- | -- | ✅ |
| /color | [decimal, decimal, decimal, decimal] | 0, 1 | m | -- | ✅ |
| /lock | boolean | -- | -- | -- | ✅ |
| /trim | integer | -80, 30 | m | -- | ✅ |
| /gain | integer | -60, 12 | m | -- | ✅ |
| /gain/ramptime | decimal | -- | -- | -- | ✅ |
| /mute | string | 0, 2 | m | -- | ✅ |
| /solo | boolean | -- | -- | -- | ✅ |
| /format | string | "HOA", "HOA2D", "Binaural", "Transaural", "KNN", "Angular 2D", "LBAP", "Stereo AB", "Stereo XY", "Stereo Pan", "Thru", "VBAP", "VBAP2D", "VBIP", "VBIP2D", "WFS" | -- | -- | ❌ |
| /delay/bypass | boolean | -- | -- | -- | ✅ |
| /delay | integer | 0, 5000 | m | -- | ✅ |
| /monitor | boolean | -- | -- | -- | ✅ |
| /ramp/time | decimal | -- | -- | -- | ✅ |
| /ignorez | boolean | -- | -- | -- | ✅ |
| /spread | integer | 0, 100 | m | -- | ✅ |
| /spread/bypass | boolean | -- | -- | -- | ✅ |
| /neighbors | string | -- | -- | -- | ✅ |
| /preOrPost | string | "post", "pre" | -- | -- | ✅ |
| /linkedToSpeaker | boolean | -- | -- | -- | ✅ |
Other Parameters
Equalizer
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /equalizer/bypass | boolean | -- | -- | -- | ✅ |
| /equalizer/gain | integer | -20, 20 | m | -- | ✅ |
| /equalizer/filter/{i}/active | boolean | -- | -- | -- | ✅ |
| /equalizer/filter/{i}/freq | integer | 30, 22000 | m | -- | ✅ |
| /equalizer/filter/{i}/order | integer | 2, 20 | m | -- | ✅ |
Dynamics
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /dynamics/attack | decimal | 0.01, 3000 | m | -- | ✅ |
| /dynamics/release | integer | 0, 7000 | m | -- | ✅ |
| /dynamics/lookahead | integer | 0, 50 | m | -- | ✅ |
| /dynamics/compressor/threshold | integer | -60, 20 | m | -- | ✅ |
| /dynamics/compressor/ratio | integer | 1, 100 | m | -- | ✅ |
| /dynamics/expander/threshold | integer | -60, 20 | m | -- | ✅ |
| /dynamics/expander/ratio | decimal | 0.01, 1 | m | -- | ✅ |
| /dynamics/makeup | integer | -40, 40 | m | -- | ✅ |
| /dynamics/link | string | "multi mono", "link all", "link to 1st" | -- | -- | ✅ |
| /dynamics/bypass | boolean | -- | -- | -- | ✅ |
| /dynamics/reduction | decimal | -- | -- | -- | ✅ |
| /dynamics/grid/visible | boolean | -- | -- | -- | ✅ |
| /dynamics/grid/color | [decimal, decimal, decimal, decimal] | 0, 1 | m | -- | ✅ |
| /dynamics/curve/fill | boolean | -- | -- | -- | ✅ |
| /dynamics/curve/color | [decimal, decimal, decimal, decimal] | 0, 1 | m | -- | ✅ |
| /dynamics/curve/thickness | decimal | -- | -- | -- | ✅ |
| /dynamics/background/color | [decimal, decimal, decimal, decimal] | 0, 1 | m | -- | ✅ |
| /dynamics/foreground/color | [decimal, decimal, decimal, decimal] | 0, 1 | m | -- | ✅ |
| /dynamics/title | string | -- | -- | -- | ✅ |
Levels
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /levels/preOrPost | string | "post", "pre" | -- | -- | ✅ |
| /levels/input | array | -120, 12 | -- | -- | ❌ |
| /levels/input/mode | string | "rms", "peak" | -- | -- | ✅ |
| /levels/output | array | -120, 12 | -- | -- | ❌ |
| /levels/output/mode | string | "rms", "peak" | -- | -- | ✅ |
Speaker
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speaker/number | decimal | -- | -- | -- | ✅ |
Speakers
| Parameter | Arguments | Scale | Unit | Comments | Settable |
|---|---|---|---|---|---|
| /speakers/correction/delay | string | "off", "auto", "manual" | -- | -- | ✅ |
| /speakers/correction/gain | string | "off", "auto", "manual" | -- | -- | ✅ |