Messages List
Last update: 17.07.2025There are 3 types of messages:
- The control messages, corresponding to a global instruction, such as initialization.
- The event service messages, such as the loading or triggering of a sound source.
- The recurrent service messages sent periodically, corresponding to updates of the listener position or the sources positions.
Control Messages
| Keyword | Data | Comments |
|---|---|---|
| GLOBAL_INIT | IP address of the supervisor (for example : 192.168.0.1) | IP address and port used for the sending of state messages. Resets the sound generator (Id's cleared). |
| Port (for example : 5555) | ||
| Sending period of the ALIVE message (in milliseconds) | ||
| GLOBAL_PAUSE | none | Pauses the playback of all sound sources. Freezes the sound generator. |
| GLOBAL_RESUME | none | Resumes the playback. |
| GLOBAL_3D_MODE | Rendering Mode (string) | The rendering modes are: Binaural VBAP Transaural DoubleTransaural Ambisonic |
| API_COORDINATES_MODE | Coordinate Mode (string) | The available coordinate modes are: A - Virtools/Unity B - Polhemus C - Angular mode |
Event Service Messages
| Keyword | Data | Comments |
|---|---|---|
| SOUND_LOAD | Id (Int, from 0 to 32765) | Preload a sound |
|
File name (string) |
Full path of the sound file including extension | |
| SOUND_PLAY_3D | Playback Slot (int) | Playback of a spatialized sound (1 ≤ Slot ≤ 10) |
| Sound Id (int) | ||
| Number of playbacks (int) | Number of playbacks: -1 means infinite loop | |
| Volume (float, gain in dB) | Initial volume | |
|
x (float) y (float) z (float) |
Initial position of the source | |
| INTERP_SOUND_PLAY | Slot (int, from 1 to 10) | Playback of a spatialized sound (1 ≤ Slot ≤ 10) |
| >Volume (float, gain in dB) | Initial volume | |
|
x (float) y (float) z (float) |
Initial position of the source | |
| Spat (int 0/1) | Spatialization off/on | |
| Tracker (int 0/1) | Tracking off/on | |
| Solo (int 0/1) | Solo off/on | |
| Mute (int 0/1) | Mute off/on | |
| SOUND_PLAY_AMBIANCE | Playback Slot (int) | Playback of an ambiance source (1 ≤ Slot ≤ 2) |
| Sound Id (int) | ||
| Number of playbacks (int) | Number of playbacks: -1 means infinite loop | |
| Volume (float, gain in dB) | Initial volume | |
| >Solo (int 0/1) | Solo off/on | |
| Mute (int 0/1) | Mute off/on | |
| Speed (float) | Playback speed (1 is the normal speed). Changing the values also affects the pitch. | |
| INPUTCHANNEL_SOUND_PLAY | Channel Id (int) |
Activates the playback of an input audio stream. ID = input number in the sound card. |
| Volume (float, gain in dB) | Initial volume | |
|
x (float) y (float) z (float) |
Initial position of the source | |
| Spat (int 0/1) | Spatialization off/on | |
| >Tracker (int 0/1) | Tracking off/on | |
| Solo (int 0/1) | Solo off/on | |
| Mute (int 0/1) | Mute off/on | |
| SOUND_STOP_3D | Slot (int) | Stops the playback of a 3D sound |
| INTERP_SOUND_STOP | Slot (int, from 1 to 10) | Stops the playback of a 3D Interpolated source |
| SOUND_STOP_AMBIANCE | Slot (int) | Stops the playback of an ambiance sound |
| INPUTCHANNEL_SOUND_STOP | Channel Id (int) | Stops the input channel audio stream |
| SOUND_VOLUME_3D |
Slot (int) Volume (float, gain in dB) |
Changes the sound volume of an ambiance sound. 0 dB = unitary gain Maximum gain allowed = 20 dB |
| INTERP_SOUND_VOLUME |
Slot (int) Volume (float, gain in dB) |
Changes the sound volume of a 3D interpolated source. 0 dB = unitary gain Maximum gain allowed = 10 dB |
| SOUND_VOLUME_AMBIANCE |
Slot (int) Volume (float, gain in dB) |
Changes the sound volume of an ambiance sound. 0 dB = unitary gain Maximum gain allowed = 20 dB |
| INPUTCHANNEL_VOLUME |
Channel Id (int) Volume (float, gain in dB) |
Changes the sound volume of the input channel stream. 0 dB = unitary gain Maximum gain allowed = 20 dB |
| SOLO_3D |
Slot (int) Solo info (int 0/1) |
When solo is activated (1) on a 3D track, all other tracks are muted except those in solo mode. |
| INTERP_SOLO |
Slot (int) Solo info (int 0/1) |
When solo is activated (1) on a 3D interpolated source, all other tracks are muted except those in solo mode. |
| SOLO_AMBIANCE |
Slot (int) Solo info (int 0/1) |
When solo is activated (1) on an ambiance track, all other tracks are muted except those in solo mode. |
| INPUTCHANNEL_SOLO |
Channel Id (int) Solo info (int 0/1) |
When solo is activated (1) on the input channel track, all other tracks are muted except those in solo mode. |
| MUTE_3D |
Slot (int) Mute info (int 0/1) |
When mute is activated (1) on a 3D track, this track becomes silent. |
| INTERP_MUTE |
Slot (int) Mute info (int 0/1) |
When mute is activated (1) on a 3D interpolated source, this track becomes silent. |
| MUTE_AMBIANCE |
Slot (int) Mute info (int 0/1) |
>When mute is activated (1) on an ambiance track, this track becomes silent. |
| INPUTCHANNEL_MUTE |
Channel Id (int) Mute info (int 0/1) |
When mute is activated (1) on the input channel track, this track becomes silent. |
| ACTIVE_SPAT_3D |
Slot (int) Spat info (int 0/1) |
For binaural or transaural restitution only. When the spatialization is activated (1), the sound can be perceived in 3D. |
| INTERP_ACTIVE_SPAT |
Slot (int) Spat info (int 0/1) |
For binaural or transaural restitution only. When the spatialization is activated (1), the sound can be perceived in 3D. |
| INPUTCHANNEL_ACTIVE_SPAT |
Channel Id (int) Spat info (int 0/1) |
For binaural or transaural restitution only. When the spatialization is activated (1), the sound can be perceived in 3D. |
| ACTIVE_TRACKING_3D |
Slot (int) Head-tracking info (int 0/1) |
For 3D tracks and binaural restitution only. When the head-tracking is activated(1), the listener can move their head and the source remains at an absolute position in space. |
| INTERP_ACTIVE_TRACKING |
Slot (int) Head-tracking info (int 0/1) |
For 3D tracks and binaural restitution only. When the head-tracking is activated(1), the listener can move their head and the source remains at an absolute position in space. |
| INPUTCHANNEL_ACTIVE_TRACKING |
Channel Id (int) Head-tracking info (int 0/1) |
For binaural restitution only. When the head- tracking is activated(1), the listener can move their head and the input channelstream remains at an absolute position in space. |
| SPEED_3D |
Slot (int) Playback speed (float) |
Playback speed for 3D sounds (1 is the normal speed). Changing the values also affects the pitch. |
| SPEED_AMBIANCE |
Slot (int) Playback speed (float) |
Playback speed for ambiance sounds (1 is the normal speed). Changing the values also affects the pitch. |
| 3D_SOURCE_TRAJECTORY |
Slot (Int, from 1 to 20) File name (string) |
Load a trajectory. Full path of the trajectory file including extension. |
| INTERP_TRAJECTORY |
Slot (Int, from 1 to 10) File name (string) |
Load a trajectory. Full path of the trajectory file including extension. |
| 3D_SOURCE_DIFFUSENESS |
Slot (Int, from 1 to 20) Diffuseness value (int, %) |
For 3D sources in VBAP rendering mode only. 0% means the source is not spread, 100% means the source is totally surrounding and diffused over all speakers. |
| INTERP_SOURCE_DIFFUSENESS |
Slot (Int, from 1 to 10) Diffuseness value (int, %) |
For interpolated sources in VBAP rendering mode only. 0% means the source is not spread, 100% means the source is totally surrounding and diffused over all speakers. |
| INPUTCHANNEL_SOURCE_DIFFUSENESS |
Slot (Int, from 1 to 3) Diffuseness value (int, %) |
For 3D input streams in VBAP rendering mode only. 0% means the source is not spread, 100% means the source is surrounding and diffused over all speakers. |
| INTERP_CONTROL_PARAM |
Slot (int) Control parameter value (int) |
Depending on the type of source, the control parameter can be speed, RPM, or any parameter that has an influence on the rendering of the source. |
| INTERP_OVERLAP |
Slot (int) Overlap value (int) |
This is the overlap value between two adjacent samples, in the same unit as the control parameter. |
| Keyword | Data | Comments |
| HEAD_POSITION_3D |
x (float) y (float) z (float) |
Head coordinates |
|
Yaw (float, radians) Pitch (float, radians) Roll (float, radians) |
Head orientation using Euler Angles (Tait-Bryan convention: Azimuth- Elevation-Roll) |
|
| SOURCE_POSITION_3D |
Slot (int) x (float) y (float) z (float) |
Source position update |
| INTERP_SOURCE_POSITION |
Slot (int) x (float) y (float) z (float) |
Source position update |
| INPUTCHANNEL_POSITION |
Slot (int) x (float) y (float) z (float) |
Input channel stream position update |
