structpw__time.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

<!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.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PipeWire: pw_time 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</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">PipeWire
   &#160;<span id="projectnumber">0.2.9</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structpw__time.html','');});
/* @license-end */
</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">pw_time Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A time structure.  
 <a href="structpw__time.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:ad817da21bea1591d70f837c251a73468"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html#ad817da21bea1591d70f837c251a73468">now</a></td></tr>
<tr class="memdesc:ad817da21bea1591d70f837c251a73468"><td class="mdescLeft">&#160;</td><td class="mdescRight">the monotonic time  <a href="#ad817da21bea1591d70f837c251a73468">More...</a><br /></td></tr>
<tr class="separator:ad817da21bea1591d70f837c251a73468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41d793c390eefc6aee165e16e0d7c898"><td class="memItemLeft" align="right" valign="top">struct spa_fraction&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html#a41d793c390eefc6aee165e16e0d7c898">rate</a></td></tr>
<tr class="memdesc:a41d793c390eefc6aee165e16e0d7c898"><td class="mdescLeft">&#160;</td><td class="mdescRight">the rate of <em>ticks</em> and delay  <a href="#a41d793c390eefc6aee165e16e0d7c898">More...</a><br /></td></tr>
<tr class="separator:a41d793c390eefc6aee165e16e0d7c898"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e3d7963e24fbf410afa03c73465328"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html#a99e3d7963e24fbf410afa03c73465328">ticks</a></td></tr>
<tr class="memdesc:a99e3d7963e24fbf410afa03c73465328"><td class="mdescLeft">&#160;</td><td class="mdescRight">the ticks at <em>now</em>.  <a href="#a99e3d7963e24fbf410afa03c73465328">More...</a><br /></td></tr>
<tr class="separator:a99e3d7963e24fbf410afa03c73465328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ea3fa77ce4221df0d5ac3ad8fd1f6c7"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html#a1ea3fa77ce4221df0d5ac3ad8fd1f6c7">delay</a></td></tr>
<tr class="memdesc:a1ea3fa77ce4221df0d5ac3ad8fd1f6c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">delay to device, add to ticks to get the time of the device.  <a href="#a1ea3fa77ce4221df0d5ac3ad8fd1f6c7">More...</a><br /></td></tr>
<tr class="separator:a1ea3fa77ce4221df0d5ac3ad8fd1f6c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91dafbb38397328f8705e2bb20b7625a"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html#a91dafbb38397328f8705e2bb20b7625a">queued</a></td></tr>
<tr class="memdesc:a91dafbb38397328f8705e2bb20b7625a"><td class="mdescLeft">&#160;</td><td class="mdescRight">data queued in the stream, this is the sum of the size fields in the <a class="el" href="structpw__buffer.html">pw_buffer</a> that are currently queued  <a href="#a91dafbb38397328f8705e2bb20b7625a">More...</a><br /></td></tr>
<tr class="separator:a91dafbb38397328f8705e2bb20b7625a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A time structure. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a1ea3fa77ce4221df0d5ac3ad8fd1f6c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ea3fa77ce4221df0d5ac3ad8fd1f6c7">&#9670;&nbsp;</a></span>delay</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int64_t pw_time::delay</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>delay to device, add to ticks to get the time of the device. </p>
<p>Positive for INPUT streams and negative for OUTPUT streams. </p>

<p class="reference">Referenced by <a class="el" href="stream_8c.html#ae8a3753316267cd885e875ae7fbd3c91">pw_stream_get_time()</a>.</p>

</div>
</div>
<a id="ad817da21bea1591d70f837c251a73468"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad817da21bea1591d70f837c251a73468">&#9670;&nbsp;</a></span>now</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int64_t pw_time::now</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the monotonic time </p>

<p class="reference">Referenced by <a class="el" href="stream_8c.html#ae8a3753316267cd885e875ae7fbd3c91">pw_stream_get_time()</a>.</p>

</div>
</div>
<a id="a91dafbb38397328f8705e2bb20b7625a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91dafbb38397328f8705e2bb20b7625a">&#9670;&nbsp;</a></span>queued</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t pw_time::queued</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>data queued in the stream, this is the sum of the size fields in the <a class="el" href="structpw__buffer.html">pw_buffer</a> that are currently queued </p>

<p class="reference">Referenced by <a class="el" href="stream_8c.html#ae8a3753316267cd885e875ae7fbd3c91">pw_stream_get_time()</a>.</p>

</div>
</div>
<a id="a41d793c390eefc6aee165e16e0d7c898"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41d793c390eefc6aee165e16e0d7c898">&#9670;&nbsp;</a></span>rate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct spa_fraction pw_time::rate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the rate of <em>ticks</em> and delay </p>

<p class="reference">Referenced by <a class="el" href="stream_8c.html#ae8a3753316267cd885e875ae7fbd3c91">pw_stream_get_time()</a>.</p>

</div>
</div>
<a id="a99e3d7963e24fbf410afa03c73465328"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e3d7963e24fbf410afa03c73465328">&#9670;&nbsp;</a></span>ticks</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t pw_time::ticks</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the ticks at <em>now</em>. </p>
<p>This is the current time that the remote end is reading/writing. </p>

<p class="reference">Referenced by <a class="el" href="stream_8c.html#ae8a3753316267cd885e875ae7fbd3c91">pw_stream_get_time()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="stream_8h_source.html">stream.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="structpw__time.html">pw_time</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.15 </li>
  </ul>
</div>
</body>
</html>