diff --git a/2025R1_Test/Sound-25R1-md/VRS/VRS_communication_messages_list.md b/2025R1_Test/Sound-25R1-md/VRS/VRS_communication_messages_list.md index 601252775e..36bcba9a21 100644 --- a/2025R1_Test/Sound-25R1-md/VRS/VRS_communication_messages_list.md +++ b/2025R1_Test/Sound-25R1-md/VRS/VRS_communication_messages_list.md @@ -43,8 +43,9 @@ There are 3 types of messages: SOUND_LOAD - Id (int, from 0 to 20) - Load a sound file for the 3D sound source identified by the specified Id + Sound ID (int, from 0 to 32765) + Preload a sound file and assign it the specified ID as a + reference for later use @@ -54,12 +55,13 @@ There are 3 types of messages: SOUND_PLAY_3D - Id (int, from 0 to 20) - Play the 3D sound source identified by the specified Id + Source ID (int, from 0 to 20) + Play the 3D sound source identified by the specified ID - Sound Id (int) - + Sound ID (int) + ID of the preloaded sound (message SOUND_LOAD) + that should be played as this sound source Number of playback loops (int) @@ -79,8 +81,8 @@ There are 3 types of messages: INTERP_SOUND_PLAY - Id (int, from 1 to 10) - Play the 3D interpolated sound source identified by the specified Id + Source ID (int, from 1 to 10) + Play the 3D interpolated sound source identified by the specified ID Volume (float, gain in dB) @@ -112,12 +114,13 @@ There are 3 types of messages: SOUND_PLAY_AMBIANCE - Id (int, from 1 to 2) - Play the ambiance sound source identified by the specified Id + Source ID (int, from 1 to 2) + Play the ambiance sound source identified by the specified ID - Sound Id (int) - + Sound ID (int) + ID of the preloaded sound (message SOUND_LOAD) + that should be played as this sound source Number of playback loops (int) @@ -137,13 +140,14 @@ There are 3 types of messages: Speed (float) - Playback speed (1 is the normal speed). Changing the values also affects the pitch. + Playback speed (1 is the normal speed). + Changing the values also affects the pitch. INPUTCHANNEL_SOUND_PLAY - Id (int, from 1 to 3) + Source ID (int, from 1 to 3) -

Play the 3D input audio stream identified by the specified Id

+

Play the 3D input audio stream identified by the specified ID

@@ -180,37 +184,37 @@ There are 3 types of messages: SOUND_STOP_3D - Id (int, from 1 to 20) + Source ID (int, from 1 to 20) Stop the playback of the 3D sound source - identified by the specified Id + identified by the specified ID INTERP_SOUND_STOP - Id (int, from 1 to 10) + Source ID (int, from 1 to 10) Stop the playback of the 3D interpolated sound source - identified by the specified Id + identified by the specified ID SOUND_STOP_AMBIANCE - Id (int, from 1 to 2) + Source ID (int, from 1 to 2) Stop the playback of the ambiance sound source - identified by the specified Id. + identified by the specified ID INPUTCHANNEL_SOUND_STOP - Id (int, from 1 to 3) + Source ID (int, from 1 to 3) Stop the playback of the 3D input audio stream - identified by the specified Id. + identified by the specified ID SOUND_VOLUME_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Volume (float, gain in dB)

Change the sound volume of the 3D sound source - identified by the specified Id.

+ identified by the specified ID

0 dB = unitary gain

Maximum gain allowed = 20 dB

@@ -218,12 +222,12 @@ There are 3 types of messages: INTERP_SOUND_VOLUME -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Volume (float, gain in dB)

Change the sound volume of the 3D interpolated sound source - identified by the specified Id.

+ identified by the specified ID

0 dB = unitary gain

Maximum gain allowed = 10 dB

@@ -231,12 +235,12 @@ There are 3 types of messages: SOUND_VOLUME_AMBIANCE -

Id (int, from 1 to 2)

+

Source ID (int, from 1 to 2)

Volume (float, gain in dB)

Change the sound volume of the ambiance sound source - identified by the specified Id.

+ identified by the specified ID

0 dB = unitary gain

Maximum gain allowed = 20 dB

@@ -244,12 +248,12 @@ There are 3 types of messages: INPUTCHANNEL_VOLUME -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Volume (float, gain in dB)

Change the sound volume of the 3D input stream - identified by the specified Id.

+ identified by the specified ID

0 dB = unitary gain

Maximum gain allowed = 20 dB

@@ -257,7 +261,7 @@ There are 3 types of messages: SOLO_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Solo info (int 0/1)

When solo is activated (1) for a 3D sound source, @@ -266,7 +270,7 @@ There are 3 types of messages: INTERP_SOLO -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Solo info (int 0/1)

When solo is activated (1) for a 3D interpolated sound source, @@ -275,7 +279,7 @@ There are 3 types of messages: SOLO_AMBIANCE -

Id (int, from 1 to 2)

+

Source ID (int, from 1 to 2)

Solo info (int 0/1)

When solo is activated (1) for an ambiance sound source, @@ -284,7 +288,7 @@ There are 3 types of messages: INPUTCHANNEL_SOLO -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Solo info (int 0/1)

