comparison code-docs/structVamp_1_1RealTime.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: Vamp::RealTime Class Reference</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
49 <li><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 </div>
65 </div>
66 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle">
68 </div>
69 </div>
70 <script type="text/javascript">
71 initNavTree('structVamp_1_1RealTime.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-methods">Public Member Functions</a> &#124;
77 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
78 <a href="#pub-attribs">Public Attributes</a> &#124;
79 <a href="#pub-static-attribs">Static Public Attributes</a> </div>
80 <div class="headertitle">
81 <div class="title">Vamp::RealTime Class Reference</div> </div>
82 </div>
83 <div class="contents">
84 <!-- doxytag: class="Vamp::RealTime" -->
85 <p><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions.
86 <a href="structVamp_1_1RealTime.html#details">More...</a></p>
87
88 <p><code>#include &lt;<a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>&gt;</code></p>
89
90 <p><a href="classVamp_1_1RealTime-members.html">List of all members.</a></p>
91 <table class="memberdecls">
92 <tr><td colspan="2"><h2><a name="pub-methods"></a>
93 Public Member Functions</h2></td></tr>
94 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#aace9e2c60af62273e45ccd98d623914c">usec</a> () const </td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a76e22815db51ae180c38021110da9947">msec</a> () const </td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad703be11b7beb07af08ddf133aa2ae79">RealTime</a> ()</td></tr>
97 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a75b2f0af2f9c49e649f8d30b452b049d">RealTime</a> (int s, int n)</td></tr>
98 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a8f4dbd8ef24a0ec6a77dce67fff5434e">RealTime</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r)</td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#adb82f838804a9a3ad49988de5944d090">operator=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r)</td></tr>
100 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a6b74748d1eb4c3c751e7a12aefae0bde">operator+</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#af0360b5b0d23a464025a6823912c6291">operator-</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
102 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#af62915355c482f2e1611a52a7f17f5ed">operator-</a> () const </td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a78e378a5dd0137a6514dca18edda6f9a">operator&lt;</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
104 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a6f0aced679e2f97133ed63c688b335e4">operator&gt;</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#abc5f06b5b9973012cb7453192df3ea5e">operator==</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ae9b0ea7c217163d5327b1a2a0662a90b">operator!=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
107 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a5cb785a410e3a91ed3092b7bba22afc3">operator&gt;=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
108 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#acf4278eec678c558d62bbda6bc1da44e">operator&lt;=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ac88cda961da5cb728d823b29c5456c06">operator/</a> (int d) const </td></tr>
110 <tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#aa6e50a94c81a1448ec1d61421ccf6e3f">operator/</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r) const </td></tr>
111 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the ratio of two times. <a href="#aa6e50a94c81a1448ec1d61421ccf6e3f"></a><br/></td></tr>
112 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad44476618183bd736996a87292d03c07">toString</a> () const </td></tr>
113 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a human-readable debug-type string to full precision (probably not a format to show to a user directly) <a href="#ad44476618183bd736996a87292d03c07"></a><br/></td></tr>
114 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad75b927afadfa422ae512d169ccda0aa">toText</a> (bool fixedDp=false) const </td></tr>
115 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm. <a href="#ad75b927afadfa422ae512d169ccda0aa"></a><br/></td></tr>
116 <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
117 Static Public Member Functions</h2></td></tr>
118 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ae29ae57d19c66f256839988a0959c6bb">fromSeconds</a> (double <a class="el" href="structVamp_1_1RealTime.html#ab4d81983384a9f57ce064e6c343f2267">sec</a>)</td></tr>
119 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a6992d9959fc4f19c11a98f17506f4905">fromMilliseconds</a> (int msec)</td></tr>
120 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a7f1e1e35ca5196283b2086e3d9cd9d3b">fromTimeval</a> (const struct timeval &amp;)</td></tr>
121 <tr><td class="memItemLeft" align="right" valign="top">static long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ac046c73d88da6715e55b12e10534bb5c">realTime2Frame</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;r, unsigned int sampleRate)</td></tr>
122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a <a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> into a sample frame at the given sample rate. <a href="#ac046c73d88da6715e55b12e10534bb5c"></a><br/></td></tr>
123 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">frame2RealTime</a> (long frame, unsigned int sampleRate)</td></tr>
124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a sample frame at the given sample rate into a <a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a>. <a href="#a939b4b1d1ca190db69a418883f16ce8a"></a><br/></td></tr>
125 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
126 Public Attributes</h2></td></tr>
127 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ab4d81983384a9f57ce064e6c343f2267">sec</a></td></tr>
128 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a2078835bef7bb92514a65b6051cfc6c8">nsec</a></td></tr>
129 <tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
130 Static Public Attributes</h2></td></tr>
131 <tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#abe453371597710148b0fd19bb452f8a9">zeroTime</a></td></tr>
132 </table>
133 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
134 <div class="textblock"><p><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions. </p>
135
136 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00066">66</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
137 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
138 <a class="anchor" id="ad703be11b7beb07af08ddf133aa2ae79"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="ad703be11b7beb07af08ddf133aa2ae79" args="()" -->
139 <div class="memitem">
140 <div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname">Vamp::RealTime::RealTime </td>
144 <td>(</td>
145 <td class="paramname"></td><td>)</td>
146 <td><code> [inline]</code></td>
147 </tr>
148 </table>
149 </div>
150 <div class="memdoc">
151
152 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00074">74</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
153
154 </div>
155 </div>
156 <a class="anchor" id="a75b2f0af2f9c49e649f8d30b452b049d"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="a75b2f0af2f9c49e649f8d30b452b049d" args="(int s, int n)" -->
157 <div class="memitem">
158 <div class="memproto">
159 <table class="memname">
160 <tr>
161 <td class="memname">Vamp::RealTime::RealTime </td>
162 <td>(</td>
163 <td class="paramtype">int&#160;</td>
164 <td class="paramname"><em>s</em>, </td>
165 </tr>
166 <tr>
167 <td class="paramkey"></td>
168 <td></td>
169 <td class="paramtype">int&#160;</td>
170 <td class="paramname"><em>n</em>&#160;</td>
171 </tr>
172 <tr>
173 <td></td>
174 <td>)</td>
175 <td></td><td></td>
176 </tr>
177 </table>
178 </div>
179 <div class="memdoc">
180
181 </div>
182 </div>
183 <a class="anchor" id="a8f4dbd8ef24a0ec6a77dce67fff5434e"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="a8f4dbd8ef24a0ec6a77dce67fff5434e" args="(const RealTime &amp;r)" -->
184 <div class="memitem">
185 <div class="memproto">
186 <table class="memname">
187 <tr>
188 <td class="memname">Vamp::RealTime::RealTime </td>
189 <td>(</td>
190 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
191 <td class="paramname"><em>r</em></td><td>)</td>
192 <td><code> [inline]</code></td>
193 </tr>
194 </table>
195 </div>
196 <div class="memdoc">
197
198 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00077">77</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
199
200 </div>
201 </div>
202 <hr/><h2>Member Function Documentation</h2>
203 <a class="anchor" id="aace9e2c60af62273e45ccd98d623914c"></a><!-- doxytag: member="Vamp::RealTime::usec" ref="aace9e2c60af62273e45ccd98d623914c" args="() const " -->
204 <div class="memitem">
205 <div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">int Vamp::RealTime::usec </td>
209 <td>(</td>
210 <td class="paramname"></td><td>)</td>
211 <td> const<code> [inline]</code></td>
212 </tr>
213 </table>
214 </div>
215 <div class="memdoc">
216
217 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00071">71</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
218
219 </div>
220 </div>
221 <a class="anchor" id="a76e22815db51ae180c38021110da9947"></a><!-- doxytag: member="Vamp::RealTime::msec" ref="a76e22815db51ae180c38021110da9947" args="() const " -->
222 <div class="memitem">
223 <div class="memproto">
224 <table class="memname">
225 <tr>
226 <td class="memname">int Vamp::RealTime::msec </td>
227 <td>(</td>
228 <td class="paramname"></td><td>)</td>
229 <td> const<code> [inline]</code></td>
230 </tr>
231 </table>
232 </div>
233 <div class="memdoc">
234
235 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
236
237 </div>
238 </div>
239 <a class="anchor" id="ae29ae57d19c66f256839988a0959c6bb"></a><!-- doxytag: member="Vamp::RealTime::fromSeconds" ref="ae29ae57d19c66f256839988a0959c6bb" args="(double sec)" -->
240 <div class="memitem">
241 <div class="memproto">
242 <table class="memname">
243 <tr>
244 <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromSeconds </td>
245 <td>(</td>
246 <td class="paramtype">double&#160;</td>
247 <td class="paramname"><em>sec</em></td><td>)</td>
248 <td><code> [static]</code></td>
249 </tr>
250 </table>
251 </div>
252 <div class="memdoc">
253
254 </div>
255 </div>
256 <a class="anchor" id="a6992d9959fc4f19c11a98f17506f4905"></a><!-- doxytag: member="Vamp::RealTime::fromMilliseconds" ref="a6992d9959fc4f19c11a98f17506f4905" args="(int msec)" -->
257 <div class="memitem">
258 <div class="memproto">
259 <table class="memname">
260 <tr>
261 <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromMilliseconds </td>
262 <td>(</td>
263 <td class="paramtype">int&#160;</td>
264 <td class="paramname"><em>msec</em></td><td>)</td>
265 <td><code> [static]</code></td>
266 </tr>
267 </table>
268 </div>
269 <div class="memdoc">
270
271 </div>
272 </div>
273 <a class="anchor" id="a7f1e1e35ca5196283b2086e3d9cd9d3b"></a><!-- doxytag: member="Vamp::RealTime::fromTimeval" ref="a7f1e1e35ca5196283b2086e3d9cd9d3b" args="(const struct timeval &amp;)" -->
274 <div class="memitem">
275 <div class="memproto">
276 <table class="memname">
277 <tr>
278 <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromTimeval </td>
279 <td>(</td>
280 <td class="paramtype">const struct timeval &amp;&#160;</td>
281 <td class="paramname"></td><td>)</td>
282 <td><code> [static]</code></td>
283 </tr>
284 </table>
285 </div>
286 <div class="memdoc">
287
288 </div>
289 </div>
290 <a class="anchor" id="adb82f838804a9a3ad49988de5944d090"></a><!-- doxytag: member="Vamp::RealTime::operator=" ref="adb82f838804a9a3ad49988de5944d090" args="(const RealTime &amp;r)" -->
291 <div class="memitem">
292 <div class="memproto">
293 <table class="memname">
294 <tr>
295 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&amp; Vamp::RealTime::operator= </td>
296 <td>(</td>
297 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
298 <td class="paramname"><em>r</em></td><td>)</td>
299 <td><code> [inline]</code></td>
300 </tr>
301 </table>
302 </div>
303 <div class="memdoc">
304
305 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00087">87</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
306
307 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
308
309 </div>
310 </div>
311 <a class="anchor" id="a6b74748d1eb4c3c751e7a12aefae0bde"></a><!-- doxytag: member="Vamp::RealTime::operator+" ref="a6b74748d1eb4c3c751e7a12aefae0bde" args="(const RealTime &amp;r) const " -->
312 <div class="memitem">
313 <div class="memproto">
314 <table class="memname">
315 <tr>
316 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator+ </td>
317 <td>(</td>
318 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
319 <td class="paramname"><em>r</em></td><td>)</td>
320 <td> const<code> [inline]</code></td>
321 </tr>
322 </table>
323 </div>
324 <div class="memdoc">
325
326 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00091">91</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
327
328 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
329
330 </div>
331 </div>
332 <a class="anchor" id="af0360b5b0d23a464025a6823912c6291"></a><!-- doxytag: member="Vamp::RealTime::operator&#45;" ref="af0360b5b0d23a464025a6823912c6291" args="(const RealTime &amp;r) const " -->
333 <div class="memitem">
334 <div class="memproto">
335 <table class="memname">
336 <tr>
337 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator- </td>
338 <td>(</td>
339 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
340 <td class="paramname"><em>r</em></td><td>)</td>
341 <td> const<code> [inline]</code></td>
342 </tr>
343 </table>
344 </div>
345 <div class="memdoc">
346
347 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00094">94</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
348
349 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
350
351 </div>
352 </div>
353 <a class="anchor" id="af62915355c482f2e1611a52a7f17f5ed"></a><!-- doxytag: member="Vamp::RealTime::operator&#45;" ref="af62915355c482f2e1611a52a7f17f5ed" args="() const " -->
354 <div class="memitem">
355 <div class="memproto">
356 <table class="memname">
357 <tr>
358 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator- </td>
359 <td>(</td>
360 <td class="paramname"></td><td>)</td>
361 <td> const<code> [inline]</code></td>
362 </tr>
363 </table>
364 </div>
365 <div class="memdoc">
366
367 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00097">97</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
368
369 </div>
370 </div>
371 <a class="anchor" id="a78e378a5dd0137a6514dca18edda6f9a"></a><!-- doxytag: member="Vamp::RealTime::operator&lt;" ref="a78e378a5dd0137a6514dca18edda6f9a" args="(const RealTime &amp;r) const " -->
372 <div class="memitem">
373 <div class="memproto">
374 <table class="memname">
375 <tr>
376 <td class="memname">bool Vamp::RealTime::operator&lt; </td>
377 <td>(</td>
378 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
379 <td class="paramname"><em>r</em></td><td>)</td>
380 <td> const<code> [inline]</code></td>
381 </tr>
382 </table>
383 </div>
384 <div class="memdoc">
385
386 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00101">101</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
387
388 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
389
390 </div>
391 </div>
392 <a class="anchor" id="a6f0aced679e2f97133ed63c688b335e4"></a><!-- doxytag: member="Vamp::RealTime::operator&gt;" ref="a6f0aced679e2f97133ed63c688b335e4" args="(const RealTime &amp;r) const " -->
393 <div class="memitem">
394 <div class="memproto">
395 <table class="memname">
396 <tr>
397 <td class="memname">bool Vamp::RealTime::operator&gt; </td>
398 <td>(</td>
399 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
400 <td class="paramname"><em>r</em></td><td>)</td>
401 <td> const<code> [inline]</code></td>
402 </tr>
403 </table>
404 </div>
405 <div class="memdoc">
406
407 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00106">106</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
408
409 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
410
411 </div>
412 </div>
413 <a class="anchor" id="abc5f06b5b9973012cb7453192df3ea5e"></a><!-- doxytag: member="Vamp::RealTime::operator==" ref="abc5f06b5b9973012cb7453192df3ea5e" args="(const RealTime &amp;r) const " -->
414 <div class="memitem">
415 <div class="memproto">
416 <table class="memname">
417 <tr>
418 <td class="memname">bool Vamp::RealTime::operator== </td>
419 <td>(</td>
420 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
421 <td class="paramname"><em>r</em></td><td>)</td>
422 <td> const<code> [inline]</code></td>
423 </tr>
424 </table>
425 </div>
426 <div class="memdoc">
427
428 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00111">111</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
429
430 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
431
432 </div>
433 </div>
434 <a class="anchor" id="ae9b0ea7c217163d5327b1a2a0662a90b"></a><!-- doxytag: member="Vamp::RealTime::operator!=" ref="ae9b0ea7c217163d5327b1a2a0662a90b" args="(const RealTime &amp;r) const " -->
435 <div class="memitem">
436 <div class="memproto">
437 <table class="memname">
438 <tr>
439 <td class="memname">bool Vamp::RealTime::operator!= </td>
440 <td>(</td>
441 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
442 <td class="paramname"><em>r</em></td><td>)</td>
443 <td> const<code> [inline]</code></td>
444 </tr>
445 </table>
446 </div>
447 <div class="memdoc">
448
449 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00115">115</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
450
451 </div>
452 </div>
453 <a class="anchor" id="a5cb785a410e3a91ed3092b7bba22afc3"></a><!-- doxytag: member="Vamp::RealTime::operator&gt;=" ref="a5cb785a410e3a91ed3092b7bba22afc3" args="(const RealTime &amp;r) const " -->
454 <div class="memitem">
455 <div class="memproto">
456 <table class="memname">
457 <tr>
458 <td class="memname">bool Vamp::RealTime::operator&gt;= </td>
459 <td>(</td>
460 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
461 <td class="paramname"><em>r</em></td><td>)</td>
462 <td> const<code> [inline]</code></td>
463 </tr>
464 </table>
465 </div>
466 <div class="memdoc">
467
468 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00119">119</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
469
470 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
471
472 </div>
473 </div>
474 <a class="anchor" id="acf4278eec678c558d62bbda6bc1da44e"></a><!-- doxytag: member="Vamp::RealTime::operator&lt;=" ref="acf4278eec678c558d62bbda6bc1da44e" args="(const RealTime &amp;r) const " -->
475 <div class="memitem">
476 <div class="memproto">
477 <table class="memname">
478 <tr>
479 <td class="memname">bool Vamp::RealTime::operator&lt;= </td>
480 <td>(</td>
481 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
482 <td class="paramname"><em>r</em></td><td>)</td>
483 <td> const<code> [inline]</code></td>
484 </tr>
485 </table>
486 </div>
487 <div class="memdoc">
488
489 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00124">124</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
490
491 <p>References <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">nsec</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">sec</a>.</p>
492
493 </div>
494 </div>
495 <a class="anchor" id="ac88cda961da5cb728d823b29c5456c06"></a><!-- doxytag: member="Vamp::RealTime::operator/" ref="ac88cda961da5cb728d823b29c5456c06" args="(int d) const " -->
496 <div class="memitem">
497 <div class="memproto">
498 <table class="memname">
499 <tr>
500 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator/ </td>
501 <td>(</td>
502 <td class="paramtype">int&#160;</td>
503 <td class="paramname"><em>d</em></td><td>)</td>
504 <td> const</td>
505 </tr>
506 </table>
507 </div>
508 <div class="memdoc">
509
510 </div>
511 </div>
512 <a class="anchor" id="aa6e50a94c81a1448ec1d61421ccf6e3f"></a><!-- doxytag: member="Vamp::RealTime::operator/" ref="aa6e50a94c81a1448ec1d61421ccf6e3f" args="(const RealTime &amp;r) const " -->
513 <div class="memitem">
514 <div class="memproto">
515 <table class="memname">
516 <tr>
517 <td class="memname">double Vamp::RealTime::operator/ </td>
518 <td>(</td>
519 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
520 <td class="paramname"><em>r</em></td><td>)</td>
521 <td> const</td>
522 </tr>
523 </table>
524 </div>
525 <div class="memdoc">
526
527 <p>Return the ratio of two times. </p>
528
529 </div>
530 </div>
531 <a class="anchor" id="ad44476618183bd736996a87292d03c07"></a><!-- doxytag: member="Vamp::RealTime::toString" ref="ad44476618183bd736996a87292d03c07" args="() const " -->
532 <div class="memitem">
533 <div class="memproto">
534 <table class="memname">
535 <tr>
536 <td class="memname">std::string Vamp::RealTime::toString </td>
537 <td>(</td>
538 <td class="paramname"></td><td>)</td>
539 <td> const</td>
540 </tr>
541 </table>
542 </div>
543 <div class="memdoc">
544
545 <p>Return a human-readable debug-type string to full precision (probably not a format to show to a user directly) </p>
546
547 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00495">printFeatures()</a>.</p>
548
549 </div>
550 </div>
551 <a class="anchor" id="ad75b927afadfa422ae512d169ccda0aa"></a><!-- doxytag: member="Vamp::RealTime::toText" ref="ad75b927afadfa422ae512d169ccda0aa" args="(bool fixedDp=false) const " -->
552 <div class="memitem">
553 <div class="memproto">
554 <table class="memname">
555 <tr>
556 <td class="memname">std::string Vamp::RealTime::toText </td>
557 <td>(</td>
558 <td class="paramtype">bool&#160;</td>
559 <td class="paramname"><em>fixedDp</em> = <code>false</code></td><td>)</td>
560 <td> const</td>
561 </tr>
562 </table>
563 </div>
564 <div class="memdoc">
565
566 <p>Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm. </p>
567
568 </div>
569 </div>
570 <a class="anchor" id="ac046c73d88da6715e55b12e10534bb5c"></a><!-- doxytag: member="Vamp::RealTime::realTime2Frame" ref="ac046c73d88da6715e55b12e10534bb5c" args="(const RealTime &amp;r, unsigned int sampleRate)" -->
571 <div class="memitem">
572 <div class="memproto">
573 <table class="memname">
574 <tr>
575 <td class="memname">static long Vamp::RealTime::realTime2Frame </td>
576 <td>(</td>
577 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
578 <td class="paramname"><em>r</em>, </td>
579 </tr>
580 <tr>
581 <td class="paramkey"></td>
582 <td></td>
583 <td class="paramtype">unsigned int&#160;</td>
584 <td class="paramname"><em>sampleRate</em>&#160;</td>
585 </tr>
586 <tr>
587 <td></td>
588 <td>)</td>
589 <td></td><td><code> [static]</code></td>
590 </tr>
591 </table>
592 </div>
593 <div class="memdoc">
594
595 <p>Convert a <a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> into a sample frame at the given sample rate. </p>
596
597 </div>
598 </div>
599 <a class="anchor" id="a939b4b1d1ca190db69a418883f16ce8a"></a><!-- doxytag: member="Vamp::RealTime::frame2RealTime" ref="a939b4b1d1ca190db69a418883f16ce8a" args="(long frame, unsigned int sampleRate)" -->
600 <div class="memitem">
601 <div class="memproto">
602 <table class="memname">
603 <tr>
604 <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::frame2RealTime </td>
605 <td>(</td>
606 <td class="paramtype">long&#160;</td>
607 <td class="paramname"><em>frame</em>, </td>
608 </tr>
609 <tr>
610 <td class="paramkey"></td>
611 <td></td>
612 <td class="paramtype">unsigned int&#160;</td>
613 <td class="paramname"><em>sampleRate</em>&#160;</td>
614 </tr>
615 <tr>
616 <td></td>
617 <td>)</td>
618 <td></td><td><code> [static]</code></td>
619 </tr>
620 </table>
621 </div>
622 <div class="memdoc">
623
624 <p>Convert a sample frame at the given sample rate into a <a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a>. </p>
625
626 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
627
628 </div>
629 </div>
630 <hr/><h2>Member Data Documentation</h2>
631 <a class="anchor" id="ab4d81983384a9f57ce064e6c343f2267"></a><!-- doxytag: member="Vamp::RealTime::sec" ref="ab4d81983384a9f57ce064e6c343f2267" args="" -->
632 <div class="memitem">
633 <div class="memproto">
634 <table class="memname">
635 <tr>
636 <td class="memname">int <a class="el" href="structVamp_1_1RealTime.html#ab4d81983384a9f57ce064e6c343f2267">Vamp::RealTime::sec</a></td>
637 </tr>
638 </table>
639 </div>
640 <div class="memdoc">
641
642 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
643
644 <p>Referenced by <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00091">operator+()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00094">operator-()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00101">operator&lt;()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00124">operator&lt;=()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00087">operator=()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00111">operator==()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00106">operator&gt;()</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00119">operator&gt;=()</a>.</p>
645
646 </div>
647 </div>
648 <a class="anchor" id="a2078835bef7bb92514a65b6051cfc6c8"></a><!-- doxytag: member="Vamp::RealTime::nsec" ref="a2078835bef7bb92514a65b6051cfc6c8" args="" -->
649 <div class="memitem">
650 <div class="memproto">
651 <table class="memname">
652 <tr>
653 <td class="memname">int <a class="el" href="structVamp_1_1RealTime.html#a2078835bef7bb92514a65b6051cfc6c8">Vamp::RealTime::nsec</a></td>
654 </tr>
655 </table>
656 </div>
657 <div class="memdoc">
658
659 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00069">69</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
660
661 <p>Referenced by <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00091">operator+()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00094">operator-()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00101">operator&lt;()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00124">operator&lt;=()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00087">operator=()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00111">operator==()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00106">operator&gt;()</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00119">operator&gt;=()</a>.</p>
662
663 </div>
664 </div>
665 <a class="anchor" id="abe453371597710148b0fd19bb452f8a9"></a><!-- doxytag: member="Vamp::RealTime::zeroTime" ref="abe453371597710148b0fd19bb452f8a9" args="" -->
666 <div class="memitem">
667 <div class="memproto">
668 <table class="memname">
669 <tr>
670 <td class="memname">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1RealTime.html#abe453371597710148b0fd19bb452f8a9">Vamp::RealTime::zeroTime</a><code> [static]</code></td>
671 </tr>
672 </table>
673 </div>
674 <div class="memdoc">
675
676 <p>Definition at line <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>.</p>
677
678 </div>
679 </div>
680 <hr/>The documentation for this class was generated from the following file:<ul>
681 <li><a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a></li>
682 </ul>
683 </div>
684 </div>
685 <div id="nav-path" class="navpath">
686 <ul>
687 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
688 <li class="navelem"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </li>
689
690 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
691 <a href="http://www.doxygen.org/index.html">
692 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
693 </ul>
694 </div>
695
696
697 </body>
698 </html>