GetSoundPosition

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

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM

• getSoundBufferLength
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundPanningEnabled
• isSoundPaused
• playSFX
• playSFX3D
• playSound
• playSound3D
• playSoundFrontEnd
• setRadioChannel
• setSoundEffectEnabled
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound