SetSoundPosition: Difference between revisions

Latest revision as of 02:30, 29 August 2021

This function is used to change the seek position of the specified sound element. Use a player element to control a players voice with this function.

[[{{{image}}}\|link=\|]]	Note: To set position of a remote audio file, you must pause the sound within an onClientSoundStream event after creation, set the sound position and then unpause it again. The sound can also not be throttled (see playSound arguments)

Syntax

bool setSoundPosition ( element theSound, float pos )

OOP Syntax Help! I don't understand this!

Method: sound:setPlaybackPosition(...)

Variable: .playbackPosition

Counterpart: getSoundPosition

Required Arguments

theSound: the sound element which seek position you want to modify.
pos: a float value representing the new seek position of the sound element in seconds.

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

theSound = playSound("music/song.mp3")
function setSongPos(cmd, tm)
    tm = tonumber(tm)
    local ssp = setSoundPosition(theSound,tm)
    if ssp then
        outputChatBox("Sound is now playing from: "..tostring(tm))
    else
        outputChatBox("An error has occured.")
    end
end
addCommandHandler("skipsong", setSongPos)

Changelog

Version	Description

1.3.2

Added player element for voice control

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Sets custom sound seek position.
+This function is used to change the seek position of the specified [[sound]] element.
+Use a player element to control a players voice with this function.
+{{Note|
+*To set position of a remote audio file, you must pause the sound within an [[onClientSoundStream]] event after creation, set the sound position and then unpause it again. The sound can also not be throttled (see [[playSound]] arguments)}}
 ==Syntax==
-<syntaxhighlight lang="lua">bool setSoundPosition ( element sound, int pos )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, float pos )</syntaxhighlight>
+{{OOP||[[sound]]:setPlaybackPosition|playbackPosition|getSoundPosition}}
 ===Required Arguments===
-*'''sound:''' the element of the sound you want to play.
+*'''theSound:''' the [[sound]] element which seek position you want to modify.
-*'''pos:''' An integet number representing the position you wish to seek to.
+*'''pos:''' a [[float]] value representing the new seek position of the [[sound]] element in seconds.
 ===Returns===
-Returns ''true'' if the sound position was successfully moved, ''false'' otherwise.
+Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.
 ==Example==
-TODO
+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">
---TODO
+theSound = playSound("music/song.mp3")
+function setSongPos(cmd, tm)
+    tm = tonumber(tm)
+    local ssp = setSoundPosition(theSound,tm)
+    if ssp then
+        outputChatBox("Sound is now playing from: "..tostring(tm))
+    else
+        outputChatBox("An error has occured.")
+    end
+end
+addCommandHandler("skipsong", setSongPos)
 </syntaxhighlight>
-</section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element for voice control}}
 ==See Also==
-{{audio functions}}
+{{Client_audio_functions}}
+[[hu:setSoundPosition]]
+[[ar:setSoundPosition]]
+[[ro:setSoundPosition]]