GetSoundPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Reverted edits by Ameir (talk) to last revision by Alvesvin)
Tag: Rollback
 
(13 intermediate revisions by 11 users not shown)
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.
If the element is a player, this function will use the players voice.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">int 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.


===Returns===
===Returns===
Returns an [[int]]eger value indicating the seek position of the [[sound]] element in milliseconds.
Returns a [[float]] value indicating the seek position of the [[sound]] element in seconds.


==Example==  
==Example==  
TODO
Plays a sound then outputs the seek position.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
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 .. ".")
</syntaxhighlight>
</syntaxhighlight>
</section>
 
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[hu:getSoundPosition]]
[[AR:getSoundPosition]]
[[RO:getSoundPosition]]
[[pt-br:getSoundPosition]]

Latest revision as of 16:36, 26 September 2021

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