audio_sync_group_is_playing

Check to see if the given sync group is currently playing any audio.

Syntax:

audio_sync_group_is_playing(group_index);


Argument Description
group_index The group index to check.


Returns: N/A


Description

This function can be used to check if any audio in a synchronised group is playing. You are required to supply the synch group ID as returned by the function audio_create_sync_group().


Example:

if audio_sync_group_is_playing(group_one)
   {
   audio_stop_sync_group(group_one);
   }

The above code will switch on or off the audio sync group debug overlay showing the sync group indexed in the variable "sg" depending on whether the game is run in debug mode or not.


Back: Audio Synchronisation
Next: audio_create_sync_group
© Copyright YoYo Games Ltd. 2018 All Rights Reserved