SetSoundProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:


==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 = false ] )</syntaxhighlight>  
{{OOP||[[sound]]:setProperties||getSoundProperties}}
{{OOP||[[sound]]:setProperties||getSoundProperties}}
===Required Arguments===  
===Required Arguments===  
Line 17: Line 17:
*'''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]


===Optional Arguments===
{{OptionalArg}}
*'''bReverse:''' a [[boolean]] representing whether the sound will be reversed or not.
*'''bReverse:''' a [[boolean]] representing whether the sound will be reversed or not.


Revision as of 02:49, 28 September 2018

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

Syntax

bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch [, bool bReverse = false ] )

OOP Syntax Help! I don't understand this!

Method: sound:setProperties(...)
Counterpart: getSoundProperties


Required Arguments

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional 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=59535"