API Reference / Audio / audMusicPlaying

audMusicPlaying

Checks if music is currently playing. Takes music (music channel handle). Returns 1 if playing, 0 if not.

Audio

Parameters & Returns

Parameters

music Int

Returns

Int

Quick Summary

Checks if music is currently playing. Takes music (music channel handle). Returns 1 if playing, 0 if not.

Technical Exegesis...

Returns 1 if the music voice handle is valid and currently active, otherwise returns 0. This includes both playing and paused states.

Returns 0 if the handle is invalid or <= 0. Pass the handle returned by audPlayMusic. Useful for checking if background music is still active.

Example

Example.bam 
If audMusicPlaying(channel) Then
            Print \"Status: Playing\"
Else
            Print \"Status: Stopped\"
EndIf
Since: 1.0 Status: Stable
← Back to Audio