<!-- 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 Control 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 Control Plugin SDK</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__ctl__ext.html">snd_ctl_ext_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsnd__ctl__ext__callback.html">snd_ctl_ext_callback_t</a></td></tr>
<tr><td colspan="2"><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="control__ext_8c.html">control_ext.c</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>External Control Plugin SDK. </p>
<br/></td></tr>
</p>
<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___ctl_plugin___s_d_k.html#gac015d294d7ae50614f6991da93893c3b">SND_CTL_PLUGIN_ENTRY</a>(name) _snd_ctl_##name##_open</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#gaa94fc65e8951f16e4b273b0f81e90f7e">SND_CTL_PLUGIN_SYMBOL</a>(name) SND_DLSYM_BUILD_VERSION(SND_CTL_PLUGIN_ENTRY(name), SND_CONTROL_DLSYM_VERSION);</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#ga13e494fe5c6068d6608a974f5a62a430">SND_CTL_PLUGIN_DEFINE_FUNC</a>(plugin)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#ga110bc1818d56d22b89e2773d7c54a115">SND_CTL_EXT_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___ctl_plugin___s_d_k.html#ga9ace8ce6f67297cba3bb365b600c8bd8">SND_CTL_EXT_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___ctl_plugin___s_d_k.html#gae99e1c9ee4d5c9e9afaa0376a2af96eb">SND_CTL_EXT_VERSION_TINY</a> 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#ga65ea29f84b09ee3e640f88b06d05a1a2">SND_CTL_EXT_VERSION</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#gac1f0737189a30bbb1e4dcbf681df39fd">SND_CTL_EXT_KEY_NOT_FOUND</a> (<a class="el" href="group___ctl_plugin___s_d_k.html#gac73a66a3973afb51c4e585177647c693">snd_ctl_ext_key_t</a>)(-1)</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#gac73a66a3973afb51c4e585177647c693">snd_ctl_ext_key_t</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"><a class="el" href="group___ctl_plugin___s_d_k.html#gaeedd1d7413b3025e9cede1b27e509de5">snd_ctl_ext_access_t</a> { <br/>
<b>SND_CTL_EXT_ACCESS_READ</b> = (1<<0),
<b>SND_CTL_EXT_ACCESS_WRITE</b> = (1<<1),
<b>SND_CTL_EXT_ACCESS_READWRITE</b> = (3<<0),
<b>SND_CTL_EXT_ACCESS_VOLATILE</b> = (1<<2),
<br/>
<b>SND_CTL_EXT_ACCESS_INACTIVE</b> = (1<<8)
<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___ctl_plugin___s_d_k.html#ga317775f9c5e239781e71735ca5ba1ca6">snd_ctl_ext_create</a> (snd_ctl_ext_t *ext, const char *name, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an external control plugin instance. <a href="#ga317775f9c5e239781e71735ca5ba1ca6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___ctl_plugin___s_d_k.html#ga33fadf68f6414722876f21201214f76e">snd_ctl_ext_delete</a> (snd_ctl_ext_t *ext)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the external control plugin. <a href="#ga33fadf68f6414722876f21201214f76e"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gac1f0737189a30bbb1e4dcbf681df39fd"></a><!-- doxytag: member="control_external.h::SND_CTL_EXT_KEY_NOT_FOUND" ref="gac1f0737189a30bbb1e4dcbf681df39fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_EXT_KEY_NOT_FOUND (<a class="el" href="group___ctl_plugin___s_d_k.html#gac73a66a3973afb51c4e585177647c693">snd_ctl_ext_key_t</a>)(-1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>find_elem callback returns this if no matching control element is found </p>
</div>
</div>
<a class="anchor" id="ga65ea29f84b09ee3e640f88b06d05a1a2"></a><!-- doxytag: member="control_external.h::SND_CTL_EXT_VERSION" ref="ga65ea29f84b09ee3e640f88b06d05a1a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_EXT_VERSION</td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="group___ctl_plugin___s_d_k.html#ga110bc1818d56d22b89e2773d7c54a115">SND_CTL_EXT_VERSION_MAJOR</a><<16) |\
(<a class="code" href="group___ctl_plugin___s_d_k.html#ga9ace8ce6f67297cba3bb365b600c8bd8">SND_CTL_EXT_VERSION_MINOR</a><<8) |\
(<a class="code" href="group___ctl_plugin___s_d_k.html#gae99e1c9ee4d5c9e9afaa0376a2af96eb">SND_CTL_EXT_VERSION_TINY</a>))
</pre></div><p>external plugin protocol version </p>
</div>
</div>
<a class="anchor" id="ga110bc1818d56d22b89e2773d7c54a115"></a><!-- doxytag: member="control_external.h::SND_CTL_EXT_VERSION_MAJOR" ref="ga110bc1818d56d22b89e2773d7c54a115" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_EXT_VERSION_MAJOR 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol major version </p>
</div>
</div>
<a class="anchor" id="ga9ace8ce6f67297cba3bb365b600c8bd8"></a><!-- doxytag: member="control_external.h::SND_CTL_EXT_VERSION_MINOR" ref="ga9ace8ce6f67297cba3bb365b600c8bd8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_EXT_VERSION_MINOR 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol minor version </p>
</div>
</div>
<a class="anchor" id="gae99e1c9ee4d5c9e9afaa0376a2af96eb"></a><!-- doxytag: member="control_external.h::SND_CTL_EXT_VERSION_TINY" ref="gae99e1c9ee4d5c9e9afaa0376a2af96eb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_EXT_VERSION_TINY 0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protocol tiny version </p>
</div>
</div>
<a class="anchor" id="ga13e494fe5c6068d6608a974f5a62a430"></a><!-- doxytag: member="control_external.h::SND_CTL_PLUGIN_DEFINE_FUNC" ref="ga13e494fe5c6068d6608a974f5a62a430" args="(plugin)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_PLUGIN_DEFINE_FUNC</td>
<td>(</td>
<td class="paramtype">plugin </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keywordtype">int</span> <a class="code" href="group___ctl_plugin___s_d_k.html#gac015d294d7ae50614f6991da93893c3b">SND_CTL_PLUGIN_ENTRY</a>(plugin) (<a class="code" href="group___control.html#ga06628f38def84a0fe3da74041db9d51f">snd_ctl_t</a> **handlep, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,\
<a class="code" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985" title="Internal structure for a configuration node object.">snd_config_t</a> *root, <a class="code" href="group___config.html#ga1c20905af775ae77d04d1a5696f67985" title="Internal structure for a configuration node object.">snd_config_t</a> *conf, <span class="keywordtype">int</span> mode)
</pre></div><p>Define the control plugin </p>
</div>
</div>
<a class="anchor" id="gac015d294d7ae50614f6991da93893c3b"></a><!-- doxytag: member="control_external.h::SND_CTL_PLUGIN_ENTRY" ref="gac015d294d7ae50614f6991da93893c3b" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_PLUGIN_ENTRY</td>
<td>(</td>
<td class="paramtype">name </td>
<td class="paramname"></td>
<td> ) </td>
<td> _snd_ctl_##name##_open</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the object entry for external control plugins </p>
</div>
</div>
<a class="anchor" id="gaa94fc65e8951f16e4b273b0f81e90f7e"></a><!-- doxytag: member="control_external.h::SND_CTL_PLUGIN_SYMBOL" ref="gaa94fc65e8951f16e4b273b0f81e90f7e" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_CTL_PLUGIN_SYMBOL</td>
<td>(</td>
<td class="paramtype">name </td>
<td class="paramname"></td>
<td> ) </td>
<td> SND_DLSYM_BUILD_VERSION(SND_CTL_PLUGIN_ENTRY(name), SND_CONTROL_DLSYM_VERSION);</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the symbols of the given control plugin with versions </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gac73a66a3973afb51c4e585177647c693"></a><!-- doxytag: member="control_external.h::snd_ctl_ext_key_t" ref="gac73a66a3973afb51c4e585177647c693" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned long <a class="el" href="group___ctl_plugin___s_d_k.html#gac73a66a3973afb51c4e585177647c693">snd_ctl_ext_key_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Key to access a control pointer </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaeedd1d7413b3025e9cede1b27e509de5"></a><!-- doxytag: member="control_external.h::snd_ctl_ext_access_t" ref="gaeedd1d7413b3025e9cede1b27e509de5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___ctl_plugin___s_d_k.html#gaeedd1d7413b3025e9cede1b27e509de5">snd_ctl_ext_access_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The access type bits stored in get_attribute callback </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga317775f9c5e239781e71735ca5ba1ca6"></a><!-- doxytag: member="control_external.h::snd_ctl_ext_create" ref="ga317775f9c5e239781e71735ca5ba1ca6" args="(snd_ctl_ext_t *ext, const char *name, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_ctl_ext_create </td>
<td>(</td>
<td class="paramtype">snd_ctl_ext_t * </td>
<td class="paramname"> <em>ext</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">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 external control plugin 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>ext</em> </td><td>the plugin handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>name of control </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>control 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 external control instance. </p>
</div>
</div>
<a class="anchor" id="ga33fadf68f6414722876f21201214f76e"></a><!-- doxytag: member="control_external.h::snd_ctl_ext_delete" ref="ga33fadf68f6414722876f21201214f76e" args="(snd_ctl_ext_t *ext)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_ctl_ext_delete </td>
<td>(</td>
<td class="paramtype">snd_ctl_ext_t * </td>
<td class="paramname"> <em>ext</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete the external control plugin. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ext</em> </td><td>the plugin 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>
</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>
