GetSoundPosition: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→Example) |
||
Line 13: | Line 13: | ||
==Example== | ==Example== | ||
Plays a sound then outputs the seek position. | |||
<syntaxhighlight lang="lua"> | <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> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[Category:Needs Example]] | [[Category:Needs Example]] |
Revision as of 19:09, 11 December 2012
This function is used to return the current seek position of the specified sound element.
Syntax
int getSoundPosition ( element theSound )
Required Arguments
- theSound: The sound element which seek position you want to return.
Returns
Returns an integer value indicating the seek position of the sound element in milliseconds.
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 .. ".")
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd