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__111111111.txt
Roland Heyder aeb9c0668b Updates help files for use with new Wiki parser (2nd try)
Note: Many files were removed (not yet existing/empty pages). The parser will try to download them on demand and will auto-generate text for missing pages (eg. most _gl pages).
2022-05-21 00:18:31 +02:00

38 lines
1.4 KiB
Plaintext

{{QBDLDATE:05-20-2022}}
{{QBDLTIME:23:10:54}}
{{DISPLAYTITLE:_SNDGETPOS}}
The [[_SNDGETPOS]] function returns the current playing position in seconds using a handle from [[_SNDOPEN]].
{{PageSyntax}}
:{{Parameter|position}} = [[_SNDGETPOS]]({{Parameter|handle&}})
{{PageDescription}}
*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.
* 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.
{{PageExamples}}
''Example:'' To check the current playing position in an MP3 file, use [[_SNDPLAY]] with [[_SNDGETPOS]] printed in a loop:
{{CodeStart}}
SoundFile& = {{Cl|_SNDOPEN}}("YourSoundFile.mp3") '<<< your MP3 sound file here!
{{Cl|_SNDSETPOS}} SoundFile&, 5.5 'set to play sound 5 1/2 seconds into music
{{Cl|_SNDPLAY}} SoundFile& 'play sound
Do: {{Cl|_LIMIT}} 60
LOCATE 5, 2: PRINT "Current play position> "; {{Cl|_SNDGETPOS}}(SoundFile&)
LOOP UNTIL {{Cl|_KEYDOWN}}(27) OR {{Cl|NOT}} {{Cl|_SNDPLAYING}}(SoundFile&) 'ESC or end of sound exit
{{CodeEnd}}
{{PageSeeAlso}}
* [[_SNDSETPOS]]
* [[_SNDOPEN]]
{{PageNavigation}}