Tete: setSoundPosition

2013-05-06T03:41:48Z

setSoundPosition

New page

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.
{{New_feature|3.0139|1.3.2|
Use a player element to control a players voice with this function.
}}
==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to modify.
*'''pos:''' An [[int]]eger value representing the new seek position of the sound in milliseconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, ms)
local ssp = setSoundPosition(theSound, ms)
if ssp then
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox("Sound is now playing from: "..seconds.." Seconds!")
else
outputChatBox("An error has occured. Please make shore there are atleast")
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox(seconds.." Seconds in this song!")
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

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

AR/setSoundPosition - Revision history

Tete: setSoundPosition