| Current File : //proc/self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/group___p_c_m___status.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: Status Functions</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="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Status Functions<div class="ingroups"><a class="el" href="group___p_c_m.html">PCM Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga046c09e5d14b684d9fefd70a12cdde1a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga046c09e5d14b684d9fefd70a12cdde1a">snd_pcm_status_alloca</a>(ptr)</td></tr>
<tr class="memdesc:ga046c09e5d14b684d9fefd70a12cdde1a"><td class="mdescLeft"> </td><td class="mdescRight">allocate an invalid <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> using standard alloca <a href="group___p_c_m___status.html#ga046c09e5d14b684d9fefd70a12cdde1a">More...</a><br /></td></tr>
<tr class="separator:ga046c09e5d14b684d9fefd70a12cdde1a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6a8ae2a4786419af7853687a99436d8d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga6a8ae2a4786419af7853687a99436d8d">snd_pcm_status_sizeof</a> (void)</td></tr>
<tr class="memdesc:ga6a8ae2a4786419af7853687a99436d8d"><td class="mdescLeft"> </td><td class="mdescRight">get size of <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> <a href="group___p_c_m___status.html#ga6a8ae2a4786419af7853687a99436d8d">More...</a><br /></td></tr>
<tr class="separator:ga6a8ae2a4786419af7853687a99436d8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa97cf9bdc31e686fe491985486194a64"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gaa97cf9bdc31e686fe491985486194a64">snd_pcm_status_malloc</a> (<a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> **ptr)</td></tr>
<tr class="memdesc:gaa97cf9bdc31e686fe491985486194a64"><td class="mdescLeft"> </td><td class="mdescRight">allocate an invalid <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> using standard malloc <a href="group___p_c_m___status.html#gaa97cf9bdc31e686fe491985486194a64">More...</a><br /></td></tr>
<tr class="separator:gaa97cf9bdc31e686fe491985486194a64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb0a7ff880647e7255cb58904270106b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gaeb0a7ff880647e7255cb58904270106b">snd_pcm_status_free</a> (<a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:gaeb0a7ff880647e7255cb58904270106b"><td class="mdescLeft"> </td><td class="mdescRight">frees a previously allocated <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> <a href="group___p_c_m___status.html#gaeb0a7ff880647e7255cb58904270106b">More...</a><br /></td></tr>
<tr class="separator:gaeb0a7ff880647e7255cb58904270106b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga307827ec2057b969520c7508fe41dd63"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga307827ec2057b969520c7508fe41dd63">snd_pcm_status_copy</a> (<a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *dst, const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *src)</td></tr>
<tr class="memdesc:ga307827ec2057b969520c7508fe41dd63"><td class="mdescLeft"> </td><td class="mdescRight">copy one <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> to another <a href="group___p_c_m___status.html#ga307827ec2057b969520c7508fe41dd63">More...</a><br /></td></tr>
<tr class="separator:ga307827ec2057b969520c7508fe41dd63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabaae998f0d374c50195b3206d1e43659"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#ga61ac499cb3701ce536d4d83725908860">snd_pcm_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gabaae998f0d374c50195b3206d1e43659">snd_pcm_status_get_state</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:gabaae998f0d374c50195b3206d1e43659"><td class="mdescLeft"> </td><td class="mdescRight">Get state from a PCM status container (see <a class="el" href="group___p_c_m.html#ga87896f6f17020fc19835790369e7ce75" title="Return PCM state.">snd_pcm_state</a>) <a href="group___p_c_m___status.html#gabaae998f0d374c50195b3206d1e43659">More...</a><br /></td></tr>
<tr class="separator:gabaae998f0d374c50195b3206d1e43659"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5eaeff98814e96c2ffd5f04c95b22c8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga5eaeff98814e96c2ffd5f04c95b22c8d">snd_pcm_status_get_trigger_tstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#gadd377862d568809fb0e32c9faddf99a4">snd_timestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:ga5eaeff98814e96c2ffd5f04c95b22c8d"><td class="mdescLeft"> </td><td class="mdescRight">Get trigger timestamp from a PCM status container. <a href="group___p_c_m___status.html#ga5eaeff98814e96c2ffd5f04c95b22c8d">More...</a><br /></td></tr>
<tr class="separator:ga5eaeff98814e96c2ffd5f04c95b22c8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1c832aedb25670d010c53d9081a4b31"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gab1c832aedb25670d010c53d9081a4b31">snd_pcm_status_get_trigger_htstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:gab1c832aedb25670d010c53d9081a4b31"><td class="mdescLeft"> </td><td class="mdescRight">Get trigger hi-res timestamp from a PCM status container. <a href="group___p_c_m___status.html#gab1c832aedb25670d010c53d9081a4b31">More...</a><br /></td></tr>
<tr class="separator:gab1c832aedb25670d010c53d9081a4b31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaea54e0a110afa01dd42071a1ca43902e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gaea54e0a110afa01dd42071a1ca43902e">snd_pcm_status_get_tstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#gadd377862d568809fb0e32c9faddf99a4">snd_timestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:gaea54e0a110afa01dd42071a1ca43902e"><td class="mdescLeft"> </td><td class="mdescRight">Get "now" timestamp from a PCM status container. <a href="group___p_c_m___status.html#gaea54e0a110afa01dd42071a1ca43902e">More...</a><br /></td></tr>
<tr class="separator:gaea54e0a110afa01dd42071a1ca43902e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa66bda27a6b914e66e053bb76571013"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gafa66bda27a6b914e66e053bb76571013">snd_pcm_status_get_htstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:gafa66bda27a6b914e66e053bb76571013"><td class="mdescLeft"> </td><td class="mdescRight">Get "now" hi-res timestamp from a PCM status container. <a href="group___p_c_m___status.html#gafa66bda27a6b914e66e053bb76571013">More...</a><br /></td></tr>
<tr class="separator:gafa66bda27a6b914e66e053bb76571013"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15d17e74f3352e189df5ccd4cc4c116d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga15d17e74f3352e189df5ccd4cc4c116d">snd_pcm_status_get_audio_htstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:ga15d17e74f3352e189df5ccd4cc4c116d"><td class="mdescLeft"> </td><td class="mdescRight">Get "now" hi-res audio timestamp from a PCM status container. <a href="group___p_c_m___status.html#ga15d17e74f3352e189df5ccd4cc4c116d">More...</a><br /></td></tr>
<tr class="separator:ga15d17e74f3352e189df5ccd4cc4c116d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ee47c7a98005629ec691eae4b7f1b0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga6ee47c7a98005629ec691eae4b7f1b0e">snd_pcm_status_get_driver_htstamp</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> *ptr)</td></tr>
<tr class="memdesc:ga6ee47c7a98005629ec691eae4b7f1b0e"><td class="mdescLeft"> </td><td class="mdescRight">Get "now" hi-res driver timestamp from a PCM status container. Defines when the status was generated by driver, may differ from normal timestamp. <a href="group___p_c_m___status.html#ga6ee47c7a98005629ec691eae4b7f1b0e">More...</a><br /></td></tr>
<tr class="separator:ga6ee47c7a98005629ec691eae4b7f1b0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79a7e633c36d79aab76c3b4ee39e1588"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga79a7e633c36d79aab76c3b4ee39e1588">snd_pcm_status_get_audio_htstamp_report</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="structsnd__pcm__audio__tstamp__report__t.html">snd_pcm_audio_tstamp_report_t</a> *audio_tstamp_report)</td></tr>
<tr class="memdesc:ga79a7e633c36d79aab76c3b4ee39e1588"><td class="mdescLeft"> </td><td class="mdescRight">Get audio_tstamp_report from a PCM status container. <a href="group___p_c_m___status.html#ga79a7e633c36d79aab76c3b4ee39e1588">More...</a><br /></td></tr>
<tr class="separator:ga79a7e633c36d79aab76c3b4ee39e1588"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad0dba60f0f312167755500cb49e24eb3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gad0dba60f0f312167755500cb49e24eb3">snd_pcm_status_set_audio_htstamp_config</a> (<a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj, <a class="el" href="structsnd__pcm__audio__tstamp__config__t.html">snd_pcm_audio_tstamp_config_t</a> *audio_tstamp_config)</td></tr>
<tr class="memdesc:gad0dba60f0f312167755500cb49e24eb3"><td class="mdescLeft"> </td><td class="mdescRight">set audio_tstamp_config from a PCM status container <a href="group___p_c_m___status.html#gad0dba60f0f312167755500cb49e24eb3">More...</a><br /></td></tr>
<tr class="separator:gad0dba60f0f312167755500cb49e24eb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1fdce3985e64f66385a5805da1110f18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#ga71cdfa37e258d2210b8bd0216bf0c36c">snd_pcm_sframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga1fdce3985e64f66385a5805da1110f18">snd_pcm_status_get_delay</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:ga1fdce3985e64f66385a5805da1110f18"><td class="mdescLeft"> </td><td class="mdescRight">Get delay from a PCM status container (see <a class="el" href="group___p_c_m.html#ga012e8b999070e72ab23514f25e7d6482" title="Obtain delay for a running PCM handle.">snd_pcm_delay</a>) <a href="group___p_c_m___status.html#ga1fdce3985e64f66385a5805da1110f18">More...</a><br /></td></tr>
<tr class="separator:ga1fdce3985e64f66385a5805da1110f18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91c110525060b925ad4f0c21c205b757"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga91c110525060b925ad4f0c21c205b757">snd_pcm_status_get_avail</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:ga91c110525060b925ad4f0c21c205b757"><td class="mdescLeft"> </td><td class="mdescRight">Get number of frames available from a PCM status container (see <a class="el" href="group___p_c_m.html#ga8bb836bd0c414b59789d51a5f5379c08" title="Return number of frames ready to be read (capture) / written (playback)">snd_pcm_avail_update</a>) <a href="group___p_c_m___status.html#ga91c110525060b925ad4f0c21c205b757">More...</a><br /></td></tr>
<tr class="separator:ga91c110525060b925ad4f0c21c205b757"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac58d13e4d03c9420c57428ddffd94964"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#gac58d13e4d03c9420c57428ddffd94964">snd_pcm_status_get_avail_max</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:gac58d13e4d03c9420c57428ddffd94964"><td class="mdescLeft"> </td><td class="mdescRight">Get maximum number of frames available from a PCM status container after last <a class="el" href="group___p_c_m.html#ga32891eaac37741728a9b23027012c892" title="Obtain status (runtime) information for PCM handle.">snd_pcm_status</a> call. <a href="group___p_c_m___status.html#gac58d13e4d03c9420c57428ddffd94964">More...</a><br /></td></tr>
<tr class="separator:gac58d13e4d03c9420c57428ddffd94964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f4bfd0a0327529abaa621b248b6b1aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_c_m___status.html#ga3f4bfd0a0327529abaa621b248b6b1aa">snd_pcm_status_get_overrange</a> (const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> *obj)</td></tr>
<tr class="memdesc:ga3f4bfd0a0327529abaa621b248b6b1aa"><td class="mdescLeft"> </td><td class="mdescRight">Get count of ADC overrange detections since last call. <a href="group___p_c_m___status.html#ga3f4bfd0a0327529abaa621b248b6b1aa">More...</a><br /></td></tr>
<tr class="separator:ga3f4bfd0a0327529abaa621b248b6b1aa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>See the <a class="el" href="pcm.html">PCM (digital audio) interface</a> page for more details. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga046c09e5d14b684d9fefd70a12cdde1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga046c09e5d14b684d9fefd70a12cdde1a">◆ </a></span>snd_pcm_status_alloca</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define snd_pcm_status_alloca</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">ptr</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>allocate an invalid <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> using standard alloca </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>returned pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2test_2latency_8c-example.html#a29">/test/latency.c</a>.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga307827ec2057b969520c7508fe41dd63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga307827ec2057b969520c7508fe41dd63">◆ </a></span>snd_pcm_status_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy one <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> to another </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>pointer to destination </td></tr>
<tr><td class="paramname">src</td><td>pointer to source </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaeb0a7ff880647e7255cb58904270106b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb0a7ff880647e7255cb58904270106b">◆ </a></span>snd_pcm_status_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>frees a previously allocated <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to object to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga15d17e74f3352e189df5ccd4cc4c116d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15d17e74f3352e189df5ccd4cc4c116d">◆ </a></span>snd_pcm_status_get_audio_htstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_audio_htstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get "now" hi-res audio timestamp from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga79a7e633c36d79aab76c3b4ee39e1588"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga79a7e633c36d79aab76c3b4ee39e1588">◆ </a></span>snd_pcm_status_get_audio_htstamp_report()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_audio_htstamp_report </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsnd__pcm__audio__tstamp__report__t.html">snd_pcm_audio_tstamp_report_t</a> * </td>
<td class="paramname"><em>audio_tstamp_report</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get audio_tstamp_report from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td class="paramname">audio_tstamp_report</td><td>Pointer to returned report </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga91c110525060b925ad4f0c21c205b757"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga91c110525060b925ad4f0c21c205b757">◆ </a></span>snd_pcm_status_get_avail()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> snd_pcm_status_get_avail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of frames available from a PCM status container (see <a class="el" href="group___p_c_m.html#ga8bb836bd0c414b59789d51a5f5379c08" title="Return number of frames ready to be read (capture) / written (playback)">snd_pcm_avail_update</a>) </p>
<dl class="section return"><dt>Returns</dt><dd>Number of frames ready to be read/written </dd></dl>
</div>
</div>
<a id="gac58d13e4d03c9420c57428ddffd94964"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac58d13e4d03c9420c57428ddffd94964">◆ </a></span>snd_pcm_status_get_avail_max()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> snd_pcm_status_get_avail_max </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get maximum number of frames available from a PCM status container after last <a class="el" href="group___p_c_m.html#ga32891eaac37741728a9b23027012c892" title="Obtain status (runtime) information for PCM handle.">snd_pcm_status</a> call. </p>
<dl class="section return"><dt>Returns</dt><dd>Maximum number of frames ready to be read/written</dd></dl>
<p>This value returns the peak for the available frames between <a class="el" href="group___p_c_m.html#ga32891eaac37741728a9b23027012c892" title="Obtain status (runtime) information for PCM handle.">snd_pcm_status</a> calls. </p>
</div>
</div>
<a id="ga1fdce3985e64f66385a5805da1110f18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1fdce3985e64f66385a5805da1110f18">◆ </a></span>snd_pcm_status_get_delay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#ga71cdfa37e258d2210b8bd0216bf0c36c">snd_pcm_sframes_t</a> snd_pcm_status_get_delay </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get delay from a PCM status container (see <a class="el" href="group___p_c_m.html#ga012e8b999070e72ab23514f25e7d6482" title="Obtain delay for a running PCM handle.">snd_pcm_delay</a>) </p>
<dl class="section return"><dt>Returns</dt><dd>Delay in frames</dd></dl>
<p>Delay is distance between current application frame position and sound frame position. It's positive and less than buffer size in normal situation, negative on playback underrun and greater than buffer size on capture overrun. </p>
</div>
</div>
<a id="ga6ee47c7a98005629ec691eae4b7f1b0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ee47c7a98005629ec691eae4b7f1b0e">◆ </a></span>snd_pcm_status_get_driver_htstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_driver_htstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get "now" hi-res driver timestamp from a PCM status container. Defines when the status was generated by driver, may differ from normal timestamp. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafa66bda27a6b914e66e053bb76571013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa66bda27a6b914e66e053bb76571013">◆ </a></span>snd_pcm_status_get_htstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_htstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get "now" hi-res timestamp from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3f4bfd0a0327529abaa621b248b6b1aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f4bfd0a0327529abaa621b248b6b1aa">◆ </a></span>snd_pcm_status_get_overrange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#gab01fcfe9b97382a8d3f2027c664b8b8a">snd_pcm_uframes_t</a> snd_pcm_status_get_overrange </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get count of ADC overrange detections since last call. </p>
<dl class="section return"><dt>Returns</dt><dd>Count of ADC overrange detections </dd></dl>
</div>
</div>
<a id="gabaae998f0d374c50195b3206d1e43659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabaae998f0d374c50195b3206d1e43659">◆ </a></span>snd_pcm_status_get_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___p_c_m.html#ga61ac499cb3701ce536d4d83725908860">snd_pcm_state_t</a> snd_pcm_status_get_state </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get state from a PCM status container (see <a class="el" href="group___p_c_m.html#ga87896f6f17020fc19835790369e7ce75" title="Return PCM state.">snd_pcm_state</a>) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>PCM state </dd></dl>
</div>
</div>
<a id="gab1c832aedb25670d010c53d9081a4b31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1c832aedb25670d010c53d9081a4b31">◆ </a></span>snd_pcm_status_get_trigger_htstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_trigger_htstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#ga3a3f5b65c40f498cdbc26944bd9855cf">snd_htimestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get trigger hi-res timestamp from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp</td></tr>
</table>
</dd>
</dl>
<p>Trigger means a PCM state transition (from stopped to running or versa vice). It applies also to pause and suspend. In other words, timestamp contains time when stream started or when it was stopped. </p>
</div>
</div>
<a id="ga5eaeff98814e96c2ffd5f04c95b22c8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5eaeff98814e96c2ffd5f04c95b22c8d">◆ </a></span>snd_pcm_status_get_trigger_tstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_trigger_tstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#gadd377862d568809fb0e32c9faddf99a4">snd_timestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get trigger timestamp from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp</td></tr>
</table>
</dd>
</dl>
<p>Trigger means a PCM state transition (from stopped to running or versa vice). It applies also to pause and suspend. In other words, timestamp contains time when stream started or when it was stopped. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2test_2latency_8c-example.html#a32">/test/latency.c</a>.</dd>
</dl>
</div>
</div>
<a id="gaea54e0a110afa01dd42071a1ca43902e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea54e0a110afa01dd42071a1ca43902e">◆ </a></span>snd_pcm_status_get_tstamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_get_tstamp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___global.html#gadd377862d568809fb0e32c9faddf99a4">snd_timestamp_t</a> * </td>
<td class="paramname"><em>ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get "now" timestamp from a PCM status container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td class="paramname">ptr</td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa97cf9bdc31e686fe491985486194a64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa97cf9bdc31e686fe491985486194a64">◆ </a></span>snd_pcm_status_malloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_pcm_status_malloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> ** </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>allocate an invalid <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> using standard malloc </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>returned pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success otherwise negative error code </dd></dl>
</div>
</div>
<a id="gad0dba60f0f312167755500cb49e24eb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0dba60f0f312167755500cb49e24eb3">◆ </a></span>snd_pcm_status_set_audio_htstamp_config()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void snd_pcm_status_set_audio_htstamp_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> * </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structsnd__pcm__audio__tstamp__config__t.html">snd_pcm_audio_tstamp_config_t</a> * </td>
<td class="paramname"><em>audio_tstamp_config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set audio_tstamp_config from a PCM status container </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td class="paramname">audio_tstamp_config</td><td>Pointer to config (valid fields are type_requested and report_delay) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6a8ae2a4786419af7853687a99436d8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a8ae2a4786419af7853687a99436d8d">◆ </a></span>snd_pcm_status_sizeof()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t snd_pcm_status_sizeof </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get size of <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </p>
<dl class="section return"><dt>Returns</dt><dd>size in bytes </dd></dl>
</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>