GetSoundSpeed

From Multi Theft Auto: Wiki
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

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

Returns

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

Example

Click to collapse [-]
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)

See Also

* FEATURE ADDED IN 1.5.9 (REVISION: r20914)
* FEATURE ADDED IN 1.5.9 (REVISION: r20785)
* FEATURE ADDED IN 1.5.9 (REVISION: r20914)
* FEATURE ADDED IN 1.5.9 (REVISION: r20785)