audio.isChannelPaused()

Type Function
Library audio.*
Return value Boolean
Revision Release 2024.3703
Keywords audio, channel, paused
See also audio.pause()
audio.play()
audio.isChannelActive()
audio.isChannelPlaying()

Overview

Returns true if the specified channel is currently paused; false if not.

Syntax

audio.isChannelPaused( channel )
channel (required)

Number. The channel you want to know is paused or not.

Example

local isChannel1Paused = audio.isChannelPaused( 1 )
if isChannel1Paused then
    audio.resume( 1 )
end