OSC Table#
SPACE HUB Control OSC receiver: UDP Port 9301
* replace with Object/Snapshot/Group/Preset OSC number
Use -1 for currently selected Object/Snapshot/Group/Preset
ADM-OSC#
For more information on ADM-OSC visit: https://immersive-audio-live.github.io/ADM-OSC/
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Azim, Elev, Dist |
/adm/obj/*/aed |
f, f, f |
°, °, 0-1 |
/adm/obj/1/aed 0.0, 0.0, 0.0 |
Ranges: see below |
Azimuth |
/adm/obj/*/azim |
f |
° |
/adm/obj/1/azim -180.0 |
-180.0° - +180.0° |
Elevation |
/adm/obj/*/elev |
f |
° |
/adm/obj/1/elev 90.0 |
-90.0° - +90.0° |
Distance |
/adm/obj/*/dist |
f |
0 - +1 |
/adm/obj/1/dist 0.0 |
0.0 - +1.0 |
X, Y, Z |
/adm/obj/*/xyz |
f, f, f |
-1 - +1 |
/adm/obj/1/xyz -0.5, 0.3, 0.0 |
scaled by Max Distance |
X, Y |
/adm/obj/*/xy |
f, f |
-1 - +1 |
/adm/obj/1/xy -0.5, 0.3 |
scaled by Max Distance |
X (left / right) |
/adm/obj/*/x |
f |
-1 - +1 |
/adm/obj/1/x -0.5 |
scaled by Max Distance |
Y (front / back) |
/adm/obj/*/y |
f |
-1 - +1 |
/adm/obj/1/y 0.3 |
scaled by Max Distance |
Z (up / down) |
/adm/obj/*/z |
f |
-1 - +1 |
/adm/obj/1/z 0.0 |
scaled by Max Distance |
Spread |
/adm/obj/*/w |
f |
0 - 1 |
/adm/obj/1/w 0.5 |
Spread (normalised) |
Level |
/adm/obj/*/gain |
f |
0 - 1 |
/adm/obj/1/gain 0.0 |
|
Mute |
/adm/obj/*/mute |
int |
1 / 0 |
/adm/obj/1/mute 0 |
1: muted, 0: unmuted |
Max Distance |
/adm/obj/*/dmax |
f |
meters |
/adm/obj/1/dmax 10.0 |
Maximum Distance (global) |
Headtracker |
/adm/lis/ypr |
f, f, f |
°, °, ° |
/adm/lis/ypr -90.0, 8.0, -5.0 |
Binaural Yaw, Pitch, Roll |
Object Control#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Azim, Elev, Dist |
/source/*/aed |
f, f, f |
°, °, % |
/source/1/aed 180.0, 90.0, 50.0 |
Ranges: see below |
Azimuth |
/source/*/azim |
f |
° |
/source/1/azim -75.0 |
-180.0° - +180.0° |
Elevation |
/source/*/elev |
f |
° |
/source/1/elev 45.0 |
-90.0° - +90.0° |
Distance |
/source/*/dist |
f |
% |
/source/1/dist 50.0 |
scaled by Max Distance |
X, Y |
/source/*/xy |
f, f |
%, % |
/source/1/xy -65.0 20.0 |
scaled by Max Distance |
Spread |
/source/*/spread |
f |
% |
/source/1/spread 65.0 |
|
KNN k Neighbours |
/source/*/kneighbours |
i |
/source/1/kneighbours 4 |
KNN Number of speakers |
|
LFE / Aux send |
/source/*/lfe |
f |
dB |
/source/1/lfe -6.0 |
Legacy, deprecated! |
LFE 1 |
/source/*/lfe1 |
f |
-80-+10dB |
/source/1/lfe1 |
|
LFE 2 |
/source/*/lfe2 |
f |
-80-+10dB |
/source/1/lfe2 |
|
Panning Algorithm |
/source/*/algo |
i |
idx |
/source/1/algo |
Index of Panning Algo |
Stereo Width |
/source/*/stwidth |
f |
% |
/source/1/stwidth 35.0 |
|
Select Object |
/source/*/select |
/source/1/select |
|||
Panning Algorithm |
/source/*/algo |
int |
/source/1/algo |
Index of alg. (0=DBAP=) |
|
Level |
/source/*/level |
f |
0 - 1 |
/source/1/level |
|
Level dB |
/source/*/leveldB |
f |
-80 - +10 |
/source/1/leveldB |
|
Mute |
/source/*/mute |
int |
1 / 0 |
/source/1/mute 1 |
|
Solo |
/source/*/solo |
int |
1 / 0 |
/source/1/solo 1 |
|
Polarity |
/source/*/invertphase |
int |
1 / 0 |
/source/1/invertphase 1 |
1: inverted |
Random Play |
/source/*/random/play |
opt int |
1 / 0 |
/source/1/random/play 1 |
no args=play,int arg:1/0 |
Random Stop |
/source/*/random/stop |
/source/1/random/stop |
|||
Orbit Play |
/source/*/orbit/play |
opt int |
1 / 0 |
/source/1/orbit/play |
no args=play,int arg:1/0 |
Orbit Stop |
/source/*/orbit/stop |
/source/1/orbit/stop |
|||
Orbit Restart |
/source/*/orbit/restart |
/source/1/orbit/restart |
|||
Name |
/source/*/name |
s |
/source/1/name vocals |
Group Control#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Azimuth |
/group/*/azim |
f |
° |
/group/1/azim -75.0 |
-180.0° - +180.0° |
Elevation |
/group/*/elev |
f |
° |
/group/1/elev 45.0 |
-90.0° - +90.0° |
Distance |
/group/*/dist |
f |
0 - 1 |
/group/1/dist 0.5 |
scaled by Max Distance |
Spread |
/group/*/spread |
f |
% |
/group/1/spread 65.0 |
|
LFE / Aux send |
/group/*/lfe |
f |
dB |
/group/1/lfe -6.0 |
Legacy, deprecated! |
LFE1 |
/group/*/lfe1 |
f |
-80 - +10dB |
/group/1/lfe1 -6.0 |
|
LFE2 |
/group/*/lfe2 |
f |
-80 - +10dB |
/group/1/lfe2 -6.0 |
|
Solo |
/group/*/solo |
int |
1 / 0 |
/group/1/solo 1 |
|
Mute |
/group/*/mute |
int |
1 / 0 |
/group/1/mute 1 |
VCA Control#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Level |
/vca/*/level |
f |
0 - 1 |
/vca/1/level 0.0 |
|
Level dB |
/vca/*/leveldB |
f |
-80 - +10 |
/vca/1/leveldB 0.0 |
|
Mute |
/vca/*/mute |
i |
1 / 0 |
/vca/1/mute 0 |
1: muted, 0: unmuted |
Name |
/vca/*/name |
s |
/vca/1/name drums |
Snapshot Control#
Fade Time argument is optional, ommit for immediate Snapshot recall
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Load Snapshot |
/snapshot/*/load |
f |
seconds |
/snapshot/1/load 1.5 |
Argument = Fade Time |
Prev Snapshot |
/snapshot/prev |
f |
seconds |
/snapshot/prev 0.0 |
Argument = Fade Time |
Next Snapshot |
/snapshot/next |
f |
seconds |
/snapshot/next 3.5 |
Argument = Fade Time |
New Snapshot |
/snapshot/new |
/snapshot/new |
Store new Snapshot |
||
Save Snapshot |
/snapshot/*/save |
/snapshot/3/save |
Overwrite Snapshot |
Reverb Control#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Load Preset |
/reverb/*/load |
/reverb/1/load |
|||
Load Previous |
/reverb/prev |
/reverb/prev |
|||
Load Next |
/reverb/next |
/reverb/next |
|||
New Preset |
/reverb/new |
s |
/reverb/new “Large Hall” |
optional preset name argument |
|
Save Preset |
/reverb/*/save |
/reverb/1/save |
|||
Decay |
/reverb/decay |
f |
0 - 5 |
/reverb/decay 2.5 |
seconds |
Decay Low |
/reverb/ratiolow |
f |
0.2 - 5.0 |
/reverb/ratiolow 1.5 |
Ratio related to Decay time |
Decay Low-Mid |
/reverb/ratiolowmid |
f |
0.2 - 5.0 |
/reverb/ratiolowmid 1.5 |
Ratio related to Decay time |
Decay High-Mid |
/reverb/ratiohighmid |
f |
0.2 - 5.0 |
/reverb/ratiohighmid 1.5 |
Ratio related to Decay time |
Decay High |
/reverb/ratiohigh |
f |
0.2 - 5.0 |
/reverb/ratiohigh 1.5 |
Ratio related to Decay time |
Predelay |
/reverb/predelay |
f |
10 - 70 |
/reverb/predelay 10.0 |
milliseconds |
Balance Front Back |
/reverb/balancefrontback |
f |
-1 - +1 |
/reverb/balancefrontback 0.0 |
|
Balance Up Down |
/reverb/balanceupdown |
f |
-1 - +1 |
/reverb/balanceupdown 0.0 |
|
Diffusion |
/reverb/diffusion |
f |
0 - 100 |
/reverb/diffusion 50.0 |
|
Size |
/reverb/size |
f |
10 - 100 |
/reverb/size 50.0 |
|
Modulation |
/reverb/modulation |
f |
0 - 100 |
/reverb/modulation 50.0 |
|
Early HPF |
/reverb/earlyhpf |
f |
20 - 1000 |
/reverb/earlyhpf 500.0 |
|
Early LPF |
/reverb/earlylpf |
f |
1000 - 20000 |
/reverb/earlyhpf 10000.0 |
|
Late HPF |
/reverb/latehpf |
f |
20 - 1000 |
/reverb/latehpf 500.0 |
|
Late LPF |
/reverb/latelpf |
f |
1000 - 20000 |
/reverb/latelpf 10000.0 |
|
Direct Level |
/reverb/directlevel |
f |
0 - 1 |
/reverb/directlevel 0.0 |
|
Direct Level dB |
/reverb/directleveldB |
f |
-80 - 0 |
/reverb/directleveldB 0.0 |
|
Early Level |
/reverb/earlylevel |
f |
0 - 1 |
/reverb/earlylevel 0.0 |
|
Early Level dB |
/reverb/earlyleveldB |
f |
-80 - 0 |
/reverb/earlyleveldB 0.0 |
|
Cluster Level |
/reverb/clusterlevel |
f |
0 - 1 |
/reverb/clusterlevel 0.0 |
|
Cluster Level dB |
/reverb/clusterleveldB |
f |
-80 - 0 |
/reverb/clusterleveldB 0.0 |
|
Late Level |
/reverb/latelevel |
f |
0 - 1 |
/reverb/latelevel 0.0 |
|
Late Level dB |
/reverb/lateleveldB |
f |
-80 - 0 |
/reverb/lateleveldB 0.0 |
|
Reverb Level |
/reverb/level |
f |
-80 - 0 |
/reverb/level 0.0 |
|
Reverb Level dB |
/reverb/leveldB |
f |
-80 - 0 |
/reverb/leveldB 0.0 |
|
Reverb Mute |
/reverb/mute |
i |
1 / 0 |
/reverb/mute 1 |
1: muted, 0: unmuted |
Downmix Control#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Mono Level |
/downmix/mono/leveldB |
f |
-80 - 10dB |
/downmix/mono/leveldB 0.0 |
|
Mono Mute |
/downmix/mono/mute |
i |
1 / 0 |
/downmix/mono/mute 1 |
1: muted, 0: unmuted |
Stereo Level |
/downmix/stereo/leveldB |
f |
-80 - 10dB |
/downmix/stereo/leveldB 0.0 |
|
Stereo Mute |
/downmix/stereo/mute |
i |
1 / 0 |
/downmix/stereo/mute 1 |
1: muted, 0: unmuted |
Stereo Focus |
/downmix/stereo/focusfrontback |
f |
-1.0 - 1.0 |
/downmix/stereo/focusfrontback 0.0 |
|
LFE1 Level |
/downmix/lfe1/leveldB |
f |
-80 - 10dB |
/downmix/lfe1/leveldB 0.0 |
|
LFE1 Mute |
/downmix/lfe1/mute |
i |
1 / 0 |
/downmix/lfe1/mute 1 |
1: muted, 0: unmuted |
LFE2 Level |
/downmix/lfe2/leveldB |
f |
-80 - 10dB |
/downmix/lfe2/leveldB 0.0 |
|
LFE2 Mute |
/downmix/lfe2/mute |
i |
1 / 0 |
/downmix/lfe2/mute 1 |
1: muted, 0: unmuted |
PFL Level |
/downmix/pfl/leveldB |
f |
-80 - 10dB |
/downmix/pfl/leveldB 0.0 |
|
PFL Mute |
/downmix/pfl/mute |
i |
1 / 0 |
/downmix/pfl/mute 1 |
1: muted, 0: unmuted |
Binaural Level |
/downmix/binaural/leveldB |
f |
-80 - 10dB |
/downmix/binaural/leveldB 0.0 |
|
Binaural Mute |
/downmix/binaural/mute |
i |
1 / 0 |
/downmix/binaural/mute 1 |
1: muted, 0: unmuted |
Binaural Low Boost |
/downmix/binaural/lowboost |
f |
-12 - 12dB |
/downmix/binaural/lowboost 0.0 |
|
Binaural HF Shelf |
/downmix/binaural/hfshelf |
f |
-12 - 12dB |
/downmix/binaural/hfshelf 0.0 |
Additional Commands#
Command |
Message |
Type |
Range |
Example |
Comments |
|---|---|---|---|---|---|
Master Level |
/master/gain |
f |
0.0-1.0 |
/master/gain 0.5 |
0.0 -> -80dB, 0.5 -> -6dB, 1.0 -> 0dB |
Master Level dB |
/master/gaindB |
f |
-80 - 0dB |
/master/gaindB 0.0 |
|
Master Mute |
/master/mute |
i |
1 / 0 |
/master/mute 1 |
|
Global Play |
/global/play |
(optional i) |
1 / 0 |
/global/play |
no args = play, with int arg: 1/0 |
Global Stop |
/global/stop |
/global/stop |
|||
Global Restart |
/global/restart |
/global/restart |
|||
BPM |
/global/bpm |
f or int |
/global/bpm 126 |
Set any BPM |
|
Ping |
/ping |
/ping |
SPACE HUB Control replies with /pong |