File: //usr/share/doc/alsa-lib-devel-1.0.17/lib64/html/group___s_control.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ALSA project - the C library reference: Setup Control Interface</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<h1>Setup Control Interface<br>
<small>
[<a class="el" href="group___control.html">Control Interface</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#gc334bae51e0f1f322ab064f4ce81ee9c">snd_sctl_build</a> (<a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> **ctl, <a class="el" href="group___control.html#g6fef7f4892f9960f41ead15ef8994aa0">snd_ctl_t</a> *handle, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *config, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *private_data, int mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Build setup control handle. <a href="#gc334bae51e0f1f322ab064f4ce81ee9c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#g17987bf5d4ed2a31eaa12d1c3f36ad99">snd_sctl_free</a> (<a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free setup control handle. <a href="#g17987bf5d4ed2a31eaa12d1c3f36ad99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#gda32b11d7a5b8227618a29b7d9e38c47">snd_sctl_install</a> (<a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Install given values to control elements. <a href="#gda32b11d7a5b8227618a29b7d9e38c47"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_control.html#gaf2af519409401e8ec604c9c0549229f">snd_sctl_remove</a> (<a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> *handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove (restore) previous values from control elements. <a href="#gaf2af519409401e8ec604c9c0549229f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The setup control interface - set or modify control elements from a configuration file. <hr><h2>Function Documentation</h2>
<a class="anchor" name="gc334bae51e0f1f322ab064f4ce81ee9c"></a><!-- doxytag: member="control.h::snd_sctl_build" ref="gc334bae51e0f1f322ab064f4ce81ee9c" args="(snd_sctl_t **ctl, snd_ctl_t *handle, snd_config_t *config, snd_config_t *private_data, int mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_sctl_build </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> ** </td>
<td class="paramname"> <em>sctl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___control.html#g6fef7f4892f9960f41ead15ef8994aa0">snd_ctl_t</a> * </td>
<td class="paramname"> <em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> * </td>
<td class="paramname"> <em>conf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> * </td>
<td class="paramname"> <em>private_data</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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Build setup control handle.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sctl</em> </td><td>Result - setup control handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>Master control handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>conf</em> </td><td>Setup configuration </td></tr>
<tr><td valign="top"></td><td valign="top"><em>private_data</em> </td><td>Private data for runtime evaluation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>Build mode - SND_SCTL_xxxx </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div><p>
<a class="anchor" name="g17987bf5d4ed2a31eaa12d1c3f36ad99"></a><!-- doxytag: member="control.h::snd_sctl_free" ref="g17987bf5d4ed2a31eaa12d1c3f36ad99" args="(snd_sctl_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_sctl_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> * </td>
<td class="paramname"> <em>sctl</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free setup control handle.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sctl</em> </td><td>Setup control handle </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div><p>
<a class="anchor" name="gda32b11d7a5b8227618a29b7d9e38c47"></a><!-- doxytag: member="control.h::snd_sctl_install" ref="gda32b11d7a5b8227618a29b7d9e38c47" args="(snd_sctl_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_sctl_install </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> * </td>
<td class="paramname"> <em>h</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Install given values to control elements.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>Setup control handle </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div><p>
<a class="anchor" name="gaf2af519409401e8ec604c9c0549229f"></a><!-- doxytag: member="control.h::snd_sctl_remove" ref="gaf2af519409401e8ec604c9c0549229f" args="(snd_sctl_t *handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_sctl_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___control.html#g69ede2c8eae4a6b5bd174be1e38ccf69">snd_sctl_t</a> * </td>
<td class="paramname"> <em>h</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove (restore) previous values from control elements.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>Setup control handle </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jan 20 22:42:10 2009 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>