1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-07-05 22:50:23 +00:00
QB64-PE/internal/help/_SNDPLAYCOPY.txt
2016-03-18 08:36:04 -03:00

57 lines
2.3 KiB
Plaintext

{{DISPLAYTITLE:_SNDPLAYCOPY}}
The [[_SNDPLAYCOPY]] statement copies a sound, plays it and automatically closes the copy using a handle parameter passed from [[_SNDOPEN]] or [[_SNDCOPY]]
{{PageSyntax}}
::: [[_SNDPLAYCOPY]] {{Parameter|handle&}}[, {{Parameter|volume!}}]
{{Parameters}}
* The [[LONG]] ''handle&'' value is returned by [[_SNDOPEN]] using a specific sound file.
* The ''volume'' parameter can be any [[SINGLE]] value from 0 (no volume) to 1 (full volume).
{{PageDescription}}
* Opened sound files must have the "SYNC" capability to use this statement. (Currently WAV, OGG, AIF, RIF and VOC)
*Makes coding easier by doing all of the following automatically:
:#Copies/duplicates the source handle (see [[_SNDCOPY}]]
:#Changes the volume of the copy if volume is passed (file must have "VOL" capability)
:#Plays the copy
:#Closes the copy
* This statement is a better choice than [[_SNDPLAYFILE]] if the sound will be played often, reducing the burden on computer.
{{TextStart}} QB64 supports the following sound file formats ('''Bold is a guaranteed capability'''):
WAV = "'''VOL,SYNC,LEN''',PAUSE" [http://www.rarewares.org/ogg-oggdropxpd.php Free WAV to OGG GUI converter]
OGG = "VOL,SYNC,LEN,PAUSE" [http://www.rarewares.org/ogg-oggenc.php Free WAV to OGG converter]
AIF = "VOL,SYNC,LEN,PAUSE"
RIF = "VOL,SYNC,LEN,PAUSE"
VOC = "VOL,SYNC,LEN,PAUSE"
MID = "'''VOL'''"
MOD = "VOL,PAUSE"
MP3 = "'''VOL''',PAUSE,SETPOS" [http://www.freemp3wmaconverter.com/index.html Free WMA, MP3 and OGG converter]
''Note:'' {{Cb|_SNDBAL}} only affects MP3 volume. Sound will reside in main channel.
{{TextEnd}}
''Example 1:'' Playing a sound at half volume.
{{CodeStart}} '' ''
{{Cl|_SNDPLAYCOPY}} applause&, 0.5 '' ''
{{CodeEnd}}
''Example 2:'' Playing a song at random volumes.
{{CodeStart}} '' ''
chomp& = _SNDOPEN("chomp.wav", "VOL,SYNC")
_SNDPLAYCOPY chomp&, 0.5 + RND * 0.49 '' ''
{{CodeEnd}}
{{PageSeeAlso}}
* [[_SNDOPEN]]
* [[_SNDCOPY]]
* [[_SNDPLAYFILE]] {{text|(plays sound files by file name)}}
{{PageNavigation}}