Skip to main content

Advanced OSC Commands/Messages

This page documents advanced OSC controls for system management, session handling, and device configuration.

Session Management

ParameterArgumentsComments
/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/loadstringLoad 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

ParameterArgumentsScaleUnitCommentsSettable
/options/clearsolonone----Clear all solo states
/options/vumeters/ratenumber20, 500--Set VU meters refresh rate
/options/parallel/tracksboolean0, 1--Enable/disable parallel processing for tracks
/options/parallel/busboolean0, 1--Enable/disable parallel processing for buses

Audio Device Configuration

ParameterArgumentsScaleUnitCommentsSettable
/device/listnone----List available devices
/device/outputstring----Set output device
/device/inputstring----Set input device
/dsp/buffersizenumber----Set DSP buffer size (must be power of 2)
/dsp/sampleratenumber----Set DSP sample rate
/dsp/usurpboolean0, 1--Enable/disable DSP usurpation

Test Generator

ParameterArgumentsScaleUnitCommentsSettable
/dac/test/channelany----Test DAC channel
/dac/test/activeany----Set DAC test active state
/dac/test/gainany----Set DAC test gain
/adc/test/channelany----Test ADC channel
/adc/test/activeany----Set ADC test active state
/adc/test/gainany----Set ADC test gain

Advanced Source Positioning

ParameterArgumentsScaleUnitCommentsSettable
/{source}/{id}/aedarray----Set source position using Azimuth, Elevation, Distance [azimuth, elevation, distance]
/{source}/{id}/xyzarray----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

ParameterArgumentsScaleUnitCommentsSettable
/bus/{id}/speaker/{id}/direction/xyzarray----Set speaker direction using XYZ coordinates [x, y, z]

Informational Messages (only received)

ParameterComments
/warningLog warning from console in string format
/station/lastReleaseNoteGet JSON of the last release note changelog