AR/setSoundProperties - Revision history

Max: /* Required Arguments */

2018-07-20T01:52:03Z

Required Arguments

← Older revision		Revision as of 01:52, 20 July 2018
Line 8:		Line 8:
	<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>

	===~~Required Arguments~~===		===العناصر المطلوبة===
	*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]		*'''sound:''' A sound element that is created using [[playSound]] or [[playSound3D]]

Max: /* مثال الوظيفة */

2018-07-20T01:51:38Z

مثال الوظيفة

← Older revision		Revision as of 01:51, 20 July 2018
Line 5:		Line 5:
	}}		}}

	==~~مثال~~ الوظيفة==		==شرح الوظيفة==
	<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>

Max: /* Syntax */

2018-07-20T01:51:17Z

Syntax

← Older revision		Revision as of 01:51, 20 July 2018
Line 5:		Line 5:
	}}		}}

	==~~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>

Max: /* Example */

2018-07-20T01:51:00Z

Example

← Older revision		Revision as of 01:51, 20 July 2018
Line 22:		Line 22:
	Returns true if the properties sucessfully set, false otherwise.		Returns true if the properties sucessfully set, false otherwise.

	==~~Example~~==		==مثال==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Max: /* Returns */

2018-07-20T01:50:54Z

Returns

← Older revision		Revision as of 01:50, 20 July 2018
Line 19:		Line 19:
	*'''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 true if the properties sucessfully set, false otherwise.		Returns true if the properties sucessfully set, false otherwise.

Tete: setSoundProperties

2013-05-06T03:47:07Z

setSoundProperties

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0130|1.3.0|4097|
This function edit's the properties of a specific [[sound]].
}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )</syntaxhighlight>

===Required Arguments===
*'''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]

*'''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]

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

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
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
</syntaxhighlight>
</section>

==أنظر أيضاً==
{{AR/Audio_functions}}