<!-- 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: Description Functions</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>Description Functions<br/>
<small>
[<a class="el" href="group___p_c_m.html">PCM Interface</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga1089d73f52de6e7b724f7453d6f48f36">snd_pcm_type_name</a> (<a class="el" href="group___p_c_m.html#gaca6314f46f54a0b62536c403bbb62601">snd_pcm_type_t</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM type <a href="#ga1089d73f52de6e7b724f7453d6f48f36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#gafea7e7c65133faec1da1ef8b2d079578">snd_pcm_stream_name</a> (const <a class="el" href="group___p_c_m.html#gac23b43ff55add78638e503b9cc892c24">snd_pcm_stream_t</a> stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM stream type <a href="#gafea7e7c65133faec1da1ef8b2d079578"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga1406fe8388a612b8e44e5f3682d00e91">snd_pcm_access_name</a> (const <a class="el" href="group___p_c_m.html#ga661221ba5e8f1d6eaf4ab8e2da57cc1a">snd_pcm_access_t</a> _access)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM access type <a href="#ga1406fe8388a612b8e44e5f3682d00e91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga2ca258b8ac569ca35f283e48d2181e45">snd_pcm_format_name</a> (const <a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM sample format <a href="#ga2ca258b8ac569ca35f283e48d2181e45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#gae201c92e3053c778bd7f2a4f5cc4d0e1">snd_pcm_format_description</a> (const <a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get description of PCM sample format <a href="#gae201c92e3053c778bd7f2a4f5cc4d0e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga81beb8c430d897208269bd67bb3309b5">snd_pcm_subformat_name</a> (const <a class="el" href="group___p_c_m.html#ga1e5fe73a6bdf881e2f91921d5e5327c7">snd_pcm_subformat_t</a> subformat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM sample subformat <a href="#ga81beb8c430d897208269bd67bb3309b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#gaf4e162f7a059cbbf8c388cb9ed5e23fc">snd_pcm_subformat_description</a> (const <a class="el" href="group___p_c_m.html#ga1e5fe73a6bdf881e2f91921d5e5327c7">snd_pcm_subformat_t</a> subformat)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get description of PCM sample subformat <a href="#gaf4e162f7a059cbbf8c388cb9ed5e23fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga59f99dd9647315a7312d1f2b6204b7bc">snd_pcm_format_value</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get PCM sample format from name <a href="#ga59f99dd9647315a7312d1f2b6204b7bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga9a27f18595344de572cce51c4e52ec4e">snd_pcm_tstamp_mode_name</a> (const <a class="el" href="group___p_c_m.html#ga695a9755880cf886c13d07938f92ea77">snd_pcm_tstamp_t</a> mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get name of PCM tstamp mode setting <a href="#ga9a27f18595344de572cce51c4e52ec4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___description.html#ga16ea2b82b7ea8f8c7b21e81aa6d28f1f">snd_pcm_state_name</a> (const <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">get name of PCM state <a href="#ga16ea2b82b7ea8f8c7b21e81aa6d28f1f"></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>Function Documentation</h2>
<a class="anchor" id="ga1406fe8388a612b8e44e5f3682d00e91"></a><!-- doxytag: member="pcm.h::snd_pcm_access_name" ref="ga1406fe8388a612b8e44e5f3682d00e91" args="(const snd_pcm_access_t _access)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_access_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga661221ba5e8f1d6eaf4ab8e2da57cc1a">snd_pcm_access_t</a> </td>
<td class="paramname"> <em>acc</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM access type </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>acc</em> </td><td>PCM access type </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM access type </dd></dl>
</div>
</div>
<a class="anchor" id="gae201c92e3053c778bd7f2a4f5cc4d0e1"></a><!-- doxytag: member="pcm.h::snd_pcm_format_description" ref="gae201c92e3053c778bd7f2a4f5cc4d0e1" args="(const snd_pcm_format_t format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_format_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> </td>
<td class="paramname"> <em>format</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get description of PCM sample format </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>PCM sample format </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii description of PCM sample format </dd></dl>
</div>
</div>
<a class="anchor" id="ga2ca258b8ac569ca35f283e48d2181e45"></a><!-- doxytag: member="pcm.h::snd_pcm_format_name" ref="ga2ca258b8ac569ca35f283e48d2181e45" args="(const snd_pcm_format_t format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_format_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> </td>
<td class="paramname"> <em>format</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM sample format </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>PCM sample format </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM sample format </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a38">/test/latency.c</a>, and <a class="el" href="_2test_2pcm_8c-example.html#a57">/test/pcm.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga59f99dd9647315a7312d1f2b6204b7bc"></a><!-- doxytag: member="pcm.h::snd_pcm_format_value" ref="ga59f99dd9647315a7312d1f2b6204b7bc" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#gaa14b7f26877a812acbb39811364177f8">snd_pcm_format_t</a> snd_pcm_format_value </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get PCM sample format from name </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>PCM sample format name (case insensitive) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>PCM sample format </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a39">/test/latency.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga16ea2b82b7ea8f8c7b21e81aa6d28f1f"></a><!-- doxytag: member="pcm.h::snd_pcm_state_name" ref="ga16ea2b82b7ea8f8c7b21e81aa6d28f1f" args="(const snd_pcm_state_t state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_state_name </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>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM state </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>PCM state </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM state </dd></dl>
</div>
</div>
<a class="anchor" id="gafea7e7c65133faec1da1ef8b2d079578"></a><!-- doxytag: member="pcm.h::snd_pcm_stream_name" ref="gafea7e7c65133faec1da1ef8b2d079578" args="(const snd_pcm_stream_t stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_stream_name </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>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM stream type </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>PCM stream type </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM stream type </dd></dl>
</div>
</div>
<a class="anchor" id="gaf4e162f7a059cbbf8c388cb9ed5e23fc"></a><!-- doxytag: member="pcm.h::snd_pcm_subformat_description" ref="gaf4e162f7a059cbbf8c388cb9ed5e23fc" args="(const snd_pcm_subformat_t subformat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_subformat_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga1e5fe73a6bdf881e2f91921d5e5327c7">snd_pcm_subformat_t</a> </td>
<td class="paramname"> <em>subformat</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get description of PCM sample subformat </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>subformat</em> </td><td>PCM sample subformat </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii description of PCM sample subformat </dd></dl>
</div>
</div>
<a class="anchor" id="ga81beb8c430d897208269bd67bb3309b5"></a><!-- doxytag: member="pcm.h::snd_pcm_subformat_name" ref="ga81beb8c430d897208269bd67bb3309b5" args="(const snd_pcm_subformat_t subformat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_subformat_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga1e5fe73a6bdf881e2f91921d5e5327c7">snd_pcm_subformat_t</a> </td>
<td class="paramname"> <em>subformat</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM sample subformat </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>subformat</em> </td><td>PCM sample subformat </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM sample subformat </dd></dl>
</div>
</div>
<a class="anchor" id="ga9a27f18595344de572cce51c4e52ec4e"></a><!-- doxytag: member="pcm.h::snd_pcm_tstamp_mode_name" ref="ga9a27f18595344de572cce51c4e52ec4e" args="(const snd_pcm_tstamp_t mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_tstamp_mode_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga695a9755880cf886c13d07938f92ea77">snd_pcm_tstamp_t</a> </td>
<td class="paramname"> <em>mode</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM tstamp mode setting </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>PCM tstamp mode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM tstamp mode setting </dd></dl>
</div>
</div>
<a class="anchor" id="ga1089d73f52de6e7b724f7453d6f48f36"></a><!-- doxytag: member="pcm.h::snd_pcm_type_name" ref="ga1089d73f52de6e7b724f7453d6f48f36" args="(snd_pcm_type_t type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* snd_pcm_type_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#gaca6314f46f54a0b62536c403bbb62601">snd_pcm_type_t</a> </td>
<td class="paramname"> <em>type</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get name of PCM type </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>PCM type </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>ascii name of PCM type </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>
