| Current File : //proc/thread-self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/group___hint.html |
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ALSA project - the C library reference: Name Hint Interface</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">ALSA project - the C library reference
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Name Hint Interface<div class="ingroups"><a class="el" href="group___configuration.html">Configuration Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadf4ce9117fcfa454c523ed6e6bd8b353"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hint.html#gadf4ce9117fcfa454c523ed6e6bd8b353">snd_device_name_hint</a> (int card, const char *iface, void ***hints)</td></tr>
<tr class="memdesc:gadf4ce9117fcfa454c523ed6e6bd8b353"><td class="mdescLeft"> </td><td class="mdescRight">Get a set of device name hints. <a href="group___hint.html#gadf4ce9117fcfa454c523ed6e6bd8b353">More...</a><br /></td></tr>
<tr class="separator:gadf4ce9117fcfa454c523ed6e6bd8b353"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4cacf29df4616c2458fc84c1fde708c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hint.html#gad4cacf29df4616c2458fc84c1fde708c">snd_device_name_free_hint</a> (void **hints)</td></tr>
<tr class="memdesc:gad4cacf29df4616c2458fc84c1fde708c"><td class="mdescLeft"> </td><td class="mdescRight">Free a list of device name hints. <a href="group___hint.html#gad4cacf29df4616c2458fc84c1fde708c">More...</a><br /></td></tr>
<tr class="separator:gad4cacf29df4616c2458fc84c1fde708c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8546500ca828392f03f5bba2e7813874"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hint.html#ga8546500ca828392f03f5bba2e7813874">snd_device_name_get_hint</a> (const void *hint, const char *id)</td></tr>
<tr class="memdesc:ga8546500ca828392f03f5bba2e7813874"><td class="mdescLeft"> </td><td class="mdescRight">Extract a value from a hint. <a href="group___hint.html#ga8546500ca828392f03f5bba2e7813874">More...</a><br /></td></tr>
<tr class="separator:ga8546500ca828392f03f5bba2e7813874"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The name hint interface - get descriptive information about a device (name, description, input/output). </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad4cacf29df4616c2458fc84c1fde708c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad4cacf29df4616c2458fc84c1fde708c">◆ </a></span>snd_device_name_free_hint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_device_name_free_hint </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>hints</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a list of device name hints. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hints</td><td>List to free </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="ga8546500ca828392f03f5bba2e7813874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8546500ca828392f03f5bba2e7813874">◆ </a></span>snd_device_name_get_hint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* snd_device_name_get_hint </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>hint</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extract a value from a hint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hint</td><td>A pointer to hint </td></tr>
<tr><td class="paramname">id</td><td>Hint value to extract ("NAME", "DESC", or "IOID", see below) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an allocated ASCII string if success, otherwise NULL</dd></dl>
<p>List of valid IDs: NAME - name of device DESC - description of device IOID - input / output identification ("Input" or "Output"), NULL means both</p>
<p>The return value should be freed when no longer needed. </p>
</div>
</div>
<a id="gadf4ce9117fcfa454c523ed6e6bd8b353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf4ce9117fcfa454c523ed6e6bd8b353">◆ </a></span>snd_device_name_hint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_device_name_hint </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>card</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *** </td>
<td class="paramname"><em>hints</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a set of device name hints. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">card</td><td>Card number or -1 (means all cards) </td></tr>
<tr><td class="paramname">iface</td><td>Interface identification (like "pcm", "rawmidi", "timer", "seq") </td></tr>
<tr><td class="paramname">hints</td><td>Result - array of device name hints </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code</dd></dl>
<p>hints will receive a NULL-terminated array of device name hints, which can be passed to <a class="el" href="group___hint.html#ga8546500ca828392f03f5bba2e7813874" title="Extract a value from a hint.">snd_device_name_get_hint</a> to extract usable values. When no longer needed, hints should be passed to <a class="el" href="group___hint.html#gad4cacf29df4616c2458fc84c1fde708c" title="Free a list of device name hints.">snd_device_name_free_hint</a> to release resources.</p>
<p>User-defined hints are gathered from namehint.IFACE tree like:</p>
<p><code> namehint.pcm [<br />
myfile "file:FILE=/tmp/soundwave.raw|Save sound output to /tmp/soundwave.raw"<br />
myplug "plug:front|Do all conversions for front speakers"<br />
] </code></p>
<p>Note: The device description is separated with '|' char.</p>
<p>Special variables: defaults.namehint.showall specifies if all device definitions are accepted (boolean type). </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>