<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>PulseAudio: pa_timing_info Struct Reference</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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </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 style="padding-left: 0.5em;"> <div id="projectname">PulseAudio  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('structpa__timing__info.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">pa_timing_info Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>A structure for all kinds of timing information of a stream. <a href="structpa__timing__info.html#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a1d7bfa57c2980cb34fd535ba700057ff"><td class="memItemLeft" align="right" valign="top">struct timeval </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#a1d7bfa57c2980cb34fd535ba700057ff">timestamp</a></td></tr> <tr class="memdesc:a1d7bfa57c2980cb34fd535ba700057ff"><td class="mdescLeft"> </td><td class="mdescRight">The time when this timing info structure was current. <a href="#a1d7bfa57c2980cb34fd535ba700057ff"></a><br/></td></tr> <tr class="separator:a1d7bfa57c2980cb34fd535ba700057ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab1b6c3d12cca0172e5d10374cb2f322c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ab1b6c3d12cca0172e5d10374cb2f322c">synchronized_clocks</a></td></tr> <tr class="memdesc:ab1b6c3d12cca0172e5d10374cb2f322c"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if the local and the remote machine have synchronized clocks. <a href="#ab1b6c3d12cca0172e5d10374cb2f322c"></a><br/></td></tr> <tr class="separator:ab1b6c3d12cca0172e5d10374cb2f322c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1fa047dbabfc097c05ebc74f66a234c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#a1fa047dbabfc097c05ebc74f66a234c8">sink_usec</a></td></tr> <tr class="memdesc:a1fa047dbabfc097c05ebc74f66a234c8"><td class="mdescLeft"> </td><td class="mdescRight">Time in usecs a sample takes to be played on the sink. <a href="#a1fa047dbabfc097c05ebc74f66a234c8"></a><br/></td></tr> <tr class="separator:a1fa047dbabfc097c05ebc74f66a234c8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad34351f6a2480aa73a1afa9f9596768c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ad34351f6a2480aa73a1afa9f9596768c">source_usec</a></td></tr> <tr class="memdesc:ad34351f6a2480aa73a1afa9f9596768c"><td class="mdescLeft"> </td><td class="mdescRight">Time in usecs a sample takes from being recorded to being delivered to the application. <a href="#ad34351f6a2480aa73a1afa9f9596768c"></a><br/></td></tr> <tr class="separator:ad34351f6a2480aa73a1afa9f9596768c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac77f5e79645fd59640138d86e610d773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ac77f5e79645fd59640138d86e610d773">transport_usec</a></td></tr> <tr class="memdesc:ac77f5e79645fd59640138d86e610d773"><td class="mdescLeft"> </td><td class="mdescRight">Estimated time in usecs a sample takes to be transferred to/from the daemon. <a href="#ac77f5e79645fd59640138d86e610d773"></a><br/></td></tr> <tr class="separator:ac77f5e79645fd59640138d86e610d773"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa2b512f984e3d24e20159f542e80549a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#aa2b512f984e3d24e20159f542e80549a">playing</a></td></tr> <tr class="memdesc:aa2b512f984e3d24e20159f542e80549a"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero when the stream is currently not underrun and data is being passed on to the device. <a href="#aa2b512f984e3d24e20159f542e80549a"></a><br/></td></tr> <tr class="separator:aa2b512f984e3d24e20159f542e80549a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a28e63adc8b284fb2d2e90e302ba1e6e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#a28e63adc8b284fb2d2e90e302ba1e6e4">write_index_corrupt</a></td></tr> <tr class="memdesc:a28e63adc8b284fb2d2e90e302ba1e6e4"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if write_index is not up-to-date because a local write command that corrupted it has been issued in the time since this latency info was current . <a href="#a28e63adc8b284fb2d2e90e302ba1e6e4"></a><br/></td></tr> <tr class="separator:a28e63adc8b284fb2d2e90e302ba1e6e4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a378893046ab19c58fdb50633c66c5d4a"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#a378893046ab19c58fdb50633c66c5d4a">write_index</a></td></tr> <tr class="memdesc:a378893046ab19c58fdb50633c66c5d4a"><td class="mdescLeft"> </td><td class="mdescRight">Current write index into the playback buffer in bytes. <a href="#a378893046ab19c58fdb50633c66c5d4a"></a><br/></td></tr> <tr class="separator:a378893046ab19c58fdb50633c66c5d4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab675235e605a24a7be4486beaf0c65d9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ab675235e605a24a7be4486beaf0c65d9">read_index_corrupt</a></td></tr> <tr class="memdesc:ab675235e605a24a7be4486beaf0c65d9"><td class="mdescLeft"> </td><td class="mdescRight">Non-zero if read_index is not up-to-date because a local pause or flush request that corrupted it has been issued in the time since this latency info was current. <a href="#ab675235e605a24a7be4486beaf0c65d9"></a><br/></td></tr> <tr class="separator:ab675235e605a24a7be4486beaf0c65d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e04baf968cc1d53a7795a58b2e4f788"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#a5e04baf968cc1d53a7795a58b2e4f788">read_index</a></td></tr> <tr class="memdesc:a5e04baf968cc1d53a7795a58b2e4f788"><td class="mdescLeft"> </td><td class="mdescRight">Current read index into the playback buffer in bytes. <a href="#a5e04baf968cc1d53a7795a58b2e4f788"></a><br/></td></tr> <tr class="separator:a5e04baf968cc1d53a7795a58b2e4f788"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0289d7d18950165d8b81825cd03b9c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ab0289d7d18950165d8b81825cd03b9c8">configured_sink_usec</a></td></tr> <tr class="memdesc:ab0289d7d18950165d8b81825cd03b9c8"><td class="mdescLeft"> </td><td class="mdescRight">The configured latency for the sink. <a href="#ab0289d7d18950165d8b81825cd03b9c8"></a><br/></td></tr> <tr class="separator:ab0289d7d18950165d8b81825cd03b9c8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afa23d72067027b54b525ae547520a2df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#afa23d72067027b54b525ae547520a2df">configured_source_usec</a></td></tr> <tr class="memdesc:afa23d72067027b54b525ae547520a2df"><td class="mdescLeft"> </td><td class="mdescRight">The configured latency for the source. <a href="#afa23d72067027b54b525ae547520a2df"></a><br/></td></tr> <tr class="separator:afa23d72067027b54b525ae547520a2df"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad2f26c8efa733d738dade0ed1b8123d3"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__timing__info.html#ad2f26c8efa733d738dade0ed1b8123d3">since_underrun</a></td></tr> <tr class="memdesc:ad2f26c8efa733d738dade0ed1b8123d3"><td class="mdescLeft"> </td><td class="mdescRight">Bytes that were handed to the sink since the last underrun happened, or since playback started again after the last underrun. <a href="#ad2f26c8efa733d738dade0ed1b8123d3"></a><br/></td></tr> <tr class="separator:ad2f26c8efa733d738dade0ed1b8123d3"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A structure for all kinds of timing information of a stream. </p> <p>See <a class="el" href="stream_8h.html#ac8300aa5136a223b14a5384f44564284" title="Request a timing info structure update for a stream.">pa_stream_update_timing_info()</a> and <a class="el" href="stream_8h.html#a090147751441a97e04a4acef1d6514cb" title="Return the latest raw timing data structure.">pa_stream_get_timing_info()</a>. The total output latency a sample that is written with <a class="el" href="stream_8h.html#a4fc69dec0cc202fcc174125dc88dada7" title="Write some data to the server (for playback streams).">pa_stream_write()</a> takes to be played may be estimated by sink_usec+buffer_usec+transport_usec. (where buffer_usec is defined as pa_bytes_to_usec(write_index-read_index)) The output buffer which buffer_usec relates to may be manipulated freely (with <a class="el" href="stream_8h.html#a4fc69dec0cc202fcc174125dc88dada7" title="Write some data to the server (for playback streams).">pa_stream_write()</a>'s seek argument, <a class="el" href="stream_8h.html#ac9c524eb275d258b00c553409682409c" title="Flush the playback buffer of this stream.">pa_stream_flush()</a> and friends), the buffers sink_usec and source_usec relate to are first-in first-out (FIFO) buffers which cannot be flushed or manipulated in any way. The total input latency a sample that is recorded takes to be delivered to the application is: source_usec+buffer_usec+transport_usec-sink_usec. (Take care of sign issues!) When connected to a monitor source sink_usec contains the latency of the owning sink. The two latency estimations described here are implemented in <a class="el" href="stream_8h.html#aa521efcc16fe2abf0f8461462432ac16" title="Determine the total stream latency.">pa_stream_get_latency()</a>. Please note that this structure can be extended as part of evolutionary API updates at any time in any new release. </p> </div><h2 class="groupheader">Field Documentation</h2> <a class="anchor" id="ab0289d7d18950165d8b81825cd03b9c8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_timing_info::configured_sink_usec</td> </tr> </table> </div><div class="memdoc"> <p>The configured latency for the sink. </p> <dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl> </div> </div> <a class="anchor" id="afa23d72067027b54b525ae547520a2df"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_timing_info::configured_source_usec</td> </tr> </table> </div><div class="memdoc"> <p>The configured latency for the source. </p> <dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl> </div> </div> <a class="anchor" id="aa2b512f984e3d24e20159f542e80549a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_timing_info::playing</td> </tr> </table> </div><div class="memdoc"> <p>Non-zero when the stream is currently not underrun and data is being passed on to the device. </p> <p>Only for playback streams. This field does not say whether the data is actually already being played. To determine this check whether since_underrun (converted to usec) is larger than sink_usec. </p> </div> </div> <a class="anchor" id="a5e04baf968cc1d53a7795a58b2e4f788"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t pa_timing_info::read_index</td> </tr> </table> </div><div class="memdoc"> <p>Current read index into the playback buffer in bytes. </p> <p>Think twice before using this for seeking purposes: it might be out of date a the time you want to use it. Consider using PA_SEEK_RELATIVE_ON_READ instead. </p> </div> </div> <a class="anchor" id="ab675235e605a24a7be4486beaf0c65d9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_timing_info::read_index_corrupt</td> </tr> </table> </div><div class="memdoc"> <p>Non-zero if read_index is not up-to-date because a local pause or flush request that corrupted it has been issued in the time since this latency info was current. </p> </div> </div> <a class="anchor" id="ad2f26c8efa733d738dade0ed1b8123d3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t pa_timing_info::since_underrun</td> </tr> </table> </div><div class="memdoc"> <p>Bytes that were handed to the sink since the last underrun happened, or since playback started again after the last underrun. </p> <p>playing will tell you which case it is.</p> <dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl> </div> </div> <a class="anchor" id="a1fa047dbabfc097c05ebc74f66a234c8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_timing_info::sink_usec</td> </tr> </table> </div><div class="memdoc"> <p>Time in usecs a sample takes to be played on the sink. </p> <p>For playback streams and record streams connected to a monitor source. </p> </div> </div> <a class="anchor" id="ad34351f6a2480aa73a1afa9f9596768c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_timing_info::source_usec</td> </tr> </table> </div><div class="memdoc"> <p>Time in usecs a sample takes from being recorded to being delivered to the application. </p> <p>Only for record streams. </p> </div> </div> <a class="anchor" id="ab1b6c3d12cca0172e5d10374cb2f322c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_timing_info::synchronized_clocks</td> </tr> </table> </div><div class="memdoc"> <p>Non-zero if the local and the remote machine have synchronized clocks. </p> <p>If synchronized clocks are detected transport_usec becomes much more reliable. However, the code that detects synchronized clocks is very limited and unreliable itself. </p> </div> </div> <a class="anchor" id="a1d7bfa57c2980cb34fd535ba700057ff"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct timeval pa_timing_info::timestamp</td> </tr> </table> </div><div class="memdoc"> <p>The time when this timing info structure was current. </p> </div> </div> <a class="anchor" id="ac77f5e79645fd59640138d86e610d773"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_timing_info::transport_usec</td> </tr> </table> </div><div class="memdoc"> <p>Estimated time in usecs a sample takes to be transferred to/from the daemon. </p> <p>For both playback and record streams. </p> </div> </div> <a class="anchor" id="a378893046ab19c58fdb50633c66c5d4a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int64_t pa_timing_info::write_index</td> </tr> </table> </div><div class="memdoc"> <p>Current write index into the playback buffer in bytes. </p> <p>Think twice before using this for seeking purposes: it might be out of date a the time you want to use it. Consider using PA_SEEK_RELATIVE instead. </p> </div> </div> <a class="anchor" id="a28e63adc8b284fb2d2e90e302ba1e6e4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_timing_info::write_index_corrupt</td> </tr> </table> </div><div class="memdoc"> <p>Non-zero if write_index is not up-to-date because a local write command that corrupted it has been issued in the time since this latency info was current . </p> <p>Only write commands with SEEK_RELATIVE_ON_READ and SEEK_RELATIVE_END can corrupt write_index. </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="def_8h_source.html">def.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="structpa__timing__info.html">pa_timing_info</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>