SetSoundProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (-Cate:NE)
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|4.0140|1.3.0|4097|
{{New feature/item|3.0130|1.3.0|4097|
This function edit's the properties of a specific [[sound]].
This function edit's the properties of a specific [[sound]].
}}
}}

Revision as of 08:32, 19 April 2013

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

Syntax

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

Required Arguments

  • 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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundProperties?oldid=35482"