audio.stop()

Type Function
Library audio.*
Return value Number
Revision 2017.3112
Keywords audio, stop, sounds, music
See also audio.play()

Overview

Stops playback on a channel (or all channels) and clears the channel(s) so they can be played on again. Callbacks will still be invoked, but the completed flag will be set to false.

This function returns the number of channels actually stopped or -1 on error.

Gotchas

Note that audio.stop() does not take any handles from audio.loadSound() or audio.loadStream(). This is by design. You are intended to stop specific channels, not sound handles. Imagine multiple explosion effects all going off around the same time. In this case, it doesn't make sense to call audio.stop() on the explosion handle because each explosion may end at a slightly different time.

For audio loaded with audio.loadStream(), the position of the audio will not be reset when stop is called. So when if you call audio.play() again on the same handle, it will continue approximately where it left off (approximately meaning it might be a little further down because all the pre-filled buffers were discarded on the audio.stop()). This contrasts with audio loaded with audio.loadSound() which will start playing at the beginning of the starting position of the buffer (beginning of the sound unless you modified it with audio.seek()). So for audio.loadStream, you may want to call audio.rewind() on the handle if you reuse the audio handle.

Syntax

audio.stop( [channel] )
channel (optional)

Number. The channel to stop. If no parameter is passed, all channels are stopped.

Example

local backgroundMusicChannel = audio.play( backgroundMusic, { loops=-1 }  ) 
audio.stop( backgroundMusicChannel )

-- NOTE: backgroundMusicChannel is not an audio handle. It is a number representing the channel that is playing.