Pair: setSoundSpeed

This function is used to return the playback speed of the specified sound element.

OOP Syntax Help! I don't understand this!

• Method: sound:getSpeed(...)
• Variable: .speed

Syntax

float|false getSoundSpeed ( sound/player theSound )

Required Arguments

• theSound: The sound element which playback speed you want to return.

Returns

• float|false: speed

Returns an float value indicating the playback speed of the sound element. Default sound playback speed is 1.0.

Code Examples

Example 1 Example 2 (OOP)

client

function 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)

client

OOP Required

function outputSpeed(soundName)
    if soundName then
        local soundElement = Sound("sounds/"..soundName..".mp3") -- Play the sound from the sounds folder

        soundElement.speed = 0.5 -- Set the sound speed to 50%

        local soundSpeed = soundElement.speed -- Get current sound speed

        outputChatBox("Sound speed: "..soundSpeed) -- Output the sound speed
    end
end
addCommandHandler("soundspeed", outputSpeed)

See Also

Audio Functions

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

Audio Elements

• sound

Reference

• Scripting Functions