GetSoundPosition: Difference between revisions

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

@@ Line 1: / Line 1: @@
-'''Hacked By Ameir'''
+__NOTOC__
-''add me on''
+{{Client function}}
-[http://facebook.com/AhmedAlramSisYy facebook]
+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==
+<syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight>
+{{OOP||[[sound]]:getPlaybackPosition|playbackPosition|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.
+<syntaxhighlight lang="lua">
+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>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
+==See Also==
+{{Client_audio_functions}}
+[[hu:getSoundPosition]]
+[[AR:getSoundPosition]]
+[[RO:getSoundPosition]]
+[[pt-br:getSoundPosition]]