1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-07-01 13:50:36 +00:00
QB64-PE/internal/help/_SNDGETPOS.txt

36 lines
1.4 KiB
Plaintext
Raw Normal View History

2016-03-18 11:36:04 +00:00
{{DISPLAYTITLE:_SNDGETPOS}}
The [[_SNDGETPOS]] function returns the current playing position in seconds using a handle from [[_SNDOPEN]].
{{PageSyntax}}
2017-10-10 14:55:21 +00:00
:{{Parameter|position}} = [[_SNDGETPOS]]({{Parameter|handle&}})
{{PageDescription}}
2017-10-10 14:55:21 +00:00
*Returns the current playing position in seconds from an open sound file.
*If a sound isn't playing, it returns 0.
*If a sound is paused, it returns the paused position.
*For a looping sound, the value returned continues to increment and does not reset to 0 when the sound loops.
2019-04-15 01:15:33 +00:00
* In versions '''prior to build 20170811/60''', the sound identified by {{Parameter|handle&}} must have been opened using the [[_SNDOPEN|"SETPOS" capability]] to use this function.
2016-03-18 11:36:04 +00:00
2017-10-10 14:55:21 +00:00
{{PageExamples}}
''Example:'' To check the current playing position in an MP3 file, use [[_SNDPLAY]] with [[_SNDGETPOS]] printed in a loop:
2016-03-18 11:36:04 +00:00
{{CodeStart}} '' ''
2019-04-15 01:15:33 +00:00
SoundFile& = {{Cl|_SNDOPEN}}("YourSoundFile.mp3") '<<< your MP3 sound file here!
2016-03-18 11:36:04 +00:00
{{Cl|_SNDSETPOS}} SoundFile&, 5.5 'set to play sound 5 1/2 seconds into music
{{Cl|_SNDPLAY}} SoundFile& 'play sound
Do: {{Cl|_LIMIT}} 60
2019-04-15 01:15:33 +00:00
LOCATE 5, 2: PRINT "Current play position> "; {{Cl|_SNDGETPOS}}(SoundFile&)
2016-03-18 11:36:04 +00:00
LOOP UNTIL {{Cl|_KEYDOWN}}(27) OR {{Cl|NOT}} {{Cl|_SNDPLAYING}}(SoundFile&) 'ESC or end of sound exit
{{CodeEnd}}
{{PageSeeAlso}}
2016-03-18 11:36:04 +00:00
* [[_SNDSETPOS]]
* [[_SNDOPEN]]
2019-04-15 01:15:33 +00:00
{{PageNavigation}}
<