Mercurial > hg > vamp-website

comparison code-doc/namespaceVamp.html @ 50:8260c0f4e05b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs for 2.3
author cannam
date Tue, 04 Oct 2011 13:47:23 +0000
parents 0976232e353b
children
comparison
equal deleted inserted replaced
49:f75f330aa130 50:8260c0f4e05b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 <title>VampPluginSDK: Vamp Namespace Reference</title> 5 <title>VampPluginSDK: Vamp Namespace Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css"> 6
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
6 </head><body> 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
7 <!-- Generated by Doxygen 1.5.8 --> 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
8 <div class="navigation" id="top"> 10 <script type="text/javascript" src="jquery.js"></script>
9 <div class="tabs"> 11 <script type="text/javascript" src="resize.js"></script>
10 <ul> 12 <script type="text/javascript" src="navtree.js"></script>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 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>
12 <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> 47 <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li><a href="annotated.html"><span>Classes</span></a></li> 48 <li><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li> 49 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 50 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul> 51 </ul>
17 </div> 52 </div>
18 <div class="tabs"> 53 <div id="navrow2" class="tabs2">
19 <ul> 54 <ul class="tablist">
20 <li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li> 55 <li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
21 <li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li> 56 <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
22 </ul> 57 </ul>
23 </div> 58 </div>
24 </div> 59 </div>
60 <div id="side-nav" class="ui-resizable side-nav-resizable">
61 <div id="nav-tree">
62 <div id="nav-tree-contents">
63 </div>
64 </div>
65 <div id="splitbar" style="-moz-user-select:none;"
66 class="ui-resizable-handle">
67 </div>
68 </div>
69 <script type="text/javascript">
70 initNavTree('namespaceVamp.html','');
71 </script>
72 <div id="doc-content">
73 <div class="header">
74 <div class="summary">
75 <a href="#namespaces">Namespaces</a> &#124;
76 <a href="#nested-classes">Classes</a> &#124;
77 <a href="#func-members">Functions</a> </div>
78 <div class="headertitle">
79 <div class="title">Vamp Namespace Reference</div> </div>
80 </div>
25 <div class="contents"> 81 <div class="contents">
26 <h1>Vamp Namespace Reference</h1><table border="0" cellpadding="0" cellspacing="0"> 82 <table class="memberdecls">
27 <tr><td></td></tr> 83 <tr><td colspan="2"><h2><a name="namespaces"></a>
28 <tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> 84 Namespaces</h2></td></tr>
29 <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr> 85 <tr><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr>
30 86 <tr><td colspan="2"><h2><a name="nested-classes"></a>
31 <tr><td colspan="2"><br><h2>Classes</h2></td></tr> 87 Classes</h2></td></tr>
32 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr> 88 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr>
33 89 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#details">More...</a><br/></td></tr>
34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#_details">More...</a><br></td></tr> 90 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr>
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr> 91 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. <a href="classVamp_1_1PluginAdapterBase.html#details">More...</a><br/></td></tr>
36 92 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr>
37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. <a href="classVamp_1_1PluginAdapterBase.html#_details">More...</a><br></td></tr> 93 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation. <a href="classVamp_1_1PluginAdapter.html#details">More...</a><br/></td></tr>
38 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr> 94 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr>
39 95 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#details">More...</a><br/></td></tr>
40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation. <a href="classVamp_1_1PluginAdapter.html#_details">More...</a><br></td></tr> 96 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr>
41 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr> 97 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><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><br/></td></tr>
42 98 <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr>
43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#_details">More...</a><br></td></tr> 99 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> object. <a href="classVamp_1_1PluginHostAdapter.html#details">More...</a><br/></td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr> 100 <tr><td colspan="2"><h2><a name="func-members"></a>
45 101 Functions</h2></td></tr>
46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">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><br></td></tr> 102 <tr><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#a85842d554b6abf7bf9ff648b70f39fef">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;rt)</td></tr>
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr>
48
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> object. <a href="classVamp_1_1PluginHostAdapter.html#_details">More...</a><br></td></tr>
50 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#85842d554b6abf7bf9ff648b70f39fef">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;rt)</td></tr>
52
53 </table> 103 </table>
54 <hr><h2>Function Documentation</h2> 104 <hr/><h2>Function Documentation</h2>
55 <a class="anchor" name="85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator&lt;&lt;" ref="85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &amp;out, const RealTime &amp;rt)" --> 105 <a class="anchor" id="a85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator&lt;&lt;" ref="a85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &amp;out, const RealTime &amp;rt)" -->
56 <div class="memitem"> 106 <div class="memitem">
57 <div class="memproto"> 107 <div class="memproto">
58 <table class="memname"> 108 <table class="memname">
59 <tr> 109 <tr>
60 <td class="memname">std::ostream&amp; Vamp::operator&lt;&lt; </td> 110 <td class="memname">std::ostream&amp; Vamp::operator&lt;&lt; </td>
61 <td>(</td> 111 <td>(</td>
62 <td class="paramtype">std::ostream &amp;&nbsp;</td> 112 <td class="paramtype">std::ostream &amp;&#160;</td>
63 <td class="paramname"> <em>out</em>, </td> 113 <td class="paramname"><em>out</em>, </td>
64 </tr> 114 </tr>
65 <tr> 115 <tr>
66 <td class="paramkey"></td> 116 <td class="paramkey"></td>
67 <td></td> 117 <td></td>
68 <td class="paramtype">const RealTime &amp;&nbsp;</td> 118 <td class="paramtype">const RealTime &amp;&#160;</td>
69 <td class="paramname"> <em>rt</em></td><td>&nbsp;</td> 119 <td class="paramname"><em>rt</em>&#160;</td>
70 </tr> 120 </tr>
71 <tr> 121 <tr>
72 <td></td> 122 <td></td>
73 <td>)</td> 123 <td>)</td>
74 <td></td><td></td><td></td> 124 <td></td><td></td>
75 </tr> 125 </tr>
76 </table> 126 </table>
77 </div> 127 </div>
78 <div class="memdoc"> 128 <div class="memdoc">
79 129
80 <p> 130 </div>
131 </div>
132 </div>
133 </div>
134 <div id="nav-path" class="navpath">
135 <ul>
136 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
81 137
82 </div> 138 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
83 </div><p> 139 <a href="http://www.doxygen.org/index.html">
84 </div> 140 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
85 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp; 141 </ul>
86 <a href="http://www.doxygen.org/index.html"> 142 </div>
87 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 143
144
88 </body> 145 </body>
89 </html> 146 </html>