Advanced OSC Commands/Messages
This page documents advanced OSC controls for system management, session handling, and device configuration.
Session Management
Parameter | Arguments | Comments |
---|
/session/add/track | [string, integer, string, integer] | Add a new track with specified parameters [type, chNbr, name, quantityNumber] |
/session/add/bus | [string, integer, integer, integer] | Add a new bus with specified parameters [format, inputNbr, outputsNbr, quantityNumber] |
/preset/load | string | Load a preset by name |
When adding a track using session/add/track
, the parameters are:
type
: Source type can be 'Mono', 'Stereo', 'Multichannel', 'EigenMike32', 'EigenMike64', 'MicTree', 'Bformat', 'Aformat', 'Direct To Master', 'Direct To Bus', 'HOA Stream', 'HOA DRIR', or 'Zylia'
chNbr
: Channel numbers (i.e., 1 for mono, 2 for stereo and so on)
name
: A string representing the track name
quantityNumber
: An integer between 1 and 128
When adding a bus using session/add/bus
, the parameters are:
format
: The bus format, which can be 'WFS', 'HOA', 'HOA2D', 'VBAP', 'VBAP2D', 'VBIP', 'VBIP2D', 'Binaural', 'Transaural', 'Stereo AB', 'Stereo XY', 'Stereo Pan', 'Angular 2D', 'KNN', 'LBAP', or 'Thru'
inputNbr
: Number of inputs
outputsNbr
: Number of outputs
quantityNumber
: An integer between 1 and 128
Options
Parameter | Arguments | Scale | Unit | Comments | Settable |
---|
/options/clearsolo | none | -- | -- | Clear all solo states | ✅ |
/options/vumeters/rate | number | 20, 500 | -- | Set VU meters refresh rate | ✅ |
/options/parallel/tracks | boolean | 0, 1 | -- | Enable/disable parallel processing for tracks | ✅ |
/options/parallel/bus | boolean | 0, 1 | -- | Enable/disable parallel processing for buses | ✅ |
Audio Device Configuration
Parameter | Arguments | Scale | Unit | Comments | Settable |
---|
/device/list | none | -- | -- | List available devices | ❌ |
/device/output | string | -- | -- | Set output device | ✅ |
/device/input | string | -- | -- | Set input device | ✅ |
/dsp/buffersize | number | -- | -- | Set DSP buffer size (must be power of 2) | ✅ |
/dsp/samplerate | number | -- | -- | Set DSP sample rate | ✅ |
/dsp/usurp | boolean | 0, 1 | -- | Enable/disable DSP usurpation | ✅ |
Test Generator
Parameter | Arguments | Scale | Unit | Comments | Settable |
---|
/dac/test/channel | any | -- | -- | Test DAC channel | ✅ |
/dac/test/active | any | -- | -- | Set DAC test active state | ✅ |
/dac/test/gain | any | -- | -- | Set DAC test gain | ✅ |
/adc/test/channel | any | -- | -- | Test ADC channel | ✅ |
/adc/test/active | any | -- | -- | Set ADC test active state | ✅ |
/adc/test/gain | any | -- | -- | Set ADC test gain | ✅ |
Advanced Source Positioning
Parameter | Arguments | Scale | Unit | Comments | Settable |
---|
/{source}/{id}/aed | array | -- | -- | Set source position using Azimuth, Elevation, Distance [azimuth, elevation, distance] | ✅ |
/{source}/{id}/xyz | array | -- | -- | Set source position using XYZ coordinates [x, y, z] | ✅ |
/{source}/{id}/azim++ | number | -- | -- | Increment azimuth value | ✅ |
/{source}/{id}/elev++ | number | -- | -- | Increment elevation value | ✅ |
/{source}/{id}/dist++ | number | -- | -- | Increment distance value | ✅ |
Bus Speaker Configuration
Parameter | Arguments | Scale | Unit | Comments | Settable |
---|
/bus/{id}/speaker/{id}/direction/xyz | array | -- | -- | Set speaker direction using XYZ coordinates [x, y, z] | ✅ |
Parameter | Comments |
---|
/warning | Log warning from console in string format |
/station/lastReleaseNote | Get JSON of the last release note changelog |