When solo is activated (1) for a 3D input stream, @@ -293,7 +297,7 @@ There are 3 types of messages: MUTE_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Mute info (int 0/1)

When mute is activated (1) for a 3D sound source, it becomes silent. @@ -301,7 +305,7 @@ There are 3 types of messages: INTERP_MUTE -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Mute info (int 0/1)

When mute is activated (1) for a 3D interpolated sound source, it becomes silent. @@ -309,7 +313,7 @@ There are 3 types of messages: MUTE_AMBIANCE -

Id (int, from 1 to 2)

+

Source ID (int, from 1 to 2)

Mute info (int 0/1)

When mute is activated (1) for an ambiance sound source, it becomes silent. @@ -317,7 +321,7 @@ There are 3 types of messages: INPUTCHANNEL_MUTE -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Mute info (int 0/1)

When mute is activated (1) for a 3D input stream, it becomes silent. @@ -325,7 +329,7 @@ There are 3 types of messages: ACTIVE_SPAT_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Spat info (int 0/1)

@@ -336,7 +340,7 @@ There are 3 types of messages: INTERP_ACTIVE_SPAT -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Spat info (int 0/1)

@@ -347,7 +351,7 @@ There are 3 types of messages: INPUTCHANNEL_ACTIVE_SPAT -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Spat info (int 0/1)

@@ -358,7 +362,7 @@ There are 3 types of messages: ACTIVE_TRACKING_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Head-tracking info (int 0/1)

@@ -370,7 +374,7 @@ There are 3 types of messages: INTERP_ACTIVE_TRACKING -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Head-tracking info (int 0/1)

@@ -382,7 +386,7 @@ There are 3 types of messages: INPUTCHANNEL_ACTIVE_TRACKING -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Head-tracking info (int 0/1)

@@ -394,61 +398,61 @@ There are 3 types of messages: SPEED_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Playback speed (float)

Playback speed for the 3D sound source identified by the - specified Id (1 is the normal speed). Changing the + specified ID (1 is the normal speed). Changing the value also affects the pitch.

SPEED_AMBIANCE -

Id (int, from 1 to 2)

+

Source ID (int, from 1 to 2)

Playback speed (float)

Playback speed for the ambiance sound source identified by the - specified Id (1 is the normal speed). Changing + specified ID (1 is the normal speed). Changing the value also affects the pitch.

3D_SOURCE_TRAJECTORY -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

File name (string)

Load a trajectory for the 3D sound source - identified by the specified Id.

-

Full path of the trajectory file including extension.

+ identified by the specified ID

+

Full path of the trajectory file including extension

INTERP_TRAJECTORY -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

File name (string)

Load a trajectory for the 3D interpolated sound source - identified by the specified Id.

-

Full path of the trajectory file including extension.

+ identified by the specified ID

+

Full path of the trajectory file including extension

3D_SOURCE_DIFFUSENESS -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

Diffuseness value (int, %)

For VBAP rendering mode only.

Specify how diffuse the spatialization of the 3D sound - source identified by the specified Id shall be.

+ source identified by the specified ID shall be.

0% means the source is not spread, 100% means the source is totally surrounding and diffused over all speakers.

@@ -456,13 +460,13 @@ There are 3 types of messages: INTERP_SOURCE_DIFFUSENESS -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Diffuseness value (int, %)

For VBAP rendering mode only.

Specify how diffuse the spatialization of the 3D interpolated sound - source identified by the specified Id shall be.

+ source identified by the specified ID shall be.

0% means the source is not spread, 100% means the source is totally surrounding and diffused over all speakers.

@@ -470,13 +474,13 @@ There are 3 types of messages: INPUTCHANNEL_SOURCE_DIFFUSENESS -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

Diffuseness value (int, %)

For VBAP rendering mode only.

Specify how diffuse the spatialization of the 3D input - audio stream identified by the specified Id shall be.

+ audio stream identified by the specified ID shall be.

0% means the source is not spread, 100% means the source is surrounding and diffused over all speakers.

@@ -484,7 +488,7 @@ There are 3 types of messages: INTERP_CONTROL_PARAM -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Control parameter value (int)

@@ -496,7 +500,7 @@ There are 3 types of messages: INTERP_CONTROL_PARAMETER_FILE -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

FileName (string)

@@ -506,7 +510,7 @@ There are 3 types of messages: INTERP_OVERLAP -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

Overlap value (int)

@@ -563,7 +567,7 @@ There are 3 types of messages: SOURCE_POSITION_3D -

Id (int, from 1 to 20)

+

Source ID (int, from 1 to 20)

x (float)

y (float)

z (float)

@@ -575,7 +579,7 @@ There are 3 types of messages: INTERP_SOURCE_POSITION -

Id (int, from 1 to 10)

+

Source ID (int, from 1 to 10)

x (float)

y (float)

z (float)

@@ -587,7 +591,7 @@ There are 3 types of messages: INPUTCHANNEL_POSITION -

Id (int, from 1 to 3)

+

Source ID (int, from 1 to 3)

x (float)

y (float)

z (float)