audio_is_paused


Description

This function will check the given sound to see if it is currently paused. The sound can either be a single instance of a sound (the index for individual sounds being played can be stored in a variable when using the audio_play_sound or audio_play_sound_at functions) or a sound asset, in which case all instances of the given sound will be checked and if any of them are paused the function will return true otherwise it will return false.


Syntax:

audio_is_paused(index);


Argument Description
index The index of the sound to check.


Returns:

Boolean


Example:

if audio_is_paused(snd_Waterfall)
   {
   audio_resume_sound(snd_Waterfall);
   }

The above code checks to see if the sound indexed in the variable "snd_Waterfall" is currently paused and if it returns true then the playing of the sound will be resumed.