SetSoundPosition: Difference between revisions

Revision as of 16:50, 17 October 2014

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.

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: an float value representing the new seek position of the sound. Integer part of this value - seconds, fractional part - 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

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 6: / Line 6: @@
 ==Syntax==
 <syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, float pos )</syntaxhighlight>
+{{OOP||[[sound]]:setPlaybackPosition|playbackPosition|getSoundPosition}}
 ===Required Arguments===
-*'''theSound:''' The [[sound]] element which seek position you want to modify.
+*'''theSound:''' the [[sound]] element which seek position you want to modify.
-*'''pos:''' An float value representing the new seek position of the sound. Integer part of this value - seconds, fractional part - milliseconds.
+*'''pos:''' an float value representing the new seek position of the sound. Integer part of this value - seconds, fractional part - milliseconds.
 ===Returns===
@@ Line 36: / Line 36: @@
 ==See Also==
 {{Client_audio_functions}}
-[[AR:setSoundPosition]]
+[[ar:setSoundPosition]]