GetSoundPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
This function is used to return the current seek position of the specified [[sound]] element.
This function is used to return the current seek position of the specified [[sound]] element.
{{New_feature|3.0139|1.3.2|
If the element is a player, this function will use the players voice.
If the element is a player, this function will use the players voice.
}}
 
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight>  

Revision as of 08:22, 10 June 2013

This function is used to return the current seek position of the specified sound element. If the element is a player, this function will use the players voice.

Syntax

float getSoundPosition ( element theSound )

Required Arguments

  • theSound: The sound element which seek position you want to return.

Returns

Returns a float value indicating the seek position of the sound element in seconds.

Example

Plays a sound then outputs the seek position. 

local sound = playSound("randomSound.mp3",false) --Play a sound
local soundPosition = getSoundPosition(sound) --Get the current sound position
outputChatBox("The current seek position of the sound is: " .. soundPosition .. ".")

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundPosition?oldid=36384"