HU/setSoundProperties

This function edit's the properties of a specific sound.

Syntax

bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )

OOP Syntax Help! I don't understand this!

Method: sound:setProperties(...)

Counterpart: getSoundProperties

Required Arguments

• sound: a sound element that is created using playSound or playSound3D

• fSampleRate: a float that defines the new sound's sample rate

• fTempo: a float that defines the new sound tempo

• fPitch: a float that defines the new sound pitch

• bReverse: a boolean representing whether the sound will be reversed or not.

Returns

Returns true if the properties sucessfully set, false otherwise.

Example

Click to collapse [-]

Client

function editSongSound()
	local sound = playSound("song.wav", false) -- Play the file 'song.wav' and make it play only once
	setSoundProperties(sound, 48000.0, 128.00, 440.0, false) -- Set its samplerate to 48,000 Hz, tempo to 128.00, pitch to 440 Hz and not reversed
end
addEventHandler("onClientResourceStart", resourceRoot, editSongSound) -- Execute the function when the resource is started

See Also

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