annotate code-doc/namespaceVamp.html @ 128:817c3988afc7 website tip

Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@0 5 <title>VampPluginSDK: Vamp Namespace Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@0 47 <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 48 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 49 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 51 </ul>
cannam@0 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="namespaces.html"><span>Namespace&#160;List</span></a></li>
cannam@50 56 <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
cannam@0 57 </ul>
cannam@0 58 </div>
cannam@0 59 </div>
cannam@50 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 61 <div id="nav-tree">
cannam@50 62 <div id="nav-tree-contents">
cannam@50 63 </div>
cannam@50 64 </div>
cannam@50 65 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 66 class="ui-resizable-handle">
cannam@50 67 </div>
cannam@50 68 </div>
cannam@50 69 <script type="text/javascript">
cannam@50 70 initNavTree('namespaceVamp.html','');
cannam@50 71 </script>
cannam@50 72 <div id="doc-content">
cannam@50 73 <div class="header">
cannam@50 74 <div class="summary">
cannam@50 75 <a href="#namespaces">Namespaces</a> &#124;
cannam@50 76 <a href="#nested-classes">Classes</a> &#124;
cannam@50 77 <a href="#func-members">Functions</a> </div>
cannam@50 78 <div class="headertitle">
cannam@50 79 <div class="title">Vamp Namespace Reference</div> </div>
cannam@50 80 </div>
cannam@0 81 <div class="contents">
cannam@50 82 <table class="memberdecls">
cannam@50 83 <tr><td colspan="2"><h2><a name="namespaces"></a>
cannam@50 84 Namespaces</h2></td></tr>
cannam@50 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>
cannam@50 86 <tr><td colspan="2"><h2><a name="nested-classes"></a>
cannam@50 87 Classes</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 100 <tr><td colspan="2"><h2><a name="func-members"></a>
cannam@50 101 Functions</h2></td></tr>
cannam@50 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>
cannam@0 103 </table>
cannam@50 104 <hr/><h2>Function Documentation</h2>
cannam@50 105 <a class="anchor" id="a85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator&lt;&lt;" ref="a85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &amp;out, const RealTime &amp;rt)" -->
cannam@0 106 <div class="memitem">
cannam@0 107 <div class="memproto">
cannam@0 108 <table class="memname">
cannam@0 109 <tr>
cannam@50 110 <td class="memname">std::ostream&amp; Vamp::operator&lt;&lt; </td>
cannam@0 111 <td>(</td>
cannam@50 112 <td class="paramtype">std::ostream &amp;&#160;</td>
cannam@50 113 <td class="paramname"><em>out</em>, </td>
cannam@0 114 </tr>
cannam@0 115 <tr>
cannam@0 116 <td class="paramkey"></td>
cannam@0 117 <td></td>
cannam@50 118 <td class="paramtype">const RealTime &amp;&#160;</td>
cannam@50 119 <td class="paramname"><em>rt</em>&#160;</td>
cannam@0 120 </tr>
cannam@0 121 <tr>
cannam@0 122 <td></td>
cannam@0 123 <td>)</td>
cannam@50 124 <td></td><td></td>
cannam@0 125 </tr>
cannam@0 126 </table>
cannam@0 127 </div>
cannam@0 128 <div class="memdoc">
cannam@0 129
cannam@50 130 </div>
cannam@50 131 </div>
cannam@50 132 </div>
cannam@50 133 </div>
cannam@50 134 <div id="nav-path" class="navpath">
cannam@50 135 <ul>
cannam@50 136 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
cannam@0 137
cannam@50 138 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
cannam@50 139 <a href="http://www.doxygen.org/index.html">
cannam@50 140 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 141 </ul>
cannam@50 142 </div>
cannam@50 143
cannam@50 144
cannam@0 145 </body>
cannam@0 146 </html>