audio_play_in_sync_group


Description

With this function you can assign a sound to a previously create sync group. The group index is the value returned when you created the group using the function audio_create_sync_group(), and the sound index is the index of any compressed sound (*.ogg or *.mp3) from the resource tree. This function only adds the sound to the group, but it does not play the sound, and will a value > -1 if it succeeds and -1 if it fails.

NOTE: This functionality is not available for the HTML5 target platform.


Syntax:

audio_play_in_sync_group(group_index, sound_index);


Argument Description
group_index The group index to assign the sound to.
sound_index The sound index to be assigned to the group.


Returns:

Index


Example:

sg = audio_create_sync_group(true);
audio_play_in_sync_group(sg, sound1);
audio_play_in_sync_group(sg, sound2);
audio_play_in_sync_group(sg, sound3);
audio_play_in_sync_group(sg, sound4);
audio_start_sync_group(sg);

The above creates a new sync group and assigns the index of the group to the variable "sg". Four sounds are then added to the group, with the gain for three of them being set to 0. Finally the sync group is played.