HU/getSoundProperties

From Multi Theft Auto: Wiki
Revision as of 10:17, 19 July 2018 by Surge (talk | contribs) (Created page with "__NOTOC__ {{Client function hu}} {{New feature/item|3.0130|1.3.0|4097| This function gets the properties of a specific sound. }} ==Syntax== <syntaxhighlight lang="lua">...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function gets the properties of a specific sound.

Syntax

float, float, float, bool getSoundProperties( element sound )

OOP Syntax Help! I don't understand this!

Method: sound:getProperties(...)
Counterpart: setSoundProperties


Required Arguments

Returns

This function returns 3 floats and a boolean value:

The first float is the sound's sample rate, the second one the sound's tempo, and the third one the pitch of the sound. The boolean representing whether the sound is reversed or not.

Example

Example 1: This example would return three float values representing the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not, every 5 seconds. 

local sound 
local timer

addCommandHandler("playsound",
function () 
    sound = playSound("wasted.mp3")
    timer = setTimer(function() soundProperties(sound) end, 5000, 0)
end
)

function soundProperties(sound)
    local sampleRate, tempo, pitch, isReversed = getSoundProperties(sound) --gets the sample rate, tempo, pitch and a boolean value representing whether the sound is reversed or not.
    outputChatBox(sampleRate.." "..tempo.." "..pitch.." "..tostring(isReversed))
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/HU/getSoundProperties?oldid=56046"