audio_sync_group_is_paused

This function can be used to check if audio in a synchronised group is paused.

The function takes in a 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_paused(group_index);

ArgumentTypeDescription
group_indexAudio Sync Group IDThe group index to check.

 

Returns:

Boolean

 

Example:

if !audio_sync_group_is_paused(sync_group)
{
    audio_resume_sync_group(sync_group);
}

The above code first checks to see if the audio sync group sync_group is paused. If that is the case, it resumes playing the sync group using audio_resume_sync_group.