<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: SDL_audio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SDL_audio.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="SDL__stdinc_8h_source.html">SDL_stdinc.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__error_8h_source.html">SDL_error.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__endian_8h_source.html">SDL_endian.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__mutex_8h_source.html">SDL_mutex.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__thread_8h_source.html">SDL_thread.h</a>"</code><br />
<code>#include "<a class="el" href="SDL__rwops_8h_source.html">SDL_rwops.h</a>"</code><br />
<code>#include "<a class="el" href="begin__code_8h_source.html">begin_code.h</a>"</code><br />
<code>#include "<a class="el" href="close__code_8h_source.html">close_code.h</a>"</code><br />
</div>
<p><a href="SDL__audio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A structure to hold a set of audio conversion filters and buffers. <a href="structSDL__AudioCVT.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3d38380ac4a45a68a0e1c1a7a02bd290"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a3d38380ac4a45a68a0e1c1a7a02bd290">SDL_AUDIOCVT_MAX_FILTERS</a>   9</td></tr>
<tr class="memdesc:a3d38380ac4a45a68a0e1c1a7a02bd290"><td class="mdescLeft"> </td><td class="mdescRight">Upper limit of filters in <a class="el" href="structSDL__AudioCVT.html" title="A structure to hold a set of audio conversion filters and buffers.">SDL_AudioCVT</a>. <a href="#a3d38380ac4a45a68a0e1c1a7a02bd290">More...</a><br /></td></tr>
<tr class="separator:a3d38380ac4a45a68a0e1c1a7a02bd290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac34fc6df953e2bae89919edaaa740ff3"><td class="memItemLeft" align="right" valign="top"><a id="ac34fc6df953e2bae89919edaaa740ff3"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIOCVT_PACKED</b></td></tr>
<tr class="separator:ac34fc6df953e2bae89919edaaa740ff3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a611f76dc30ba9891239bcce3f9b472b5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a611f76dc30ba9891239bcce3f9b472b5">SDL_LoadWAV</a>(file, spec, audio_buf, audio_len)   <a class="el" href="SDL__audio_8h.html#a7e5d38e8c1f8951704a76330c3b1ac81">SDL_LoadWAV_RW</a>(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)</td></tr>
<tr class="separator:a611f76dc30ba9891239bcce3f9b472b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa8e5e92d4424b0c599e7c813c91f720"><td class="memItemLeft" align="right" valign="top"><a id="afa8e5e92d4424b0c599e7c813c91f720"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_MIX_MAXVOLUME</b>   128</td></tr>
<tr class="separator:afa8e5e92d4424b0c599e7c813c91f720"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Audio flags</div></td></tr>
<tr class="memitem:ade51417b52dbd9511d56066caae0038b"><td class="memItemLeft" align="right" valign="top"><a id="ade51417b52dbd9511d56066caae0038b"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_MASK_BITSIZE</b>   (0xFF)</td></tr>
<tr class="separator:ade51417b52dbd9511d56066caae0038b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50b4779246a7fbf4a39205a396ec7ea6"><td class="memItemLeft" align="right" valign="top"><a id="a50b4779246a7fbf4a39205a396ec7ea6"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_MASK_DATATYPE</b>   (1<<8)</td></tr>
<tr class="separator:a50b4779246a7fbf4a39205a396ec7ea6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab070cdd4d92ee3824cafefe24c620326"><td class="memItemLeft" align="right" valign="top"><a id="ab070cdd4d92ee3824cafefe24c620326"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_MASK_ENDIAN</b>   (1<<12)</td></tr>
<tr class="separator:ab070cdd4d92ee3824cafefe24c620326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06fc66d3c421c6c9b733854b73d104ce"><td class="memItemLeft" align="right" valign="top"><a id="a06fc66d3c421c6c9b733854b73d104ce"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_MASK_SIGNED</b>   (1<<15)</td></tr>
<tr class="separator:a06fc66d3c421c6c9b733854b73d104ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe2f2a9193ad3a8fa822787098df266d"><td class="memItemLeft" align="right" valign="top"><a id="abe2f2a9193ad3a8fa822787098df266d"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_BITSIZE</b>(x)   (x & SDL_AUDIO_MASK_BITSIZE)</td></tr>
<tr class="separator:abe2f2a9193ad3a8fa822787098df266d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86ee1651c17955594a547e96b9c94890"><td class="memItemLeft" align="right" valign="top"><a id="a86ee1651c17955594a547e96b9c94890"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISFLOAT</b>(x)   (x & SDL_AUDIO_MASK_DATATYPE)</td></tr>
<tr class="separator:a86ee1651c17955594a547e96b9c94890"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27e82da51370d77f83e4ea2098c9d38c"><td class="memItemLeft" align="right" valign="top"><a id="a27e82da51370d77f83e4ea2098c9d38c"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISBIGENDIAN</b>(x)   (x & SDL_AUDIO_MASK_ENDIAN)</td></tr>
<tr class="separator:a27e82da51370d77f83e4ea2098c9d38c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a518fa9273a6a8b8b6f1d599ccca71434"><td class="memItemLeft" align="right" valign="top"><a id="a518fa9273a6a8b8b6f1d599ccca71434"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISSIGNED</b>(x)   (x & SDL_AUDIO_MASK_SIGNED)</td></tr>
<tr class="separator:a518fa9273a6a8b8b6f1d599ccca71434"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a197decf956e451a5a10e7221974b0548"><td class="memItemLeft" align="right" valign="top"><a id="a197decf956e451a5a10e7221974b0548"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISINT</b>(x)   (!SDL_AUDIO_ISFLOAT(x))</td></tr>
<tr class="separator:a197decf956e451a5a10e7221974b0548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2026be07a23986f2b7681a3500c8c341"><td class="memItemLeft" align="right" valign="top"><a id="a2026be07a23986f2b7681a3500c8c341"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISLITTLEENDIAN</b>(x)   (!SDL_AUDIO_ISBIGENDIAN(x))</td></tr>
<tr class="separator:a2026be07a23986f2b7681a3500c8c341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9f715eb12c43474ad0aae52976e5095"><td class="memItemLeft" align="right" valign="top"><a id="aa9f715eb12c43474ad0aae52976e5095"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ISUNSIGNED</b>(x)   (!SDL_AUDIO_ISSIGNED(x))</td></tr>
<tr class="separator:aa9f715eb12c43474ad0aae52976e5095"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Audio format flags</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Defaults to LSB byte order. </p>
</div></td></tr>
<tr class="memitem:a6468b4b3fc53ada655eca866e491d75f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a6468b4b3fc53ada655eca866e491d75f">AUDIO_U8</a>   0x0008</td></tr>
<tr class="separator:a6468b4b3fc53ada655eca866e491d75f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a883b3d4539451e49bf014dde0f9cca29"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a883b3d4539451e49bf014dde0f9cca29">AUDIO_S8</a>   0x8008</td></tr>
<tr class="separator:a883b3d4539451e49bf014dde0f9cca29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06808f806896c4d211314990c354b7fc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a06808f806896c4d211314990c354b7fc">AUDIO_U16LSB</a>   0x0010</td></tr>
<tr class="separator:a06808f806896c4d211314990c354b7fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23838d612e88ce72d82c3e51460f831b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a23838d612e88ce72d82c3e51460f831b">AUDIO_S16LSB</a>   0x8010</td></tr>
<tr class="separator:a23838d612e88ce72d82c3e51460f831b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b8052d0c49d14a2e3edf08eade52d3a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a3b8052d0c49d14a2e3edf08eade52d3a">AUDIO_U16MSB</a>   0x1010</td></tr>
<tr class="separator:a3b8052d0c49d14a2e3edf08eade52d3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3109dfb1d7aab29dff2b62d630e690ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a3109dfb1d7aab29dff2b62d630e690ca">AUDIO_S16MSB</a>   0x9010</td></tr>
<tr class="separator:a3109dfb1d7aab29dff2b62d630e690ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adee2cdf7dbda44620da17cd58ca819ea"><td class="memItemLeft" align="right" valign="top"><a id="adee2cdf7dbda44620da17cd58ca819ea"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_U16</b>   <a class="el" href="SDL__audio_8h.html#a06808f806896c4d211314990c354b7fc">AUDIO_U16LSB</a></td></tr>
<tr class="separator:adee2cdf7dbda44620da17cd58ca819ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f4950d8eee757ebed84e50fb9316b12"><td class="memItemLeft" align="right" valign="top"><a id="a4f4950d8eee757ebed84e50fb9316b12"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_S16</b>   <a class="el" href="SDL__audio_8h.html#a23838d612e88ce72d82c3e51460f831b">AUDIO_S16LSB</a></td></tr>
<tr class="separator:a4f4950d8eee757ebed84e50fb9316b12"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">int32 support</div></td></tr>
<tr class="memitem:ac81f9cc5739cea67436daf2689d29559"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#ac81f9cc5739cea67436daf2689d29559">AUDIO_S32LSB</a>   0x8020</td></tr>
<tr class="separator:ac81f9cc5739cea67436daf2689d29559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30641d7487680630c231b3415ecd47b6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a30641d7487680630c231b3415ecd47b6">AUDIO_S32MSB</a>   0x9020</td></tr>
<tr class="separator:a30641d7487680630c231b3415ecd47b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaffc0931336d0d79717a144039670223"><td class="memItemLeft" align="right" valign="top"><a id="aaffc0931336d0d79717a144039670223"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_S32</b>   <a class="el" href="SDL__audio_8h.html#ac81f9cc5739cea67436daf2689d29559">AUDIO_S32LSB</a></td></tr>
<tr class="separator:aaffc0931336d0d79717a144039670223"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">float32 support</div></td></tr>
<tr class="memitem:afaef57ecb718053b572c539e27e72d61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#afaef57ecb718053b572c539e27e72d61">AUDIO_F32LSB</a>   0x8120</td></tr>
<tr class="separator:afaef57ecb718053b572c539e27e72d61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d57382c01fdcd78cbbbb480605d91ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a2d57382c01fdcd78cbbbb480605d91ef">AUDIO_F32MSB</a>   0x9120</td></tr>
<tr class="separator:a2d57382c01fdcd78cbbbb480605d91ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4633772ee12935960a25ff8334c29990"><td class="memItemLeft" align="right" valign="top"><a id="a4633772ee12935960a25ff8334c29990"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_F32</b>   <a class="el" href="SDL__audio_8h.html#afaef57ecb718053b572c539e27e72d61">AUDIO_F32LSB</a></td></tr>
<tr class="separator:a4633772ee12935960a25ff8334c29990"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Native audio byte ordering</div></td></tr>
<tr class="memitem:afafc9f93ee2c583130c4152e243ba5b8"><td class="memItemLeft" align="right" valign="top"><a id="afafc9f93ee2c583130c4152e243ba5b8"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_U16SYS</b>   <a class="el" href="SDL__audio_8h.html#a06808f806896c4d211314990c354b7fc">AUDIO_U16LSB</a></td></tr>
<tr class="separator:afafc9f93ee2c583130c4152e243ba5b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4722de7e16982dd078f2b8cc64b9bae7"><td class="memItemLeft" align="right" valign="top"><a id="a4722de7e16982dd078f2b8cc64b9bae7"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_S16SYS</b>   <a class="el" href="SDL__audio_8h.html#a23838d612e88ce72d82c3e51460f831b">AUDIO_S16LSB</a></td></tr>
<tr class="separator:a4722de7e16982dd078f2b8cc64b9bae7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafcbadd8f6fa14a878178bf18b883675"><td class="memItemLeft" align="right" valign="top"><a id="aafcbadd8f6fa14a878178bf18b883675"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_S32SYS</b>   <a class="el" href="SDL__audio_8h.html#ac81f9cc5739cea67436daf2689d29559">AUDIO_S32LSB</a></td></tr>
<tr class="separator:aafcbadd8f6fa14a878178bf18b883675"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af001a94efb4bea024c233cae0cf98e6b"><td class="memItemLeft" align="right" valign="top"><a id="af001a94efb4bea024c233cae0cf98e6b"></a>
#define </td><td class="memItemRight" valign="bottom"><b>AUDIO_F32SYS</b>   <a class="el" href="SDL__audio_8h.html#afaef57ecb718053b572c539e27e72d61">AUDIO_F32LSB</a></td></tr>
<tr class="separator:af001a94efb4bea024c233cae0cf98e6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Allow change flags</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Which audio format changes are allowed when opening a device. </p>
</div></td></tr>
<tr class="memitem:a4b05381c3f0871e9a88b46959365f796"><td class="memItemLeft" align="right" valign="top"><a id="a4b05381c3f0871e9a88b46959365f796"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ALLOW_FREQUENCY_CHANGE</b>   0x00000001</td></tr>
<tr class="separator:a4b05381c3f0871e9a88b46959365f796"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32dbc13d28bdc43d7e07e080e24fb573"><td class="memItemLeft" align="right" valign="top"><a id="a32dbc13d28bdc43d7e07e080e24fb573"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ALLOW_FORMAT_CHANGE</b>   0x00000002</td></tr>
<tr class="separator:a32dbc13d28bdc43d7e07e080e24fb573"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad9eab304c2cee512410508811268575"><td class="memItemLeft" align="right" valign="top"><a id="aad9eab304c2cee512410508811268575"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ALLOW_CHANNELS_CHANGE</b>   0x00000004</td></tr>
<tr class="separator:aad9eab304c2cee512410508811268575"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f5fcb9e11d3479e9e987a5d434d88ba"><td class="memItemLeft" align="right" valign="top"><a id="a2f5fcb9e11d3479e9e987a5d434d88ba"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ALLOW_SAMPLES_CHANGE</b>   0x00000008</td></tr>
<tr class="separator:a2f5fcb9e11d3479e9e987a5d434d88ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbee9b7a641274139377898c21df92e8"><td class="memItemLeft" align="right" valign="top"><a id="acbee9b7a641274139377898c21df92e8"></a>
#define </td><td class="memItemRight" valign="bottom"><b>SDL_AUDIO_ALLOW_ANY_CHANGE</b>   (SDL_AUDIO_ALLOW_FREQUENCY_CHANGE|SDL_AUDIO_ALLOW_FORMAT_CHANGE|SDL_AUDIO_ALLOW_CHANNELS_CHANGE|SDL_AUDIO_ALLOW_SAMPLES_CHANGE)</td></tr>
<tr class="separator:acbee9b7a641274139377898c21df92e8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a491ed103fd25d920c4e6b7495217ce66"><td class="memItemLeft" align="right" valign="top">typedef Uint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a></td></tr>
<tr class="memdesc:a491ed103fd25d920c4e6b7495217ce66"><td class="mdescLeft"> </td><td class="mdescRight">Audio format flags. <a href="#a491ed103fd25d920c4e6b7495217ce66">More...</a><br /></td></tr>
<tr class="separator:a491ed103fd25d920c4e6b7495217ce66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a379fcc25845e46bfa80cb3619fc2821c"><td class="memItemLeft" align="right" valign="top">typedef void(SDLCALL * </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a379fcc25845e46bfa80cb3619fc2821c">SDL_AudioCallback</a>) (void *userdata, Uint8 *stream, int len)</td></tr>
<tr class="separator:a379fcc25845e46bfa80cb3619fc2821c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77faa7fe3d22c03ee61466a901c22a25"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a77faa7fe3d22c03ee61466a901c22a25">SDL_AudioSpec</a></td></tr>
<tr class="separator:a77faa7fe3d22c03ee61466a901c22a25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71a65ffd977afe9c3fef116a5bc9ee27"><td class="memItemLeft" align="right" valign="top"><a id="a71a65ffd977afe9c3fef116a5bc9ee27"></a>
typedef <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td><td class="memItemRight" valign="bottom"><b>format</b></td></tr>
<tr class="separator:a71a65ffd977afe9c3fef116a5bc9ee27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc284f22978d12646dbffa692fe0c0ae"><td class="memItemLeft" align="right" valign="top"><a id="afc284f22978d12646dbffa692fe0c0ae"></a>
typedef struct <a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> </td><td class="memItemRight" valign="bottom"><b>SDL_AudioCVT</b></td></tr>
<tr class="separator:afc284f22978d12646dbffa692fe0c0ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a677d9d2a6f77a7502a0dc8b45ad211bb"><td class="memItemLeft" align="right" valign="top">typedef Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a></td></tr>
<tr class="separator:a677d9d2a6f77a7502a0dc8b45ad211bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f8d82f8013b06777000675a9636071e"><td class="memItemLeft" align="right" valign="top"><a id="a1f8d82f8013b06777000675a9636071e"></a>
typedef struct _SDL_AudioStream </td><td class="memItemRight" valign="bottom"><b>SDL_AudioStream</b></td></tr>
<tr class="separator:a1f8d82f8013b06777000675a9636071e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa5cb90967788ada2711894ca158ece01"><td class="memItemLeft" align="right" valign="top"><a id="aa5cb90967788ada2711894ca158ece01"></a>
typedef </td><td class="memItemRight" valign="bottom"><b>void</b> (SDLCALL *SDL_AudioFilter)(struct <a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> *cvt</td></tr>
<tr class="separator:aa5cb90967788ada2711894ca158ece01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15b19f26c314e3640ea396251a1ff010"><td class="memItemLeft" align="right" valign="top">DECLSPEC const char *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a15b19f26c314e3640ea396251a1ff010">SDL_GetCurrentAudioDriver</a> (void)</td></tr>
<tr class="separator:a15b19f26c314e3640ea396251a1ff010"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2edf30e7747584e28041b4986f89f440"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio</a> (<a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *desired, <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *obtained)</td></tr>
<tr class="separator:a2edf30e7747584e28041b4986f89f440"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae165f64b3f0fecfebe1c97731600ca59"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#ae165f64b3f0fecfebe1c97731600ca59">SDL_GetNumAudioDevices</a> (int iscapture)</td></tr>
<tr class="separator:ae165f64b3f0fecfebe1c97731600ca59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a846bae7fa1183b644c96cbb49e2c8cf5"><td class="memItemLeft" align="right" valign="top">DECLSPEC const char *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a846bae7fa1183b644c96cbb49e2c8cf5">SDL_GetAudioDeviceName</a> (int index, int iscapture)</td></tr>
<tr class="separator:a846bae7fa1183b644c96cbb49e2c8cf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af54523e415de7c7fdd0d48a76ab58bb3"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#af54523e415de7c7fdd0d48a76ab58bb3">SDL_OpenAudioDevice</a> (const char *device, int iscapture, const <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *desired, <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *obtained, int allowed_changes)</td></tr>
<tr class="separator:af54523e415de7c7fdd0d48a76ab58bb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e5d38e8c1f8951704a76330c3b1ac81"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a7e5d38e8c1f8951704a76330c3b1ac81">SDL_LoadWAV_RW</a> (<a class="el" href="structSDL__RWops.html">SDL_RWops</a> *src, int freesrc, <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> *spec, Uint8 **audio_buf, Uint32 *audio_len)</td></tr>
<tr class="memdesc:a7e5d38e8c1f8951704a76330c3b1ac81"><td class="mdescLeft"> </td><td class="mdescRight">Load the audio data of a WAVE file into memory. <a href="#a7e5d38e8c1f8951704a76330c3b1ac81">More...</a><br /></td></tr>
<tr class="separator:a7e5d38e8c1f8951704a76330c3b1ac81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a631aa8624575603df2c5ab9257feee59"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a631aa8624575603df2c5ab9257feee59">SDL_FreeWAV</a> (Uint8 *audio_buf)</td></tr>
<tr class="separator:a631aa8624575603df2c5ab9257feee59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41e1602bc7cd4edb87ca779cf01d40bb"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a41e1602bc7cd4edb87ca779cf01d40bb">SDL_BuildAudioCVT</a> (<a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> *cvt, <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> src_format, Uint8 src_channels, int src_rate, <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> dst_format, Uint8 dst_channels, int dst_rate)</td></tr>
<tr class="separator:a41e1602bc7cd4edb87ca779cf01d40bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e8660222356e07002dde4928118b7df"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a8e8660222356e07002dde4928118b7df">SDL_ConvertAudio</a> (<a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> *cvt)</td></tr>
<tr class="separator:a8e8660222356e07002dde4928118b7df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d9be9cdf2dc76ae541f9013c16a94f4"><td class="memItemLeft" align="right" valign="top">DECLSPEC SDL_AudioStream *SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> (const <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> src_format, const Uint8 src_channels, const int src_rate, const <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> dst_format, const Uint8 dst_channels, const int dst_rate)</td></tr>
<tr class="separator:a5d9be9cdf2dc76ae541f9013c16a94f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1cb87e81c853b21f025f42f336ad814"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> (SDL_AudioStream *stream, const void *buf, int len)</td></tr>
<tr class="separator:ae1cb87e81c853b21f025f42f336ad814"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a8996f0cb3adf37d4c1c5ed4eef5b18"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> (SDL_AudioStream *stream, void *buf, int len)</td></tr>
<tr class="separator:a6a8996f0cb3adf37d4c1c5ed4eef5b18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4667c3464058d7be76c1f8349d7656de"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> (SDL_AudioStream *stream)</td></tr>
<tr class="separator:a4667c3464058d7be76c1f8349d7656de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add31a8f8ccd99c87b71bef2a9cf93f9b"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> (SDL_AudioStream *stream)</td></tr>
<tr class="separator:add31a8f8ccd99c87b71bef2a9cf93f9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a74da30372d4a2c3db7ceef406d65fb"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> (SDL_AudioStream *stream)</td></tr>
<tr class="separator:a7a74da30372d4a2c3db7ceef406d65fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab093ff9871e917dac8d2fa5169970cf5"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> (SDL_AudioStream *stream)</td></tr>
<tr class="separator:ab093ff9871e917dac8d2fa5169970cf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9ad945b4b15d816802f5a79da06c9f9"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#ab9ad945b4b15d816802f5a79da06c9f9">SDL_MixAudio</a> (Uint8 *dst, const Uint8 *src, Uint32 len, int volume)</td></tr>
<tr class="separator:ab9ad945b4b15d816802f5a79da06c9f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27a0ad33d17f87a2d7574be78d2f39b7"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a27a0ad33d17f87a2d7574be78d2f39b7">SDL_MixAudioFormat</a> (Uint8 *dst, const Uint8 *src, <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> format, Uint32 len, int volume)</td></tr>
<tr class="separator:a27a0ad33d17f87a2d7574be78d2f39b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19ef6fa2396f581aaf4d9a9512972268"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio</a> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev, const void *data, Uint32 len)</td></tr>
<tr class="separator:a19ef6fa2396f581aaf4d9a9512972268"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ed6333b8b294eafb6a9435fd8ff89fa"><td class="memItemLeft" align="right" valign="top">DECLSPEC Uint32 SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a6ed6333b8b294eafb6a9435fd8ff89fa">SDL_DequeueAudio</a> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev, void *data, Uint32 len)</td></tr>
<tr class="separator:a6ed6333b8b294eafb6a9435fd8ff89fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11a1d59fd68f8a416fa72bf14f5c9ec3"><td class="memItemLeft" align="right" valign="top">DECLSPEC Uint32 SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a11a1d59fd68f8a416fa72bf14f5c9ec3">SDL_GetQueuedAudioSize</a> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:a11a1d59fd68f8a416fa72bf14f5c9ec3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a073ed5d40cce01e839b34570c1c7ed50"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#a073ed5d40cce01e839b34570c1c7ed50">SDL_ClearQueuedAudio</a> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:a073ed5d40cce01e839b34570c1c7ed50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa176acc650e66e1d38814cbed3ca258e"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="SDL__audio_8h.html#aa176acc650e66e1d38814cbed3ca258e">SDL_CloseAudio</a> (void)</td></tr>
<tr class="separator:aa176acc650e66e1d38814cbed3ca258e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd910f31079d53b6c0ea8bf32dac0ce6"><td class="memItemLeft" align="right" valign="top"><a id="abd910f31079d53b6c0ea8bf32dac0ce6"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_CloseAudioDevice</b> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:abd910f31079d53b6c0ea8bf32dac0ce6"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Driver discovery functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions return the list of built in audio drivers, in the order that they are normally initialized by default. </p>
</div></td></tr>
<tr class="memitem:ae3cb6a3321d9ee32f3c05ea0794c5fb8"><td class="memItemLeft" align="right" valign="top"><a id="ae3cb6a3321d9ee32f3c05ea0794c5fb8"></a>
DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_GetNumAudioDrivers</b> (void)</td></tr>
<tr class="separator:ae3cb6a3321d9ee32f3c05ea0794c5fb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabc8b6439ff8d1195b9f49e9c00b15c1"><td class="memItemLeft" align="right" valign="top"><a id="aabc8b6439ff8d1195b9f49e9c00b15c1"></a>
DECLSPEC const char *SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_GetAudioDriver</b> (int index)</td></tr>
<tr class="separator:aabc8b6439ff8d1195b9f49e9c00b15c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Initialization and cleanup</div></td></tr>
<tr class="memitem:ae3667d6ba706a3ca7affd8611632fa2c"><td class="memItemLeft" align="right" valign="top"><a id="ae3667d6ba706a3ca7affd8611632fa2c"></a>
DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_AudioInit</b> (const char *driver_name)</td></tr>
<tr class="separator:ae3667d6ba706a3ca7affd8611632fa2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a478c602cbfaab8663cb4f58a62600323"><td class="memItemLeft" align="right" valign="top"><a id="a478c602cbfaab8663cb4f58a62600323"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_AudioQuit</b> (void)</td></tr>
<tr class="separator:a478c602cbfaab8663cb4f58a62600323"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Pause audio functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions pause and unpause the audio callback processing. They should be called with a parameter of 0 after opening the audio device to start playing sound. This is so you can safely initialize data for your callback function after opening the audio device. Silence will be written to the audio device during the pause. </p>
</div></td></tr>
<tr class="memitem:aa68e60a33666ff4f2d36f3827b1d6061"><td class="memItemLeft" align="right" valign="top"><a id="aa68e60a33666ff4f2d36f3827b1d6061"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_PauseAudio</b> (int pause_on)</td></tr>
<tr class="separator:aa68e60a33666ff4f2d36f3827b1d6061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4c8e2a896ccf86599435af81fca928c"><td class="memItemLeft" align="right" valign="top"><a id="ab4c8e2a896ccf86599435af81fca928c"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_PauseAudioDevice</b> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev, int pause_on)</td></tr>
<tr class="separator:ab4c8e2a896ccf86599435af81fca928c"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Audio lock functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The lock manipulated by these functions protects the callback function. During a SDL_LockAudio()/SDL_UnlockAudio() pair, you can be guaranteed that the callback function is not running. Do not call these from the callback function or you will cause deadlock. </p>
</div></td></tr>
<tr class="memitem:a7ffa484f230f6085e271a4f43e678f06"><td class="memItemLeft" align="right" valign="top"><a id="a7ffa484f230f6085e271a4f43e678f06"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_LockAudio</b> (void)</td></tr>
<tr class="separator:a7ffa484f230f6085e271a4f43e678f06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9769845303f88f084f051b99e55b62a1"><td class="memItemLeft" align="right" valign="top"><a id="a9769845303f88f084f051b99e55b62a1"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_LockAudioDevice</b> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:a9769845303f88f084f051b99e55b62a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76d8179bee14dad268e65378058d897d"><td class="memItemLeft" align="right" valign="top"><a id="a76d8179bee14dad268e65378058d897d"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_UnlockAudio</b> (void)</td></tr>
<tr class="separator:a76d8179bee14dad268e65378058d897d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37427a5d47e10103f2fff8165d5f9000"><td class="memItemLeft" align="right" valign="top"><a id="a37427a5d47e10103f2fff8165d5f9000"></a>
DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_UnlockAudioDevice</b> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:a37427a5d47e10103f2fff8165d5f9000"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Audio state</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpcef14621c5df51e9b3ed9d0b005e108e"></a>Get the current audio state. </p>
</td></tr>
<tr class="memitem:a24a02745f01041dd2825d7e26502eef2"><td class="memItemLeft" align="right" valign="top"><a id="a24a02745f01041dd2825d7e26502eef2"></a>enum  </td><td class="memItemRight" valign="bottom"><b>SDL_AudioStatus</b> { <b>SDL_AUDIO_STOPPED</b> = 0,
<b>SDL_AUDIO_PLAYING</b>,
<b>SDL_AUDIO_PAUSED</b>
}</td></tr>
<tr class="separator:a24a02745f01041dd2825d7e26502eef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a568e10207e6ff53f8e238a0d562ef594"><td class="memItemLeft" align="right" valign="top"><a id="a568e10207e6ff53f8e238a0d562ef594"></a>
DECLSPEC SDL_AudioStatus SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_GetAudioStatus</b> (void)</td></tr>
<tr class="separator:a568e10207e6ff53f8e238a0d562ef594"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac86fde79b1afda3f0fb8e9a027434a69"><td class="memItemLeft" align="right" valign="top"><a id="ac86fde79b1afda3f0fb8e9a027434a69"></a>
DECLSPEC SDL_AudioStatus SDLCALL </td><td class="memItemRight" valign="bottom"><b>SDL_GetAudioDeviceStatus</b> (<a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> dev)</td></tr>
<tr class="separator:ac86fde79b1afda3f0fb8e9a027434a69"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Access to the raw audio mixing buffer for the SDL library. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="afaef57ecb718053b572c539e27e72d61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afaef57ecb718053b572c539e27e72d61">◆ </a></span>AUDIO_F32LSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_F32LSB   0x8120</td>
</tr>
</table>
</div><div class="memdoc">
<p>32-bit floating point samples </p>
</div>
</div>
<a id="a2d57382c01fdcd78cbbbb480605d91ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d57382c01fdcd78cbbbb480605d91ef">◆ </a></span>AUDIO_F32MSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_F32MSB   0x9120</td>
</tr>
</table>
</div><div class="memdoc">
<p>As above, but big-endian byte order </p>
</div>
</div>
<a id="a23838d612e88ce72d82c3e51460f831b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23838d612e88ce72d82c3e51460f831b">◆ </a></span>AUDIO_S16LSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_S16LSB   0x8010</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 16-bit samples </p>
</div>
</div>
<a id="a3109dfb1d7aab29dff2b62d630e690ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3109dfb1d7aab29dff2b62d630e690ca">◆ </a></span>AUDIO_S16MSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_S16MSB   0x9010</td>
</tr>
</table>
</div><div class="memdoc">
<p>As above, but big-endian byte order </p>
</div>
</div>
<a id="ac81f9cc5739cea67436daf2689d29559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac81f9cc5739cea67436daf2689d29559">◆ </a></span>AUDIO_S32LSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_S32LSB   0x8020</td>
</tr>
</table>
</div><div class="memdoc">
<p>32-bit integer samples </p>
</div>
</div>
<a id="a30641d7487680630c231b3415ecd47b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30641d7487680630c231b3415ecd47b6">◆ </a></span>AUDIO_S32MSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_S32MSB   0x9020</td>
</tr>
</table>
</div><div class="memdoc">
<p>As above, but big-endian byte order </p>
</div>
</div>
<a id="a883b3d4539451e49bf014dde0f9cca29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883b3d4539451e49bf014dde0f9cca29">◆ </a></span>AUDIO_S8</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_S8   0x8008</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 8-bit samples </p>
</div>
</div>
<a id="a06808f806896c4d211314990c354b7fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06808f806896c4d211314990c354b7fc">◆ </a></span>AUDIO_U16LSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_U16LSB   0x0010</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsigned 16-bit samples </p>
</div>
</div>
<a id="a3b8052d0c49d14a2e3edf08eade52d3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b8052d0c49d14a2e3edf08eade52d3a">◆ </a></span>AUDIO_U16MSB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_U16MSB   0x1010</td>
</tr>
</table>
</div><div class="memdoc">
<p>As above, but big-endian byte order </p>
</div>
</div>
<a id="a6468b4b3fc53ada655eca866e491d75f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6468b4b3fc53ada655eca866e491d75f">◆ </a></span>AUDIO_U8</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUDIO_U8   0x0008</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsigned 8-bit samples </p>
</div>
</div>
<a id="a3d38380ac4a45a68a0e1c1a7a02bd290"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d38380ac4a45a68a0e1c1a7a02bd290">◆ </a></span>SDL_AUDIOCVT_MAX_FILTERS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDL_AUDIOCVT_MAX_FILTERS   9</td>
</tr>
</table>
</div><div class="memdoc">
<p>Upper limit of filters in <a class="el" href="structSDL__AudioCVT.html" title="A structure to hold a set of audio conversion filters and buffers.">SDL_AudioCVT</a>. </p>
<p>The maximum number of SDL_AudioFilter functions in <a class="el" href="structSDL__AudioCVT.html" title="A structure to hold a set of audio conversion filters and buffers.">SDL_AudioCVT</a> is currently limited to 9. The <a class="el" href="structSDL__AudioCVT.html#afeb8dc60716644de3b681653442de1db">SDL_AudioCVT.filters</a> array has 10 pointers, one of which is the terminating NULL pointer. </p>
</div>
</div>
<a id="a611f76dc30ba9891239bcce3f9b472b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a611f76dc30ba9891239bcce3f9b472b5">◆ </a></span>SDL_LoadWAV</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDL_LoadWAV</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">file, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">spec, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">audio_buf, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">audio_len </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="SDL__audio_8h.html#a7e5d38e8c1f8951704a76330c3b1ac81">SDL_LoadWAV_RW</a>(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a WAV from a file. Compatibility convenience function. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a379fcc25845e46bfa80cb3619fc2821c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a379fcc25845e46bfa80cb3619fc2821c">◆ </a></span>SDL_AudioCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(SDLCALL * SDL_AudioCallback) (void *userdata, Uint8 *stream, int len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called when the audio device needs more data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">userdata</td><td>An application-specific parameter saved in the <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> structure </td></tr>
<tr><td class="paramname">stream</td><td>A pointer to the audio data buffer. </td></tr>
<tr><td class="paramname">len</td><td>The length of that buffer in bytes.</td></tr>
</table>
</dd>
</dl>
<p>Once the callback returns, the buffer will no longer be valid. Stereo samples are stored in a LRLRLR ordering.</p>
<p>You can choose to avoid callbacks and use <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a> instead, if you like. Just open your audio device with a NULL callback. </p>
</div>
</div>
<a id="a677d9d2a6f77a7502a0dc8b45ad211bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a677d9d2a6f77a7502a0dc8b45ad211bb">◆ </a></span>SDL_AudioDeviceID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Uint32 <a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>SDL Audio Device IDs.</p>
<p>A successful call to <a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a> is always device id 1, and legacy SDL audio APIs assume you want this device ID. <a class="el" href="SDL__audio_8h.html#af54523e415de7c7fdd0d48a76ab58bb3">SDL_OpenAudioDevice()</a> calls always returns devices >= 2 on success. The legacy calls are good both for backwards compatibility and when you don't care about multiple, specific, or capture devices. </p>
</div>
</div>
<a id="a491ed103fd25d920c4e6b7495217ce66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a491ed103fd25d920c4e6b7495217ce66">◆ </a></span>SDL_AudioFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Uint16 <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Audio format flags. </p>
<p>These are what the 16 bits in SDL_AudioFormat currently mean... (Unspecified bits are always zero).</p>
<pre class="fragment">++-----------------------sample is signed if set
||
|| ++-----------sample is bigendian if set
|| ||
|| || ++---sample is float if set
|| || ||
|| || || +---sample bit size---+
|| || || | |
15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
</pre><p>There are macros in SDL 2.0 and later to query these bits. </p>
</div>
</div>
<a id="a77faa7fe3d22c03ee61466a901c22a25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77faa7fe3d22c03ee61466a901c22a25">◆ </a></span>SDL_AudioSpec</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The calculated values in this structure are calculated by <a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a>.</p>
<p>For multi-channel audio, the default SDL channel mapping is: 2: FL FR (stereo) 3: FL FR LFE (2.1 surround) 4: FL FR BL BR (quad) 5: FL FR FC BL BR (quad + center) 6: FL FR FC LFE SL SR (5.1 surround - last two can also be BL BR) 7: FL FR FC LFE BC SL SR (6.1 surround) 8: FL FR FC LFE BL BR SL SR (7.1 surround) </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4667c3464058d7be76c1f8349d7656de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4667c3464058d7be76c1f8349d7656de">◆ </a></span>SDL_AudioStreamAvailable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_AudioStreamAvailable </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of converted/resampled bytes available. The stream may be buffering data behind the scenes until it has enough to resample correctly, so this number might be lower than what you expect, or even be zero. Add more data or flush the stream if you need the data now.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="a7a74da30372d4a2c3db7ceef406d65fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a74da30372d4a2c3db7ceef406d65fb">◆ </a></span>SDL_AudioStreamClear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_AudioStreamClear </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear any pending data in the stream without converting it</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="add31a8f8ccd99c87b71bef2a9cf93f9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add31a8f8ccd99c87b71bef2a9cf93f9b">◆ </a></span>SDL_AudioStreamFlush()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_AudioStreamFlush </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the stream that you're done sending data, and anything being buffered should be converted/resampled and made available immediately.</p>
<p>It is legal to add more data to a stream after flushing, but there will be audio gaps in the output. Generally this is intended to signal the end of input, so the complete output becomes available.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="a6a8996f0cb3adf37d4c1c5ed4eef5b18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a8996f0cb3adf37d4c1c5ed4eef5b18">◆ </a></span>SDL_AudioStreamGet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_AudioStreamGet </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get converted/resampled data from the stream</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The stream the audio is being requested from </td></tr>
<tr><td class="paramname">buf</td><td>A buffer to fill with audio data </td></tr>
<tr><td class="paramname">len</td><td>The maximum number of bytes to fill </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes read from the stream, or -1 on error</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="ae1cb87e81c853b21f025f42f336ad814"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1cb87e81c853b21f025f42f336ad814">◆ </a></span>SDL_AudioStreamPut()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_AudioStreamPut </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to be converted/resampled to the stream</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The stream the audio data is being added to </td></tr>
<tr><td class="paramname">buf</td><td>A pointer to the audio data to add </td></tr>
<tr><td class="paramname">len</td><td>The number of bytes to write to the stream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 on error.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="a41e1602bc7cd4edb87ca779cf01d40bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41e1602bc7cd4edb87ca779cf01d40bb">◆ </a></span>SDL_BuildAudioCVT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_BuildAudioCVT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> * </td>
<td class="paramname"><em>cvt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td>
<td class="paramname"><em>src_format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8 </td>
<td class="paramname"><em>src_channels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>src_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td>
<td class="paramname"><em>dst_format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8 </td>
<td class="paramname"><em>dst_channels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>dst_rate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function takes a source format and rate and a destination format and rate, and initializes the <code>cvt</code> structure with information needed by <a class="el" href="SDL__audio_8h.html#a8e8660222356e07002dde4928118b7df">SDL_ConvertAudio()</a> to convert a buffer of audio data from one format to the other. An unsupported format causes an error and -1 will be returned.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if no conversion is needed, 1 if the audio filter is set up, or -1 on error. </dd></dl>
</div>
</div>
<a id="a073ed5d40cce01e839b34570c1c7ed50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a073ed5d40cce01e839b34570c1c7ed50">◆ </a></span>SDL_ClearQueuedAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_ClearQueuedAudio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Drop any queued audio data. For playback devices, this is any queued data still waiting to be submitted to the hardware. For capture devices, this is any data that was queued by the device that hasn't yet been dequeued by the application.</p>
<p>Immediately after this call, <a class="el" href="SDL__audio_8h.html#a11a1d59fd68f8a416fa72bf14f5c9ec3">SDL_GetQueuedAudioSize()</a> will return 0. For playback devices, the hardware will start playing silence if more audio isn't queued. Unpaused capture devices will start filling the queue again as soon as they have more data available (which, depending on the state of the hardware and the thread, could be before this function call returns!).</p>
<p>This will not prevent playback of queued audio that's already been sent to the hardware, as we can not undo that, so expect there to be some fraction of a second of audio that might still be heard. This can be useful if you want to, say, drop any pending music during a level change in your game.</p>
<p>You may not queue audio on a device that is using an application-supplied callback; calling this function on such a device is always a no-op. You have to queue audio with <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a>/SDL_DequeueAudio(), or use the audio callback, but not both.</p>
<p>You should not call SDL_LockAudio() on the device before clearing the queue; SDL handles locking internally for this function.</p>
<p>This function always succeeds and thus returns void.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>The device ID of which to clear the audio queue.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a11a1d59fd68f8a416fa72bf14f5c9ec3">SDL_GetQueuedAudioSize</a> </dd></dl>
</div>
</div>
<a id="aa176acc650e66e1d38814cbed3ca258e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa176acc650e66e1d38814cbed3ca258e">◆ </a></span>SDL_CloseAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_CloseAudio </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function shuts down audio processing and closes the audio device. </p>
</div>
</div>
<a id="a8e8660222356e07002dde4928118b7df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e8660222356e07002dde4928118b7df">◆ </a></span>SDL_ConvertAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_ConvertAudio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSDL__AudioCVT.html">SDL_AudioCVT</a> * </td>
<td class="paramname"><em>cvt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Once you have initialized the <code>cvt</code> structure using <a class="el" href="SDL__audio_8h.html#a41e1602bc7cd4edb87ca779cf01d40bb">SDL_BuildAudioCVT()</a>, created an audio buffer <code>cvt->buf</code>, and filled it with <code>cvt->len</code> bytes of audio data in the source format, this function will convert it in-place to the desired format.</p>
<p>The data conversion may expand the size of the audio data, so the buffer <code>cvt->buf</code> should be allocated after the <code>cvt</code> structure is initialized by <a class="el" href="SDL__audio_8h.html#a41e1602bc7cd4edb87ca779cf01d40bb">SDL_BuildAudioCVT()</a>, and should be <code>cvt->len*cvt->len_mult</code> bytes long.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success or -1 if <code>cvt->buf</code> is NULL. </dd></dl>
</div>
</div>
<a id="a6ed6333b8b294eafb6a9435fd8ff89fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ed6333b8b294eafb6a9435fd8ff89fa">◆ </a></span>SDL_DequeueAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC Uint32 SDLCALL SDL_DequeueAudio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dequeue more audio on non-callback devices.</p>
<p>(If you are looking to queue audio for output on a non-callback playback device, you want <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a> instead. This will always return 0 if you use it with playback devices.)</p>
<p>SDL offers two ways to retrieve audio from a capture device: you can either supply a callback that SDL triggers with some frequency as the device records more audio data, (push method), or you can supply no callback, and then SDL will expect you to retrieve data at regular intervals (pull method) with this function.</p>
<p>There are no limits on the amount of data you can queue, short of exhaustion of address space. Data from the device will keep queuing as necessary without further intervention from you. This means you will eventually run out of memory if you aren't routinely dequeueing data.</p>
<p>Capture devices will not queue data when paused; if you are expecting to not need captured audio for some length of time, use SDL_PauseAudioDevice() to stop the capture device from queueing more data. This can be useful during, say, level loading times. When unpaused, capture devices will start queueing data from that point, having flushed any capturable data available while paused.</p>
<p>This function is thread-safe, but dequeueing from the same device from two threads at once does not promise which thread will dequeued data first.</p>
<p>You may not dequeue audio from a device that is using an application-supplied callback; doing so returns an error. You have to use the audio callback, or dequeue audio with this function, but not both.</p>
<p>You should not call SDL_LockAudio() on the device before queueing; SDL handles locking internally for this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>The device ID from which we will dequeue audio. </td></tr>
<tr><td class="paramname">data</td><td>A pointer into where audio data should be copied. </td></tr>
<tr><td class="paramname">len</td><td>The number of bytes (not samples!) to which (data) points. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes dequeued, which could be less than requested.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a11a1d59fd68f8a416fa72bf14f5c9ec3">SDL_GetQueuedAudioSize</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a073ed5d40cce01e839b34570c1c7ed50">SDL_ClearQueuedAudio</a> </dd></dl>
</div>
</div>
<a id="ab093ff9871e917dac8d2fa5169970cf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab093ff9871e917dac8d2fa5169970cf5">◆ </a></span>SDL_FreeAudioStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_FreeAudioStream </td>
<td>(</td>
<td class="paramtype">SDL_AudioStream * </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an audio stream</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a5d9be9cdf2dc76ae541f9013c16a94f4">SDL_NewAudioStream</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd></dl>
</div>
</div>
<a id="a631aa8624575603df2c5ab9257feee59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a631aa8624575603df2c5ab9257feee59">◆ </a></span>SDL_FreeWAV()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_FreeWAV </td>
<td>(</td>
<td class="paramtype">Uint8 * </td>
<td class="paramname"><em>audio_buf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function frees data previously allocated with <a class="el" href="SDL__audio_8h.html#a7e5d38e8c1f8951704a76330c3b1ac81" title="Load the audio data of a WAVE file into memory.">SDL_LoadWAV_RW()</a> </p>
</div>
</div>
<a id="a846bae7fa1183b644c96cbb49e2c8cf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a846bae7fa1183b644c96cbb49e2c8cf5">◆ </a></span>SDL_GetAudioDeviceName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC const char* SDLCALL SDL_GetAudioDeviceName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>iscapture</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the human-readable name of a specific audio device. Must be a value between 0 and (number of audio devices-1). Only valid after a successfully initializing the audio subsystem. The values returned by this function reflect the latest call to <a class="el" href="SDL__audio_8h.html#ae165f64b3f0fecfebe1c97731600ca59">SDL_GetNumAudioDevices()</a>; recall that function to redetect available hardware.</p>
<p>The string returned by this function is UTF-8 encoded, read-only, and managed internally. You are not to free it. If you need to keep the string for any length of time, you should make your own copy of it, as it will be invalid next time any of several other SDL functions is called. </p>
</div>
</div>
<a id="a15b19f26c314e3640ea396251a1ff010"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b19f26c314e3640ea396251a1ff010">◆ </a></span>SDL_GetCurrentAudioDriver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC const char* SDLCALL SDL_GetCurrentAudioDriver </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function returns the name of the current audio driver, or NULL if no driver has been initialized. </p>
</div>
</div>
<a id="ae165f64b3f0fecfebe1c97731600ca59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae165f64b3f0fecfebe1c97731600ca59">◆ </a></span>SDL_GetNumAudioDevices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_GetNumAudioDevices </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>iscapture</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of available devices exposed by the current driver. Only valid after a successfully initializing the audio subsystem. Returns -1 if an explicit list of devices can't be determined; this is not an error. For example, if SDL is set up to talk to a remote audio server, it can't list every one available on the Internet, but it will still allow a specific host to be specified to <a class="el" href="SDL__audio_8h.html#af54523e415de7c7fdd0d48a76ab58bb3">SDL_OpenAudioDevice()</a>.</p>
<p>In many common cases, when this function returns a value <= 0, it can still successfully open the default device (NULL for first argument of <a class="el" href="SDL__audio_8h.html#af54523e415de7c7fdd0d48a76ab58bb3">SDL_OpenAudioDevice()</a>). </p>
</div>
</div>
<a id="a11a1d59fd68f8a416fa72bf14f5c9ec3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11a1d59fd68f8a416fa72bf14f5c9ec3">◆ </a></span>SDL_GetQueuedAudioSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC Uint32 SDLCALL SDL_GetQueuedAudioSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of bytes of still-queued audio.</p>
<p>For playback device:</p>
<p>This is the number of bytes that have been queued for playback with <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a>, but have not yet been sent to the hardware. This number may shrink at any time, so this only informs of pending data.</p>
<p>Once we've sent it to the hardware, this function can not decide the exact byte boundary of what has been played. It's possible that we just gave the hardware several kilobytes right before you called this function, but it hasn't played any of it yet, or maybe half of it, etc.</p>
<p>For capture devices:</p>
<p>This is the number of bytes that have been captured by the device and are waiting for you to dequeue. This number may grow at any time, so this only informs of the lower-bound of available data.</p>
<p>You may not queue audio on a device that is using an application-supplied callback; calling this function on such a device always returns 0. You have to queue audio with <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a>/SDL_DequeueAudio(), or use the audio callback, but not both.</p>
<p>You should not call SDL_LockAudio() on the device before querying; SDL handles locking internally for this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>The device ID of which we will query queued audio size. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes (not samples!) of queued audio.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a073ed5d40cce01e839b34570c1c7ed50">SDL_ClearQueuedAudio</a> </dd></dl>
</div>
</div>
<a id="a7e5d38e8c1f8951704a76330c3b1ac81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e5d38e8c1f8951704a76330c3b1ac81">◆ </a></span>SDL_LoadWAV_RW()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a>* SDLCALL SDL_LoadWAV_RW </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSDL__RWops.html">SDL_RWops</a> * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>freesrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> * </td>
<td class="paramname"><em>spec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8 ** </td>
<td class="paramname"><em>audio_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 * </td>
<td class="paramname"><em>audio_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load the audio data of a WAVE file into memory. </p>
<p>Loading a WAVE file requires <code>src</code>, <code>spec</code>, <code>audio_buf</code> and <code>audio_len</code> to be valid pointers. The entire data portion of the file is then loaded into memory and decoded if necessary.</p>
<p>If <code>freesrc</code> is non-zero, the data source gets automatically closed and freed before the function returns.</p>
<p>Supported are RIFF WAVE files with the formats PCM (8, 16, 24, and 32 bits), IEEE Float (32 bits), Microsoft ADPCM and IMA ADPCM (4 bits), and A-law and ยต-law (8 bits). Other formats are currently unsupported and cause an error.</p>
<p>If this function succeeds, the pointer returned by it is equal to <code>spec</code> and the pointer to the audio data allocated by the function is written to <code>audio_buf</code> and its length in bytes to <code>audio_len</code>. The <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> members <code>freq</code>, <code>channels</code>, and <code>format</code> are set to the values of the audio data in the buffer. The <code>samples</code> member is set to a sane default and all others are set to zero.</p>
<p>It's necessary to use <a class="el" href="SDL__audio_8h.html#a631aa8624575603df2c5ab9257feee59">SDL_FreeWAV()</a> to free the audio data returned in <code>audio_buf</code> when it is no longer used.</p>
<p>Because of the underspecification of the Waveform format, there are many problematic files in the wild that cause issues with strict decoders. To provide compatibility with these files, this decoder is lenient in regards to the truncation of the file, the fact chunk, and the size of the RIFF chunk. The hints SDL_HINT_WAVE_RIFF_CHUNK_SIZE, SDL_HINT_WAVE_TRUNCATION, and SDL_HINT_WAVE_FACT_CHUNK can be used to tune the behavior of the loading process.</p>
<p>Any file that is invalid (due to truncation, corruption, or wrong values in the headers), too big, or unsupported causes an error. Additionally, any critical I/O error from the data source will terminate the loading process with an error. The function returns NULL on error and in all cases (with the exception of <code>src</code> being NULL), an appropriate error message will be set.</p>
<p>It is required that the data source supports seeking.</p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="SDL__audio_8h.html#a7e5d38e8c1f8951704a76330c3b1ac81">SDL_LoadWAV_RW</a>(SDL_RWFromFile(<span class="stringliteral">"sample.wav"</span>, <span class="stringliteral">"rb"</span>), 1, ...);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The data source with the WAVE data </td></tr>
<tr><td class="paramname">freesrc</td><td>A integer value that makes the function close the data source if non-zero </td></tr>
<tr><td class="paramname">spec</td><td>A pointer filled with the audio format of the audio data </td></tr>
<tr><td class="paramname">audio_buf</td><td>A pointer filled with the audio data allocated by the function </td></tr>
<tr><td class="paramname">audio_len</td><td>A pointer filled with the length of the audio data buffer in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL on error, or non-NULL on success. </dd></dl>
</div>
</div>
<a id="ab9ad945b4b15d816802f5a79da06c9f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9ad945b4b15d816802f5a79da06c9f9">◆ </a></span>SDL_MixAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_MixAudio </td>
<td>(</td>
<td class="paramtype">Uint8 * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>volume</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This takes two audio buffers of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping. The volume ranges from 0 - 128, and should be set to ::SDL_MIX_MAXVOLUME for full audio volume. Note this does not change hardware volume. This is provided for convenience – you can mix your own audio data. </p>
</div>
</div>
<a id="a27a0ad33d17f87a2d7574be78d2f39b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27a0ad33d17f87a2d7574be78d2f39b7">◆ </a></span>SDL_MixAudioFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC void SDLCALL SDL_MixAudioFormat </td>
<td>(</td>
<td class="paramtype">Uint8 * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>volume</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This works like <a class="el" href="SDL__audio_8h.html#ab9ad945b4b15d816802f5a79da06c9f9">SDL_MixAudio()</a>, but you specify the audio format instead of using the format of audio device 1. Thus it can be used when no audio device is open at all. </p>
</div>
</div>
<a id="a5d9be9cdf2dc76ae541f9013c16a94f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d9be9cdf2dc76ae541f9013c16a94f4">◆ </a></span>SDL_NewAudioStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC SDL_AudioStream* SDLCALL SDL_NewAudioStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td>
<td class="paramname"><em>src_format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 </td>
<td class="paramname"><em>src_channels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>src_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="SDL__audio_8h.html#a491ed103fd25d920c4e6b7495217ce66">SDL_AudioFormat</a> </td>
<td class="paramname"><em>dst_format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Uint8 </td>
<td class="paramname"><em>dst_channels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>dst_rate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new audio stream</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src_format</td><td>The format of the source audio </td></tr>
<tr><td class="paramname">src_channels</td><td>The number of channels of the source audio </td></tr>
<tr><td class="paramname">src_rate</td><td>The sampling rate of the source audio </td></tr>
<tr><td class="paramname">dst_format</td><td>The format of the desired audio output </td></tr>
<tr><td class="paramname">dst_channels</td><td>The number of channels of the desired audio output </td></tr>
<tr><td class="paramname">dst_rate</td><td>The sampling rate of the desired audio output </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 on error.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#ae1cb87e81c853b21f025f42f336ad814">SDL_AudioStreamPut</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a6a8996f0cb3adf37d4c1c5ed4eef5b18">SDL_AudioStreamGet</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a4667c3464058d7be76c1f8349d7656de">SDL_AudioStreamAvailable</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#add31a8f8ccd99c87b71bef2a9cf93f9b">SDL_AudioStreamFlush</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a7a74da30372d4a2c3db7ceef406d65fb">SDL_AudioStreamClear</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#ab093ff9871e917dac8d2fa5169970cf5">SDL_FreeAudioStream</a> </dd></dl>
</div>
</div>
<a id="a2edf30e7747584e28041b4986f89f440"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2edf30e7747584e28041b4986f89f440">◆ </a></span>SDL_OpenAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_OpenAudio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> * </td>
<td class="paramname"><em>desired</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> * </td>
<td class="paramname"><em>obtained</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function opens the audio device with the desired parameters, and returns 0 if successful, placing the actual hardware parameters in the structure pointed to by <code>obtained</code>. If <code>obtained</code> is NULL, the audio data passed to the callback function will be guaranteed to be in the requested format, and will be automatically converted to the hardware audio format if necessary. This function returns -1 if it failed to open the audio device, or couldn't set up the audio thread.</p>
<p>When filling in the desired audio spec structure,</p><ul>
<li><code>desired->freq</code> should be the desired audio frequency in samples-per- second.</li>
<li><code>desired->format</code> should be the desired audio format.</li>
<li><code>desired->samples</code> is the desired size of the audio buffer, in samples. This number should be a power of two, and may be adjusted by the audio driver to a value more suitable for the hardware. Good values seem to range between 512 and 8096 inclusive, depending on the application and CPU speed. Smaller values yield faster response time, but can lead to underflow if the application is doing heavy processing and cannot fill the audio buffer in time. A stereo sample consists of both right and left channels in LR ordering. Note that the number of samples is directly related to time by the following formula:<div class="fragment"><div class="line">ms = (samples*1000)/freq </div></div><!-- fragment --></li>
<li><code>desired->size</code> is the size in bytes of the audio buffer, and is calculated by <a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a>.</li>
<li><code>desired->silence</code> is the value used to set the buffer to silence, and is calculated by <a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a>.</li>
<li><code>desired->callback</code> should be set to a function that will be called when the audio device is ready for more data. It is passed a pointer to the audio buffer, and the length in bytes of the audio buffer. This function usually runs in a separate thread, and so you should protect data structures that it accesses by calling SDL_LockAudio() and SDL_UnlockAudio() in your code. Alternately, you may pass a NULL pointer here, and call <a class="el" href="SDL__audio_8h.html#a19ef6fa2396f581aaf4d9a9512972268">SDL_QueueAudio()</a> with some frequency, to queue more audio samples to be played (or for capture devices, call <a class="el" href="SDL__audio_8h.html#a6ed6333b8b294eafb6a9435fd8ff89fa">SDL_DequeueAudio()</a> with some frequency, to obtain audio samples).</li>
<li><code>desired->userdata</code> is passed as the first parameter to your callback function. If you passed a NULL callback, this value is ignored.</li>
</ul>
<p>The audio device starts out playing silence when it's opened, and should be enabled for playing by calling <code>SDL_PauseAudio(0)</code> when you are ready for your audio callback function to be called. Since the audio driver may modify the requested size of the audio buffer, you should allocate any local mixing buffers after you open the audio device. </p>
</div>
</div>
<a id="af54523e415de7c7fdd0d48a76ab58bb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af54523e415de7c7fdd0d48a76ab58bb3">◆ </a></span>SDL_OpenAudioDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC <a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> SDLCALL SDL_OpenAudioDevice </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>iscapture</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> * </td>
<td class="paramname"><em>desired</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structSDL__AudioSpec.html">SDL_AudioSpec</a> * </td>
<td class="paramname"><em>obtained</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>allowed_changes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a specific audio device. Passing in a device name of NULL requests the most reasonable default (and is equivalent to calling <a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a>).</p>
<p>The device name is a UTF-8 string reported by <a class="el" href="SDL__audio_8h.html#a846bae7fa1183b644c96cbb49e2c8cf5">SDL_GetAudioDeviceName()</a>, but some drivers allow arbitrary and driver-specific strings, such as a hostname/IP address for a remote audio server, or a filename in the diskaudio driver.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on error, a valid device ID that is >= 2 on success.</dd></dl>
<p><a class="el" href="SDL__audio_8h.html#a2edf30e7747584e28041b4986f89f440">SDL_OpenAudio()</a>, unlike this function, always acts on device ID 1. </p>
</div>
</div>
<a id="a19ef6fa2396f581aaf4d9a9512972268"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19ef6fa2396f581aaf4d9a9512972268">◆ </a></span>SDL_QueueAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DECLSPEC int SDLCALL SDL_QueueAudio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="SDL__audio_8h.html#a677d9d2a6f77a7502a0dc8b45ad211bb">SDL_AudioDeviceID</a> </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queue more audio on non-callback devices.</p>
<p>(If you are looking to retrieve queued audio from a non-callback capture device, you want <a class="el" href="SDL__audio_8h.html#a6ed6333b8b294eafb6a9435fd8ff89fa">SDL_DequeueAudio()</a> instead. This will return -1 to signify an error if you use it with capture devices.)</p>
<p>SDL offers two ways to feed audio to the device: you can either supply a callback that SDL triggers with some frequency to obtain more audio (pull method), or you can supply no callback, and then SDL will expect you to supply data at regular intervals (push method) with this function.</p>
<p>There are no limits on the amount of data you can queue, short of exhaustion of address space. Queued data will drain to the device as necessary without further intervention from you. If the device needs audio but there is not enough queued, it will play silence to make up the difference. This means you will have skips in your audio playback if you aren't routinely queueing sufficient data.</p>
<p>This function copies the supplied data, so you are safe to free it when the function returns. This function is thread-safe, but queueing to the same device from two threads at once does not promise which buffer will be queued first.</p>
<p>You may not queue audio on a device that is using an application-supplied callback; doing so returns an error. You have to use the audio callback or queue audio with this function, but not both.</p>
<p>You should not call SDL_LockAudio() on the device before queueing; SDL handles locking internally for this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>The device ID to which we will queue audio. </td></tr>
<tr><td class="paramname">data</td><td>The data to queue to the device for later playback. </td></tr>
<tr><td class="paramname">len</td><td>The number of bytes (not samples!) to which (data) points. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, or -1 on error.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="SDL__audio_8h.html#a11a1d59fd68f8a416fa72bf14f5c9ec3">SDL_GetQueuedAudioSize</a> </dd>
<dd>
<a class="el" href="SDL__audio_8h.html#a073ed5d40cce01e839b34570c1c7ed50">SDL_ClearQueuedAudio</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
bf9e3bc1aec7873c087fb2ccd927873f
>
files
>
8
