StopSound

Stops the sound playback for specified sound element. The sound element is also destroyed.

Syntax

bool stopSound ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:stop(...)

Required Arguments

• theSound: the sound element you want to stop playing.

Returns

Returns true if the sound was successfully stopped, false otherwise.

Example

local sound

function startMySound()
    sound = playSound("sound.mp3", true)
end
addEventHandler("onClientResourceStart", resourceRoot, startMySound)

function stopMySound()
    if isElement(sound) then
        stopSound(sound)
    end
end
addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound

See Also

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM
• getSoundBufferLength
• getSoundEffectParameters
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundLooped
• isSoundPanningEnabled
• isSoundPaused
• playSFX3D
• playSFX
• playSound3D
• playSound
• setRadioChannel
• setSoundEffectEnabled
• setSoundEffectParameter
• setSoundLooped
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound


• Shared
• playSoundFrontEnd