QB64-PE/internal/help/_SNDOPEN.txt

The '''_SNDOPEN''' function loads a sound file into memory and returns a [[LONG]] handle value above 0.


{{PageSyntax}}
:{{Parameter|sound_handle&}} = {{KW|_SNDOPEN}} (''filename$''[, "[VOL][,][SYNC][,][LEN][,][PAUSE][,][SETPOS]"])


{{PageDescription}}
* Returns a [[LONG]] ''sound handle'' value to the sound file in memory. '''A zero value means the sound could NOT be loaded.'''
* The literal or variable [[STRING]] sound ''file name'' can be WAV, OGG, AIFF, RIFF, VOC, MP3, MOD or MIDI file types.
*Capabilities of VOL, LEN, SYNC, SETPOS and PAUSE is a string of parameters separated by commas. It is NOT case sensitive.
* '''ALWAYS check the handle value returned is greater than zero before attempting to play the sound!'''
* The handle can be used by most of the SND sound playing Functions and Subs in QB64 except [[_SNDPLAYFILE]] which plays a sound file name directly and does not use a handle value.
* Handles can be closed with [[_SNDCLOSE]] when the sound is no longer necessary. 
*An '''ILLEGAL FUNCTION CALL''' error message means the capabilities$ string was invalid or two NON-SYNC sounds are using the same channel!
* If a WAV sound file won't play, try it using the Windows [[Windows_Libraries#Play_WAV_Sounds|Play WAV sounds library]] to check it or convert the sound file to OGG!


<center>'''Sound File Capabilities'''</center>
* Each capability can only be specified once and must be valid for that file or it won't play. Capabilities can be listed in any order. 
{{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}}

* The required sound file capabilities can make a difference as to whether a sound file can be played or not and how it can be used.

:'''Only one sound can exist on the primary channel, and it must be closed before playing another non-SYNC sound. 
<center>See {{KW|_SNDCOPY}} and {{KW|_SNDPLAYCOPY}}</center> 
{{TextStart}}                                  '''Capability Descriptions'''
 
   "'''VOL'''" can change the volume or balance of the sound using {{Cb|_SNDVOL}} and {{Cb|_SNDBAL}}.
   "'''LEN'''" can get the length of the sound using the {{Cb|_SNDLEN}} function.
   "'''PAUSE'''" can pause the sound using {{Cb|_SNDPAUSE}} and the {{Cb|_SNDPAUSED}} function can check it.
   "'''SETPOS'''" can change the position the sound is (or will be) playing from. See {{Cb|_SNDSETPOS}}.
   "'''SYNC'''" can load the sound onto a unique channel, to be played simultaneously with others. 

        '''When SYNC is not specified, the sound is loaded onto the primary channel.'''
{{TextEnd}}


''Snippet 1:'' Loading a sound file to use in the program later. Only load it ONCE and use the handle any time you want!
{{CodeStart}}
h& = {{Cl|_SNDOPEN}}("dog.wav","sync,vol")       'only use the capabilities of that file type
IF h& = 0 THEN BEEP ELSE {{Cl|_SNDPLAY}} h&      'check for valid handle before using!
{{CodeEnd}}


''Snippet 2:'' Playing a sound from 2 different speakers based on program results. Must use SYNC!
{{CodeStart}} '' ''
Laff& = {{Cl|_SNDOPEN}}("KONGlaff.ogg", "SYNC,VOL") 'load sound file and get LONG handle value 
{{Cl|IF}} LaffX! < -1 {{Cl|THEN}} LaffX! = -1   'set full volume to left speaker
{{Cl|IF}} LaffX! > 1 {{Cl|THEN}} LaffX! = 1     'set full volume to right speaker

{{Cl|_SNDBAL}} Laff&, LaffX!             'balance sound to left or right speaker
{{Cl|_SNDPLAY}} Laff&                    'play sound '' ''
{{CodeEnd}}



{{PageSeeAlso}}
* [[_SNDCLOSE]], [[_SNDPLAY]], [[_SNDSTOP]]
* [[_SNDPAUSE]], [[_SNDLOOP]], [[_SNDLIMIT]]
* [[_SNDSETPOS]], [[_SNDGETPOS]]
* [[_SNDPLAYING]], [[_SNDPAUSED]]
* [[_SNDCOPY]], [[_SNDPLAYCOPY]]
* [[_SNDBAL]], [[_SNDLEN]], [[_SNDVOL]]
* [[_SNDPLAYFILE]] {{text|(plays a named sound file directly and closes)}}
* [[_SNDRAW]], [[_SNDRATE]], [[_SNDRAWLEN]] {{text|{raw sounds without files)}}


{{PageNavigation}}