getSoundPosition
Client-side
Server-side
Shared
Pair: setSoundPosition
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 player's voice.
OOP Syntax Help! I don't understand this!
- Method: sound:getPlaybackPosition(...)
- Variable: .playbackPosition
Syntax
float|false getSoundPosition ( sound/player theSound )Required Arguments
- theSound: The sound element which seek position you want to return.
Returns
- float|false: position
Returns a float value indicating the seek position of the sound element in seconds.
Code Examples
client
Plays a sound then outputs the seek position.
local sound = playSound("randomSound.mp3",false) --Play a soundlocal soundPosition = getSoundPosition(sound) --Get the current sound positionoutputChatBox("The current seek position of the sound is: " .. soundPosition .. ".")Changelog
See Also
Audio Functions
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundFFTData
- getSoundEffects
- getSoundLength
- getSoundMaxDistance
- getSoundLevelData
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundSpeed
- getSoundWaveData
- getSoundVolume
- isSoundPaused
- isSoundPanningEnabled
- playSFX
- isSoundLooped
- getSoundProperties
- playSound
- playSFX3D
- setRadioChannel
- playSound3D
- setSoundEffectParameter
- setSoundEffectEnabled
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPaused
- setSoundPanningEnabled
- setSoundSpeed
- setSoundPosition
- setSoundProperties
- setSoundVolume
- stopSound