SetSoundPosition

From Multi Theft Auto: Wiki
Revision as of 23:13, 15 July 2014 by SDraw (talk | contribs) (Wrong parameter description and sample code)
Jump to navigation Jump to search

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 )

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. Please make sure there are at least")
    end
end
addCommandHandler("skipsong", setSongPos)

Changelog

Version Description
1.3.2 Added player element for voice control

See Also