GetSoundPosition: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
Tag: Rollback |
||
| (11 intermediate revisions by 10 users not shown) | |||
| Line 2: | Line 2: | ||
{{Client function}} | {{Client function}} | ||
This function is used to return the current seek position of the specified [[sound]] element. | 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== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">float getSoundPosition ( element theSound )</syntaxhighlight> | ||
{{OOP||[[sound]]:getPlaybackPosition|playbackPosition|setSoundPosition}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theSound:''' The [[sound]] element which seek position you want to return. | *'''theSound:''' The [[sound]] element which seek position you want to return. | ||
===Returns=== | ===Returns=== | ||
Returns | Returns a [[float]] value indicating the seek position of the [[sound]] element in seconds. | ||
==Example== | ==Example== | ||
| Line 19: | Line 20: | ||
outputChatBox("The current seek position of the sound is: " .. soundPosition .. ".") | outputChatBox("The current seek position of the sound is: " .. soundPosition .. ".") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Changelog== | |||
{{ChangelogHeader}} | |||
{{ChangelogItem|1.3.2|Added player element to use a players voice}} | |||
==See Also== | ==See Also== | ||
{{Client_audio_functions}} | {{Client_audio_functions}} | ||
[[ | |||
[[hu:getSoundPosition]] | |||
[[AR:getSoundPosition]] | |||
[[RO:getSoundPosition]] | |||
[[pt-br:getSoundPosition]] | |||
Latest revision as of 16:36, 26 September 2021
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
- 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