API Reference / Audio / audChannelPlaying

audChannelPlaying

Checks if a channel is currently playing. Takes channel (channel handle). Returns 1 if the channel is valid and currently playing, otherwise returns 0.

Audio

Parameters & Returns

Parameters

channel Int

Returns

Int

Quick Summary

Checks if a channel is currently playing. Takes channel (channel handle). Returns 1 if the channel is valid and currently playing, otherwise returns 0.

Technical Exegesis...

Returns 1 if the channel is valid and currently playing, otherwise returns 0. This includes both playing and paused states.

Returns 0 if the channel handle is invalid or <= 0, or if the channel has finished playing and been automatically removed. Useful for checking if a sound effect or music track is still active.

Example

Example.bam 
If audChannelPlaying(channel) Then
	;Do something if playing
Else
	;If not, do something else!
EndIf
Since: 1.0 Status: Stable
← Back to Audio