<!-- 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: Status 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>Status 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>Defines</h2></td></tr>
<tr><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><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="#ga046c09e5d14b684d9fefd70a12cdde1a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><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><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="#ga6a8ae2a4786419af7853687a99436d8d"></a><br/></td></tr>
<tr><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><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="#gaa97cf9bdc31e686fe491985486194a64"></a><br/></td></tr>
<tr><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><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="#gaeb0a7ff880647e7255cb58904270106b"></a><br/></td></tr>
<tr><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><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="#ga307827ec2057b969520c7508fe41dd63"></a><br/></td></tr>
<tr><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><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="#gabaae998f0d374c50195b3206d1e43659"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get trigger timestamp from a PCM status container. <a href="#ga5eaeff98814e96c2ffd5f04c95b22c8d"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get trigger hi-res timestamp from a PCM status container. <a href="#gab1c832aedb25670d010c53d9081a4b31"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get "now" timestamp from a PCM status container. <a href="#gaea54e0a110afa01dd42071a1ca43902e"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get "now" hi-res timestamp from a PCM status container. <a href="#gafa66bda27a6b914e66e053bb76571013"></a><br/></td></tr>
<tr><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><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="#ga1fdce3985e64f66385a5805da1110f18"></a><br/></td></tr>
<tr><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><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="#ga91c110525060b925ad4f0c21c205b757"></a><br/></td></tr>
<tr><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><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="#gac58d13e4d03c9420c57428ddffd94964"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get count of ADC overrange detections since last call. <a href="#ga3f4bfd0a0327529abaa621b248b6b1aa"></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>Define Documentation</h2>
<a class="anchor" id="ga046c09e5d14b684d9fefd70a12cdde1a"></a><!-- doxytag: member="pcm.h::snd_pcm_status_alloca" ref="ga046c09e5d14b684d9fefd70a12cdde1a" args="(ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define snd_pcm_status_alloca</td>
<td>(</td>
<td class="paramtype">ptr </td>
<td class="paramname"></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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>returned pointer </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a30">/test/latency.c</a>.</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga307827ec2057b969520c7508fe41dd63"></a><!-- doxytag: member="pcm.h::snd_pcm_status_copy" ref="ga307827ec2057b969520c7508fe41dd63" args="(snd_pcm_status_t *dst, const snd_pcm_status_t *src)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dst</em> </td><td>pointer to destination </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>pointer to source </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaeb0a7ff880647e7255cb58904270106b"></a><!-- doxytag: member="pcm.h::snd_pcm_status_free" ref="gaeb0a7ff880647e7255cb58904270106b" args="(snd_pcm_status_t *obj)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>pointer to object to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga91c110525060b925ad4f0c21c205b757"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_avail" ref="ga91c110525060b925ad4f0c21c205b757" args="(const snd_pcm_status_t *obj)" -->
<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="return"><dt><b>Returns:</b></dt><dd>Number of frames ready to be read/written </dd></dl>
</div>
</div>
<a class="anchor" id="gac58d13e4d03c9420c57428ddffd94964"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_avail_max" ref="gac58d13e4d03c9420c57428ddffd94964" args="(const snd_pcm_status_t *obj)" -->
<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="return"><dt><b>Returns:</b></dt><dd>Maximum number of frames ready to be read/written </dd></dl>
</div>
</div>
<a class="anchor" id="ga1fdce3985e64f66385a5805da1110f18"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_delay" ref="ga1fdce3985e64f66385a5805da1110f18" args="(const snd_pcm_status_t *obj)" -->
<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="return"><dt><b>Returns:</b></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 class="anchor" id="gafa66bda27a6b914e66e053bb76571013"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_htstamp" ref="gafa66bda27a6b914e66e053bb76571013" args="(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>pointer to <a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3f4bfd0a0327529abaa621b248b6b1aa"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_overrange" ref="ga3f4bfd0a0327529abaa621b248b6b1aa" args="(const snd_pcm_status_t *obj)" -->
<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="return"><dt><b>Returns:</b></dt><dd>Count of ADC overrange detections </dd></dl>
</div>
</div>
<a class="anchor" id="gabaae998f0d374c50195b3206d1e43659"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_state" ref="gabaae998f0d374c50195b3206d1e43659" args="(const snd_pcm_status_t *obj)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </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="return"><dt><b>Returns:</b></dt><dd>PCM state </dd></dl>
</div>
</div>
<a class="anchor" id="gab1c832aedb25670d010c53d9081a4b31"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_trigger_htstamp" ref="gab1c832aedb25670d010c53d9081a4b31" args="(const snd_pcm_status_t *obj, snd_htimestamp_t *ptr)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </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 class="anchor" id="ga5eaeff98814e96c2ffd5f04c95b22c8d"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_trigger_tstamp" ref="ga5eaeff98814e96c2ffd5f04c95b22c8d" args="(const snd_pcm_status_t *obj, snd_timestamp_t *ptr)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </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><dt><b>Examples: </b></dt><dd><a class="el" href="_2test_2latency_8c-example.html#a34">/test/latency.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaea54e0a110afa01dd42071a1ca43902e"></a><!-- doxytag: member="pcm.h::snd_pcm_status_get_tstamp" ref="gaea54e0a110afa01dd42071a1ca43902e" args="(const snd_pcm_status_t *obj, snd_timestamp_t *ptr)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td><a class="el" href="group___p_c_m.html#ga902b87281c46910b469d5f7aaafc1890">snd_pcm_status_t</a> pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>Pointer to returned timestamp </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa97cf9bdc31e686fe491985486194a64"></a><!-- doxytag: member="pcm.h::snd_pcm_status_malloc" ref="gaa97cf9bdc31e686fe491985486194a64" args="(snd_pcm_status_t **ptr)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>returned pointer </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success otherwise negative error code </dd></dl>
</div>
</div>
<a class="anchor" id="ga6a8ae2a4786419af7853687a99436d8d"></a><!-- doxytag: member="pcm.h::snd_pcm_status_sizeof" ref="ga6a8ae2a4786419af7853687a99436d8d" args="(void)" -->
<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="return"><dt><b>Returns:</b></dt><dd>size in bytes </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>
