SetSoundProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )</syntaxhighlight>  
 
{{OOP||[[sound]]:setProperties||getSoundProperties}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]
*'''sound:''' a [[sound]] [[element]] that is created using [[playSound]] or [[playSound3D]]


*'''fSampleRate:''' A float that defines the new sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate]
*'''fSampleRate:''' a [[float]] that defines the new sound's [http://en.wikipedia.org/wiki/Sampling_rate sample rate]


*'''fTempo:''' A float that defines the new sound [http://en.wikipedia.org/wiki/Tempo tempo]
*'''fTempo:''' a [[float]] that defines the new sound [http://en.wikipedia.org/wiki/Tempo tempo]


*'''fPitch:''' A float that defines the new sound [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch]
*'''fPitch:''' a [[float]] that defines the new sound [http://en.wikipedia.org/wiki/Pitch_%28music%29 pitch]


*'''bReverse:''' A boolean representing whether the sound will be reversed or not.
*'''bReverse:''' a [[boolean]] representing whether the sound will be reversed or not.


===Returns===
===Returns===
Returns true if the properties sucessfully set, false otherwise.
Returns ''true'' if the properties sucessfully set, ''false'' otherwise.


==Example==  
==Example==  
Line 35: Line 35:
==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[AR:setSoundProperties]]
 
[[ar:setSoundProperties]]

Revision as of 16:53, 17 October 2014

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

  • 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=42635"