<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Status Functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center>
<hr><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></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a11">snd_pcm_status_alloca</a>(ptr)</td></tr>
<tr><td> </td><td><font size=-1><em>allocate an invalid <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> using standard alloca</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a0">snd_pcm_status_sizeof</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>get size of <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a></em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a1">snd_pcm_status_malloc</a> (<a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> **ptr)</td></tr>
<tr><td> </td><td><font size=-1><em>allocate an invalid <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> using standard malloc</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a2">snd_pcm_status_free</a> (<a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>frees a previously allocated <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a></em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a3">snd_pcm_status_copy</a> (<a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *dst, const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *src)</td></tr>
<tr><td> </td><td><font size=-1><em>copy one <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> to another</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a13">snd_pcm_state_t</a> </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a4">snd_pcm_status_get_state</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>Get state from a PCM status container (see <a class="el" href="pcm_8c.html#a11">snd_pcm_state</a>).</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a5">snd_pcm_status_get_trigger_tstamp</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj, <a class="el" href="group___p_c_m.html#a19">snd_timestamp_t</a> *ptr)</td></tr>
<tr><td> </td><td><font size=-1><em>Get trigger timestamp from a PCM status container.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a6">snd_pcm_status_get_tstamp</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj, <a class="el" href="group___p_c_m.html#a19">snd_timestamp_t</a> *ptr)</td></tr>
<tr><td> </td><td><font size=-1><em>Get "now" timestamp from a PCM status container.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a18">snd_pcm_sframes_t</a> </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a7">snd_pcm_status_get_delay</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>Get delay from a PCM status container (see <a class="el" href="pcm_8c.html#a13">snd_pcm_delay</a>).</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a8">snd_pcm_status_get_avail</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>Get number of frames available from a PCM status container (see <a class="el" href="pcm_8c.html#a58">snd_pcm_avail_update</a>).</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a9">snd_pcm_status_get_avail_max</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>Get maximum number of frames available from a PCM status container after last <a class="el" href="pcm_8c.html#a10">snd_pcm_status</a> call.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> </td><td valign=bottom><a class="el" href="group___p_c_m___status.html#a10">snd_pcm_status_get_overrange</a> (const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> *obj)</td></tr>
<tr><td> </td><td><font size=-1><em>Get count of ADC overrange detections since last call.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
See the <a href="pcm.html#pcm">PCM (digital audio) interface</a> page for more details. <hr><h2>Define Documentation</h2>
<a name="a11" doxytag="pcm.h::snd_pcm_status_alloca"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define snd_pcm_status_alloca</td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">ptr </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
allocate an invalid <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> using standard alloca
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ptr</em> </td><td>
returned pointer </td></tr>
</table>
</dl><dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_2test_2latency_8c-example.html#a24">/test/latency.c</a>.</dl> </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a3" doxytag="pcm.h::snd_pcm_status_copy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void snd_pcm_status_copy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname" nowrap> <em>dst</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname" nowrap> <em>src</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
copy one <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> to another
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dst</em> </td><td>
pointer to destination </td></tr>
<tr><td valign=top><em>src</em> </td><td>
pointer to source </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="pcm.h::snd_pcm_status_free"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void snd_pcm_status_free </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
frees a previously allocated <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pointer</em> </td><td>
to object to free </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="pcm.h::snd_pcm_status_get_avail"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> snd_pcm_status_get_avail </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get number of frames available from a PCM status container (see <a class="el" href="group___p_c_m.html#a54">snd_pcm_avail_update</a>).
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Number of frames ready to be read/written </dl> </td>
</tr>
</table>
<a name="a9" doxytag="pcm.h::snd_pcm_status_get_avail_max"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> snd_pcm_status_get_avail_max </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get maximum number of frames available from a PCM status container after last <a class="el" href="group___p_c_m.html#a45">snd_pcm_status</a> call.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Maximum number of frames ready to be read/written </dl> </td>
</tr>
</table>
<a name="a7" doxytag="pcm.h::snd_pcm_status_get_delay"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a18">snd_pcm_sframes_t</a> snd_pcm_status_get_delay </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get delay from a PCM status container (see <a class="el" href="group___p_c_m.html#a52">snd_pcm_delay</a>).
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Delay in frames</dl>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. </td>
</tr>
</table>
<a name="a10" doxytag="pcm.h::snd_pcm_status_get_overrange"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a17">snd_pcm_uframes_t</a> snd_pcm_status_get_overrange </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get count of ADC overrange detections since last call.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Count of ADC overrange detections </dl> </td>
</tr>
</table>
<a name="a4" doxytag="pcm.h::snd_pcm_status_get_state"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group___p_c_m.html#a13">snd_pcm_state_t</a> snd_pcm_status_get_state </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>obj</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get state from a PCM status container (see <a class="el" href="group___p_c_m.html#a50">snd_pcm_state</a>).
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
PCM state </dl> </td>
</tr>
</table>
<a name="a5" doxytag="pcm.h::snd_pcm_status_get_trigger_tstamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void snd_pcm_status_get_trigger_tstamp </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname" nowrap> <em>obj</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group___p_c_m.html#a19">snd_timestamp_t</a> * </td>
<td class="mdname" nowrap> <em>ptr</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get trigger timestamp from a PCM status container.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ptr</em> </td><td>
Pointer to returned timestamp </td></tr>
</table>
</dl><dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="_2test_2latency_8c-example.html#a27">/test/latency.c</a>.</dl> </td>
</tr>
</table>
<a name="a6" doxytag="pcm.h::snd_pcm_status_get_tstamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void snd_pcm_status_get_tstamp </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> * </td>
<td class="mdname" nowrap> <em>obj</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group___p_c_m.html#a19">snd_timestamp_t</a> * </td>
<td class="mdname" nowrap> <em>ptr</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get "now" timestamp from a PCM status container.
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ptr</em> </td><td>
Pointer to returned timestamp </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="pcm.h::snd_pcm_status_malloc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int snd_pcm_status_malloc </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> ** </td>
<td class="mdname1" valign="top" nowrap> <em>ptr</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
allocate an invalid <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a> using standard malloc
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ptr</em> </td><td>
returned pointer </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
0 on success otherwise negative error code </dl> </td>
</tr>
</table>
<a name="a0" doxytag="pcm.h::snd_pcm_status_sizeof"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t snd_pcm_status_sizeof </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
get size of <a class="el" href="group___p_c_m.html#a3">snd_pcm_status_t</a>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
size in bytes </dl> </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Wed Apr 2 16:06:38 2003 for ALSA project - the C library reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
updates
>
by-pkgid
>
18785641029f14f23cccc82925607ace
>
files
>
64
