getSoundLength
Client-side
Server-side
Shared
This function is used to return the playback length of the specified sound element. If the element is a player, this function will use the players voice.
OOP Syntax Help! I don't understand this!
- Method:sound:getLength(...)
- Variable: .length
Syntax
float|false getSoundLength ( sound/player theSound )Required arguments
- theSound: The sound element which length you want to return.
Returns
Returns an float value indicating the playback length of the sound element in seconds. false if bad sound element is passed.
- float|false: length
Code Examples
client
Plays a sound then outputs the sound length.
local sound = playSound("money.mp3", false) -- Play a soundlocal soundLength = getSoundLength(sound) -- Get the length of the soundoutputChatBox("This sound is " .. soundLength .. " seconds long.")Changelog
Added player element to use a players voice.
See Also
Audio Functions
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX
- playSFX3D
- playSound
- playSound3D
- playSoundFrontEnd
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound