1
1
Fork 0
mirror of https://github.com/QB64Official/qb64.git synced 2024-07-01 09:10:37 +00:00
qb64/internal/help/_SNDPLAYCOPY.txt
2021-02-28 11:47:33 -03:00

45 lines
1.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!}}]
{{PageParameters}}
* The [[LONG]] {{Parameter|handle&}} value is returned by [[_SNDOPEN]] using a specific sound file.
* The {{Parameter|volume!}} parameter can be any [[SINGLE]] value from 0 (no volume) to 1 (full volume).
{{PageDescription}}
*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.
:#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 the computer.
{{PageExamples}}
''Example 1:'' Playing a previously opened sound at half volume.
{{CodeStart}} '' ''
{{Cl|_SNDPLAYCOPY}} applause&, 0.5 '' ''
{{CodeEnd}}
''Example 2:'' Playing a song at random volumes.
{{CodeStart}} '' ''
chomp& = _SNDOPEN("chomp.wav")
_SNDPLAYCOPY chomp&, 0.5 + RND * 0.49 '' ''
{{CodeEnd}}
{{PageSeeAlso}}
* [[_SNDOPEN]]
* [[_SNDCOPY]]
* [[_SNDPLAYFILE]]
{{PageNavigation}}