Difference between revisions of "SoundChannel:getPosition"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[SoundChannel]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | If the sound is playing, ''getPosition'' returns the position of the current playback, measured in miliseconds from the start of the sound. | |
| − | If the sound is playing, | + | |
| − | If the sound is not playing (paused or stopped), | + | If the sound is not playing (paused or stopped), ''getPosition'' returns the last point that was played. |
| − | + | <syntaxhighlight lang="lua"> | |
| − | < | ||
(number) = SoundChannel:getPosition() | (number) = SoundChannel:getPosition() | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) | + | '''Returns''' (number) the position of the sound in miliseconds<br/> |
| + | |||
| + | {{SoundChannel}} | ||
Latest revision as of 14:32, 13 July 2023
Available since: Gideros 2011.6
Class: SoundChannel
Description
If the sound is playing, getPosition returns the position of the current playback, measured in miliseconds from the start of the sound.
If the sound is not playing (paused or stopped), getPosition returns the last point that was played.
(number) = SoundChannel:getPosition()
Return values
Returns (number) the position of the sound in miliseconds
- SoundChannel:getPitch
- SoundChannel:getPosition
- SoundChannel:getStreamId
- SoundChannel:getVolume
- SoundChannel:isLooping
- SoundChannel:isPaused
- SoundChannel:isPlaying
- SoundChannel:setEffect
- SoundChannel:setLooping
- SoundChannel:setPaused
- SoundChannel:setPitch
- SoundChannel:setPosition
- SoundChannel:setVolume
- SoundChannel:setWorldPosition
- SoundChannel:stop
