Pair: setSoundProperties

This function gets the properties of a specific sound.

OOP Syntax Help! I don't understand this!

• Method: sound:getProperties(...)

Syntax

float|false,​ float,​ float,​ bool getSoundProperties ( sound theSound )

Required Arguments

• theSound: A sound element.

Returns

• float|false: sample rate
• float: tempo
• float: pitch
• bool: reversed

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.

Code Examples

Example 1 Example 2 (OOP)

client

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

client

OOP Required

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 = Sound("wasted.mp3")
    timer = Timer(function() soundProperties(sound) end, 5000, 0)
end
)

function soundProperties(sound)
    local sampleRate, tempo, pitch, isReversed = sound:getProperties() --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

Audio Functions

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

Audio Elements

• sound

Reference

• Scripting Functions