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

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

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

See Also

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM

• getSoundBufferLength
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound