Mercurial > hg > vamp-docs
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/structVamp_1_1RealTime.html Tue Oct 04 14:56:07 2011 +0100 @@ -0,0 +1,698 @@ +<!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>VampPluginSDK: Vamp::RealTime Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> + + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">VampPluginSDK +  <span id="projectnumber">2.1</span> + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li><a href="dirs.html"><span>Directories</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> + initNavTree('structVamp_1_1RealTime.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> </div> + <div class="headertitle"> +<div class="title">Vamp::RealTime Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="Vamp::RealTime" --> +<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. + <a href="structVamp_1_1RealTime.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a>></code></p> + +<p><a href="classVamp_1_1RealTime-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#aace9e2c60af62273e45ccd98d623914c">usec</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a76e22815db51ae180c38021110da9947">msec</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad703be11b7beb07af08ddf133aa2ae79">RealTime</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a75b2f0af2f9c49e649f8d30b452b049d">RealTime</a> (int s, int n)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </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> &r)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </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> &r)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </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> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </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> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#af62915355c482f2e1611a52a7f17f5ed">operator-</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a78e378a5dd0137a6514dca18edda6f9a">operator<</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a6f0aced679e2f97133ed63c688b335e4">operator></a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </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> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </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> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a5cb785a410e3a91ed3092b7bba22afc3">operator>=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#acf4278eec678c558d62bbda6bc1da44e">operator<=</a> (const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &r) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ac88cda961da5cb728d823b29c5456c06">operator/</a> (int d) const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">double </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> &r) const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ratio of two times. <a href="#aa6e50a94c81a1448ec1d61421ccf6e3f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad44476618183bd736996a87292d03c07">toString</a> () const </td></tr> +<tr><td class="mdescLeft"> </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> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ad75b927afadfa422ae512d169ccda0aa">toText</a> (bool fixedDp=false) const </td></tr> +<tr><td class="mdescLeft"> </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> +<tr><td colspan="2"><h2><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </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> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a6992d9959fc4f19c11a98f17506f4905">fromMilliseconds</a> (int msec)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a7f1e1e35ca5196283b2086e3d9cd9d3b">fromTimeval</a> (const struct timeval &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static long </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> &r, unsigned int sampleRate)</td></tr> +<tr><td class="mdescLeft"> </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> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">frame2RealTime</a> (long frame, unsigned int sampleRate)</td></tr> +<tr><td class="mdescLeft"> </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> +<tr><td colspan="2"><h2><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#ab4d81983384a9f57ce064e6c343f2267">sec</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#a2078835bef7bb92514a65b6051cfc6c8">nsec</a></td></tr> +<tr><td colspan="2"><h2><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html#abe453371597710148b0fd19bb452f8a9">zeroTime</a></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<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> + +<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> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ad703be11b7beb07af08ddf133aa2ae79"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="ad703be11b7beb07af08ddf133aa2ae79" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Vamp::RealTime::RealTime </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="a75b2f0af2f9c49e649f8d30b452b049d"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="a75b2f0af2f9c49e649f8d30b452b049d" args="(int s, int n)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Vamp::RealTime::RealTime </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>s</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a8f4dbd8ef24a0ec6a77dce67fff5434e"></a><!-- doxytag: member="Vamp::RealTime::RealTime" ref="a8f4dbd8ef24a0ec6a77dce67fff5434e" args="(const RealTime &r)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Vamp::RealTime::RealTime </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="aace9e2c60af62273e45ccd98d623914c"></a><!-- doxytag: member="Vamp::RealTime::usec" ref="aace9e2c60af62273e45ccd98d623914c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Vamp::RealTime::usec </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="a76e22815db51ae180c38021110da9947"></a><!-- doxytag: member="Vamp::RealTime::msec" ref="a76e22815db51ae180c38021110da9947" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int Vamp::RealTime::msec </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="ae29ae57d19c66f256839988a0959c6bb"></a><!-- doxytag: member="Vamp::RealTime::fromSeconds" ref="ae29ae57d19c66f256839988a0959c6bb" args="(double sec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromSeconds </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"><em>sec</em></td><td>)</td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a6992d9959fc4f19c11a98f17506f4905"></a><!-- doxytag: member="Vamp::RealTime::fromMilliseconds" ref="a6992d9959fc4f19c11a98f17506f4905" args="(int msec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromMilliseconds </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>msec</em></td><td>)</td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a7f1e1e35ca5196283b2086e3d9cd9d3b"></a><!-- doxytag: member="Vamp::RealTime::fromTimeval" ref="a7f1e1e35ca5196283b2086e3d9cd9d3b" args="(const struct timeval &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::fromTimeval </td> + <td>(</td> + <td class="paramtype">const struct timeval & </td> + <td class="paramname"></td><td>)</td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="adb82f838804a9a3ad49988de5944d090"></a><!-- doxytag: member="Vamp::RealTime::operator=" ref="adb82f838804a9a3ad49988de5944d090" args="(const RealTime &r)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>& Vamp::RealTime::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="a6b74748d1eb4c3c751e7a12aefae0bde"></a><!-- doxytag: member="Vamp::RealTime::operator+" ref="a6b74748d1eb4c3c751e7a12aefae0bde" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator+ </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="af0360b5b0d23a464025a6823912c6291"></a><!-- doxytag: member="Vamp::RealTime::operator-" ref="af0360b5b0d23a464025a6823912c6291" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator- </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="af62915355c482f2e1611a52a7f17f5ed"></a><!-- doxytag: member="Vamp::RealTime::operator-" ref="af62915355c482f2e1611a52a7f17f5ed" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator- </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="a78e378a5dd0137a6514dca18edda6f9a"></a><!-- doxytag: member="Vamp::RealTime::operator<" ref="a78e378a5dd0137a6514dca18edda6f9a" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator< </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="a6f0aced679e2f97133ed63c688b335e4"></a><!-- doxytag: member="Vamp::RealTime::operator>" ref="a6f0aced679e2f97133ed63c688b335e4" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="abc5f06b5b9973012cb7453192df3ea5e"></a><!-- doxytag: member="Vamp::RealTime::operator==" ref="abc5f06b5b9973012cb7453192df3ea5e" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator== </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="ae9b0ea7c217163d5327b1a2a0662a90b"></a><!-- doxytag: member="Vamp::RealTime::operator!=" ref="ae9b0ea7c217163d5327b1a2a0662a90b" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator!= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="a5cb785a410e3a91ed3092b7bba22afc3"></a><!-- doxytag: member="Vamp::RealTime::operator>=" ref="a5cb785a410e3a91ed3092b7bba22afc3" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator>= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="acf4278eec678c558d62bbda6bc1da44e"></a><!-- doxytag: member="Vamp::RealTime::operator<=" ref="acf4278eec678c558d62bbda6bc1da44e" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool Vamp::RealTime::operator<= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a class="anchor" id="ac88cda961da5cb728d823b29c5456c06"></a><!-- doxytag: member="Vamp::RealTime::operator/" ref="ac88cda961da5cb728d823b29c5456c06" args="(int d) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::operator/ </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>d</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aa6e50a94c81a1448ec1d61421ccf6e3f"></a><!-- doxytag: member="Vamp::RealTime::operator/" ref="aa6e50a94c81a1448ec1d61421ccf6e3f" args="(const RealTime &r) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">double Vamp::RealTime::operator/ </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Return the ratio of two times. </p> + +</div> +</div> +<a class="anchor" id="ad44476618183bd736996a87292d03c07"></a><!-- doxytag: member="Vamp::RealTime::toString" ref="ad44476618183bd736996a87292d03c07" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string Vamp::RealTime::toString </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Return a human-readable debug-type string to full precision (probably not a format to show to a user directly) </p> + +<p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00495">printFeatures()</a>.</p> + +</div> +</div> +<a class="anchor" id="ad75b927afadfa422ae512d169ccda0aa"></a><!-- doxytag: member="Vamp::RealTime::toText" ref="ad75b927afadfa422ae512d169ccda0aa" args="(bool fixedDp=false) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string Vamp::RealTime::toText </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>fixedDp</em> = <code>false</code></td><td>)</td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Return a user-readable string to the nearest millisecond in a form like HH:MM:SS.mmm. </p> + +</div> +</div> +<a class="anchor" id="ac046c73d88da6715e55b12e10534bb5c"></a><!-- doxytag: member="Vamp::RealTime::realTime2Frame" ref="ac046c73d88da6715e55b12e10534bb5c" args="(const RealTime &r, unsigned int sampleRate)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static long Vamp::RealTime::realTime2Frame </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> & </td> + <td class="paramname"><em>r</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>sampleRate</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<a class="anchor" id="a939b4b1d1ca190db69a418883f16ce8a"></a><!-- doxytag: member="Vamp::RealTime::frame2RealTime" ref="a939b4b1d1ca190db69a418883f16ce8a" args="(long frame, unsigned int sampleRate)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::RealTime::frame2RealTime </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>frame</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>sampleRate</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="ab4d81983384a9f57ce064e6c343f2267"></a><!-- doxytag: member="Vamp::RealTime::sec" ref="ab4d81983384a9f57ce064e6c343f2267" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structVamp_1_1RealTime.html#ab4d81983384a9f57ce064e6c343f2267">Vamp::RealTime::sec</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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<()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00124">operator<=()</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>()</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00119">operator>=()</a>.</p> + +</div> +</div> +<a class="anchor" id="a2078835bef7bb92514a65b6051cfc6c8"></a><!-- doxytag: member="Vamp::RealTime::nsec" ref="a2078835bef7bb92514a65b6051cfc6c8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structVamp_1_1RealTime.html#a2078835bef7bb92514a65b6051cfc6c8">Vamp::RealTime::nsec</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +<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<()</a>, <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00124">operator<=()</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>()</a>, and <a class="el" href="vamp-sdk_2RealTime_8h_source.html#l00119">operator>=()</a>.</p> + +</div> +</div> +<a class="anchor" id="abe453371597710148b0fd19bb452f8a9"></a><!-- doxytag: member="Vamp::RealTime::zeroTime" ref="abe453371597710148b0fd19bb452f8a9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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> + </tr> + </table> +</div> +<div class="memdoc"> + +<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> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="vamp-sdk_2RealTime_8h_source.html">vamp-sdk/RealTime.h</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> + <li class="navelem"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </li> + + <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + +</body> +</html>