GetSoundPosition: Difference between revisions

Revision as of 22:47, 4 May 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

@@ Line 3: / Line 3: @@
 This function is used to return the current seek position of the specified [[sound]] element.
 {{New_feature|3.0139|1.3.2|
-Use a player element to control a players voice with this function.
+If the element is a player, this function will use the players voice.
 }}
 ==Syntax==
@@ Line 24: / Line 24: @@
 ==Changelog==
 {{ChangelogHeader}}
-{{ChangelogItem|1.3.2|Added player element for voice control}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
 {{Client_audio_functions}}