GetSoundSpeed
Jump to navigation
Jump to search
This function is used to return the playback speed of the specified sound element.
Syntax
float getSoundSpeed ( element theSound )
OOP Syntax Help! I don't understand this!
- Method: sound:getSpeed(...)
- Variable: .speed
- Counterpart: setSoundSpeed
Required Arguments
Returns
Returns an float value indicating the playback speed of the sound element. Default sound playback speed is 1.0.
Example
Click to collapse [-]
Clientfunction outputSpeed(soundName) if soundName then local soundElement = playSound("sounds/"..soundName..".mp3") -- Play the sound from the sounds folder setSoundSpeed(soundElement, 0.5) -- Set the sound speed to 50% local soundSpeed = getSoundSpeed(soundElement) -- Get current sound speed outputChatBox("Sound speed: "..soundSpeed) -- Output the sound speed end end addCommandHandler("soundspeed", outputSpeed)
See Also
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData