SetSoundPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Wrong parameter description and sample code)
Line 5: Line 5:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, float pos )</syntaxhighlight>  


===Required Arguments===  
===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 [[int]]eger value representing the new seek position of the sound in milliseconds.
*'''pos:''' An float value representing the new seek position of the sound. Integer part of this value - seconds, fractional part - milliseconds.


===Returns===
===Returns===
Line 18: Line 18:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
theSound = playSound("music/song.mp3")
function setSongPos(cmd, ms)
function setSongPos(cmd, tm)
     local ssp = setSoundPosition(theSound, ms)
    tm = tonumber(tm)
     local ssp = setSoundPosition(theSound,tm)
     if ssp then
     if ssp then
        local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
         outputChatBox("Sound is now playing from: "..tostring(tm))
         outputChatBox("Sound is now playing from: "..seconds.." Seconds!")
     else
     else
         outputChatBox("An error has occured. Please make sure there are at least")
         outputChatBox("An error has occured. Please make sure there are at least")
        local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
        outputChatBox(seconds.." Seconds in this song!")
     end
     end
end
end

Revision as of 23:13, 15 July 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 )

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

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundPosition?oldid=40886"