GetSoundPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP)
Line 6: Line 6:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:getPlaybackPosition|playbackPosition|setSoundPosition}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element which seek position you want to return.
*'''theSound:''' The [[sound]] element which seek position you want to return.

Revision as of 16:50, 17 October 2014

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 )

OOP Syntax Help! I don't understand this!

Method: sound:getPlaybackPosition(...)
Variable: .playbackPosition
Counterpart: setSoundPosition


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=42632"