audio_sync_group_is_playing

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

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

 

Syntax:

audio_sync_group_is_playing(group_index);

ArgumentTypeDescription
group_indexAudio Sync Group IDThe group index to check.

 

Returns:

Boolean

 

Example:

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

The above code checks to see if the sync group group_one is currently playing and if it is, the group is stopped.