<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>ALSA project - the C library reference: External I/O plugin SDK</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>External I/O plugin SDK<br/>
<small>
[<a class="el" href="group___plugin___s_d_k.html">External PCM plugin SDK</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsnd__pcm__ioplug.html">snd_pcm_ioplug_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsnd__pcm__ioplug__callback.html">snd_pcm_ioplug_callback_t</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga435c57838f97c24b7274a9596ccbe3b6">SND_PCM_IOPLUG_FLAG_LISTED</a> (1<<0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gad5c0b67e4d9b7be96f1083179e95f38a">SND_PCM_IOPLUG_FLAG_MONOTONIC</a> (1<<1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga46f4111ec394e6c4209a4e1b5f99a9f7">SND_PCM_IOPLUG_VERSION_MAJOR</a> 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga49ea8946ea0c9b2655b70afb03ed79bd">SND_PCM_IOPLUG_VERSION_MINOR</a> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gabe46103216aa58afc3c4bc314dd1bbc6">SND_PCM_IOPLUG_VERSION_TINY</a> 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga81a2273c4df9be29d91e6e2a0860d991">SND_PCM_IOPLUG_VERSION</a></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br/>
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635adf64bb9d9a7f95f878e8bb22e003c357">SND_PCM_IOPLUG_HW_ACCESS</a> = 0,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635aa7186fa6ab3791611363c83f725f1a57">SND_PCM_IOPLUG_HW_FORMAT</a>,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635a5cb59832a513d2b87166000d3f4035e2">SND_PCM_IOPLUG_HW_CHANNELS</a>,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635a43827c9773bc5c40a1643bd8f930c8d1">SND_PCM_IOPLUG_HW_RATE</a>,
<br/>
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635aafe12ebbe6f618aa75cc7c5d64d45eda">SND_PCM_IOPLUG_HW_PERIOD_BYTES</a>,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635a004f7b7af23b37d30d520777158e8277">SND_PCM_IOPLUG_HW_BUFFER_BYTES</a>,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635a1f68c89ac11ae9fe28710cee044a0b94">SND_PCM_IOPLUG_HW_PERIODS</a>,
<a class="el" href="group___p_c_m___i_o_plug.html#gga726ca809ffd3d67ab4b8476646f26635ab024a119736127e7a606c75e57d34585">SND_PCM_IOPLUG_HW_PARAMS</a>
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga7fb5213a5e776246e2b4dc53ec8d7604">snd_pcm_ioplug_create</a> (snd_pcm_ioplug_t *io, const char *name, <a class="el" href="group___p_c_m.html#gac23b43ff55add78638e503b9cc892c24">snd_pcm_stream_t</a> stream, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an ioplug instance. <a href="#ga7fb5213a5e776246e2b4dc53ec8d7604"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga286ec116983166de889f0268a2c666ef">snd_pcm_ioplug_delete</a> (snd_pcm_ioplug_t *io)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the ioplug instance. <a href="#ga286ec116983166de889f0268a2c666ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gab223893226ecf78f675c89959a8c421a">snd_pcm_ioplug_reinit_status</a> (snd_pcm_ioplug_t *ioplug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reinitialize the poll and mmap status. <a href="#gab223893226ecf78f675c89959a8c421a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structsnd__pcm__channel__area__t.html">snd_pcm_channel_area_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gac3b666ff286745c9eb24de3e3930970a">snd_pcm_ioplug_mmap_areas</a> (snd_pcm_ioplug_t *ioplug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get mmap area of ioplug. <a href="#gac3b666ff286745c9eb24de3e3930970a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gad74355dfaa56fae80d49181c83eeecc4">snd_pcm_ioplug_params_reset</a> (snd_pcm_ioplug_t *io)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset ioplug parameters. <a href="#gad74355dfaa56fae80d49181c83eeecc4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#gab62d470b02661214319196394b55fb37">snd_pcm_ioplug_set_param_minmax</a> (snd_pcm_ioplug_t *io, int type, unsigned int min, unsigned int max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set parameter as the min/max values. <a href="#gab62d470b02661214319196394b55fb37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga7d713552fb846ccdf4b7ec6a9fc1b562">snd_pcm_ioplug_set_param_list</a> (snd_pcm_ioplug_t *io, int type, unsigned int num_list, const unsigned int *list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set parameter as the list. <a href="#ga7d713552fb846ccdf4b7ec6a9fc1b562"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___i_o_plug.html#ga65feed7caf26f07aad0c722fc61fe751">snd_pcm_ioplug_set_state</a> (snd_pcm_ioplug_t *ioplug, <a class="el" href="group___p_c_m.html#ga61ac499cb3701ce536d4d83725908860">snd_pcm_state_t</a> state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the ioplug PCM status. <a href="#ga65feed7caf26f07aad0c722fc61fe751"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>See the <a class="el" href="pcm.html">PCM (digital audio) interface</a> page for more details. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga435c57838f97c24b7274a9596ccbe3b6"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_FLAG_LISTED" ref="ga435c57838f97c24b7274a9596ccbe3b6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_FLAG_LISTED (1<<0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>list up this PCM </p>
</div>
</div>
<a class="anchor" id="gad5c0b67e4d9b7be96f1083179e95f38a"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_FLAG_MONOTONIC" ref="gad5c0b67e4d9b7be96f1083179e95f38a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_FLAG_MONOTONIC (1<<1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>monotonic timestamps </p>
</div>
</div>
<a class="anchor" id="ga81a2273c4df9be29d91e6e2a0860d991"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_VERSION" ref="ga81a2273c4df9be29d91e6e2a0860d991" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_VERSION</td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="group___p_c_m___i_o_plug.html#ga46f4111ec394e6c4209a4e1b5f99a9f7">SND_PCM_IOPLUG_VERSION_MAJOR</a><<16) |\
(<a class="code" href="group___p_c_m___i_o_plug.html#ga49ea8946ea0c9b2655b70afb03ed79bd">SND_PCM_IOPLUG_VERSION_MINOR</a><<8) |\
(<a class="code" href="group___p_c_m___i_o_plug.html#gabe46103216aa58afc3c4bc314dd1bbc6">SND_PCM_IOPLUG_VERSION_TINY</a>))
</pre></div><p>IO-plugin protocol version </p>
</div>
</div>
<a class="anchor" id="ga46f4111ec394e6c4209a4e1b5f99a9f7"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_VERSION_MAJOR" ref="ga46f4111ec394e6c4209a4e1b5f99a9f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_VERSION_MAJOR 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol major version </p>
</div>
</div>
<a class="anchor" id="ga49ea8946ea0c9b2655b70afb03ed79bd"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_VERSION_MINOR" ref="ga49ea8946ea0c9b2655b70afb03ed79bd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_VERSION_MINOR 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol minor version </p>
</div>
</div>
<a class="anchor" id="gabe46103216aa58afc3c4bc314dd1bbc6"></a><!-- doxytag: member="pcm_ioplug.h::SND_PCM_IOPLUG_VERSION_TINY" ref="gabe46103216aa58afc3c4bc314dd1bbc6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_PCM_IOPLUG_VERSION_TINY 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol tiny version </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga726ca809ffd3d67ab4b8476646f26635"></a><!-- doxytag: member="pcm_ioplug.h::@6" ref="ga726ca809ffd3d67ab4b8476646f26635" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>hw constraints for ioplug </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635adf64bb9d9a7f95f878e8bb22e003c357"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_ACCESS" ref="gga726ca809ffd3d67ab4b8476646f26635adf64bb9d9a7f95f878e8bb22e003c357" args="" -->SND_PCM_IOPLUG_HW_ACCESS</em> </td><td>
<p>access type </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635aa7186fa6ab3791611363c83f725f1a57"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_FORMAT" ref="gga726ca809ffd3d67ab4b8476646f26635aa7186fa6ab3791611363c83f725f1a57" args="" -->SND_PCM_IOPLUG_HW_FORMAT</em> </td><td>
<p>format </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635a5cb59832a513d2b87166000d3f4035e2"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_CHANNELS" ref="gga726ca809ffd3d67ab4b8476646f26635a5cb59832a513d2b87166000d3f4035e2" args="" -->SND_PCM_IOPLUG_HW_CHANNELS</em> </td><td>
<p>channels </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635a43827c9773bc5c40a1643bd8f930c8d1"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_RATE" ref="gga726ca809ffd3d67ab4b8476646f26635a43827c9773bc5c40a1643bd8f930c8d1" args="" -->SND_PCM_IOPLUG_HW_RATE</em> </td><td>
<p>rate </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635aafe12ebbe6f618aa75cc7c5d64d45eda"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_PERIOD_BYTES" ref="gga726ca809ffd3d67ab4b8476646f26635aafe12ebbe6f618aa75cc7c5d64d45eda" args="" -->SND_PCM_IOPLUG_HW_PERIOD_BYTES</em> </td><td>
<p>period bytes </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635a004f7b7af23b37d30d520777158e8277"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_BUFFER_BYTES" ref="gga726ca809ffd3d67ab4b8476646f26635a004f7b7af23b37d30d520777158e8277" args="" -->SND_PCM_IOPLUG_HW_BUFFER_BYTES</em> </td><td>
<p>buffer bytes </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635a1f68c89ac11ae9fe28710cee044a0b94"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_PERIODS" ref="gga726ca809ffd3d67ab4b8476646f26635a1f68c89ac11ae9fe28710cee044a0b94" args="" -->SND_PCM_IOPLUG_HW_PERIODS</em> </td><td>
<p>number of periods </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga726ca809ffd3d67ab4b8476646f26635ab024a119736127e7a606c75e57d34585"></a><!-- doxytag: member="SND_PCM_IOPLUG_HW_PARAMS" ref="gga726ca809ffd3d67ab4b8476646f26635ab024a119736127e7a606c75e57d34585" args="" -->SND_PCM_IOPLUG_HW_PARAMS</em> </td><td>
<p>max number of hw constraints </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7fb5213a5e776246e2b4dc53ec8d7604"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_create" ref="ga7fb5213a5e776246e2b4dc53ec8d7604" args="(snd_pcm_ioplug_t *io, const char *name, snd_pcm_stream_t stream, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_create </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#gac23b43ff55add78638e503b9cc892c24">snd_pcm_stream_t</a> </td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an ioplug instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>name of PCM </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>stream direction </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>PCM open mode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>
<p>Creates the ioplug instance.</p>
<p>The callback is the mandatory field of ioplug handle. At least, start, stop and pointer callbacks must be set before calling this function. </p>
</div>
</div>
<a class="anchor" id="ga286ec116983166de889f0268a2c666ef"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_delete" ref="ga286ec116983166de889f0268a2c666ef" args="(snd_pcm_ioplug_t *io)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_delete </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete the ioplug instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code </dd></dl>
</div>
</div>
<a class="anchor" id="gac3b666ff286745c9eb24de3e3930970a"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_mmap_areas" ref="gac3b666ff286745c9eb24de3e3930970a" args="(snd_pcm_ioplug_t *ioplug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structsnd__pcm__channel__area__t.html">snd_pcm_channel_area_t</a>* snd_pcm_ioplug_mmap_areas </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get mmap area of ioplug. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the mmap channel areas if available, or NULL</dd></dl>
<p>Returns the mmap channel areas if available. When mmap_rw field is not set, this function always returns NULL. </p>
</div>
</div>
<a class="anchor" id="gad74355dfaa56fae80d49181c83eeecc4"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_params_reset" ref="gad74355dfaa56fae80d49181c83eeecc4" args="(snd_pcm_ioplug_t *io)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_ioplug_params_reset </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset ioplug parameters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle</td></tr>
</table>
</dd>
</dl>
<p>Resets the all parameters for the given ioplug handle. </p>
</div>
</div>
<a class="anchor" id="gab223893226ecf78f675c89959a8c421a"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_reinit_status" ref="gab223893226ecf78f675c89959a8c421a" args="(snd_pcm_ioplug_t *ioplug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_reinit_status </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reinitialize the poll and mmap status. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>
<p>Reinitializes the poll and the mmap status of the PCM. Call this function to propagate the status change in the ioplug instance to its PCM internals. </p>
</div>
</div>
<a class="anchor" id="ga7d713552fb846ccdf4b7ec6a9fc1b562"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_set_param_list" ref="ga7d713552fb846ccdf4b7ec6a9fc1b562" args="(snd_pcm_ioplug_t *io, int type, unsigned int num_list, const unsigned int *list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_set_param_list </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>num_list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned int * </td>
<td class="paramname"> <em>list</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set parameter as the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>parameter type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num_list</em> </td><td>number of available values </td></tr>
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>the list of available values </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>
<p>Sets the parameter as the list. The available values of the given parameter type is restricted to the ones of the given list. </p>
</div>
</div>
<a class="anchor" id="gab62d470b02661214319196394b55fb37"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_set_param_minmax" ref="gab62d470b02661214319196394b55fb37" args="(snd_pcm_ioplug_t *io, int type, unsigned int min, unsigned int max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_set_param_minmax </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set parameter as the min/max values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>parameter type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>the minimum value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>the maximum value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or a negative error code</dd></dl>
<p>Sets the parameter as the min/max values. The available values of the given parameter type is restricted between the given minimum and maximum values. </p>
</div>
</div>
<a class="anchor" id="ga65feed7caf26f07aad0c722fc61fe751"></a><!-- doxytag: member="pcm_ioplug.h::snd_pcm_ioplug_set_state" ref="ga65feed7caf26f07aad0c722fc61fe751" args="(snd_pcm_ioplug_t *ioplug, snd_pcm_state_t state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_ioplug_set_state </td>
<td>(</td>
<td class="paramtype">snd_pcm_ioplug_t * </td>
<td class="paramname"> <em>ioplug</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga61ac499cb3701ce536d4d83725908860">snd_pcm_state_t</a> </td>
<td class="paramname"> <em>state</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change the ioplug PCM status. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ioplug</em> </td><td>the ioplug handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>the PCM status </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero if successful or a negative error code</dd></dl>
<p>Changes the PCM status of the ioplug to the given value. This function can be used for external plugins to notify the status change, e.g. XRUN. </p>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Nov 20 07:42:24 2010 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
