Mercurial > hg > vamp-docs

annotate code-docs/plugins_8cpp.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: plugins.cpp File Reference</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li class="current"><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="files.html"><span>File&#160;List</span></a></li>
Chris@1 57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('plugins_8cpp.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#func-members">Functions</a> &#124;
Chris@1 77 <a href="#var-members">Variables</a> </div>
Chris@1 78 <div class="headertitle">
Chris@1 79 <div class="title">plugins.cpp File Reference</div> </div>
Chris@3 80 </div><!--header-->
Chris@1 81 <div class="contents">
Chris@1 82
Chris@1 83 <p><a href="plugins_8cpp_source.html">Go to the source code of this file.</a></p>
Chris@1 84 <table class="memberdecls">
Chris@1 85 <tr><td colspan="2"><h2><a name="func-members"></a>
Chris@1 86 Functions</h2></td></tr>
Chris@3 87 <tr class="memitem:abb0fd6db76ddd39698bc370e0fd0ea78"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> (unsigned int version, unsigned int index)</td></tr>
Chris@3 88 <tr class="memdesc:abb0fd6db76ddd39698bc370e0fd0ea78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#abb0fd6db76ddd39698bc370e0fd0ea78"></a><br/></td></tr>
Chris@1 89 <tr><td colspan="2"><h2><a name="var-members"></a>
Chris@1 90 Variables</h2></td></tr>
Chris@3 91 <tr class="memitem:a01871ad1ab2bb64e2c53fe5cce19b780"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 92 &lt; <a class="el" href="classZeroCrossing.html">ZeroCrossing</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a></td></tr>
Chris@3 93 <tr class="memitem:ac96bdfb6356a153341b29b43c4961cd5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 94 &lt; <a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a></td></tr>
Chris@3 95 <tr class="memitem:acee3823cb6a43281a2ecf923b69613dd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 96 &lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr>
Chris@3 97 <tr class="memitem:a937de36d22633261716032570064a4be"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 98 &lt; <a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a></td></tr>
Chris@3 99 <tr class="memitem:a4e60bb6a99451da5deb18b969e6b16cd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 100 &lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr>
Chris@3 101 <tr class="memitem:a77810f485caaae4a8b2303496046d3d7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
Chris@1 102 &lt; <a class="el" href="classPowerSpectrum.html">PowerSpectrum</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></td></tr>
Chris@1 103 </table>
Chris@1 104 <hr/><h2>Function Documentation</h2>
Chris@3 105 <a class="anchor" id="abb0fd6db76ddd39698bc370e0fd0ea78"></a>
Chris@1 106 <div class="memitem">
Chris@1 107 <div class="memproto">
Chris@1 108 <table class="memname">
Chris@1 109 <tr>
Chris@3 110 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> </td>
Chris@1 111 <td>(</td>
Chris@1 112 <td class="paramtype">unsigned int&#160;</td>
Chris@1 113 <td class="paramname"><em>hostApiVersion</em>, </td>
Chris@1 114 </tr>
Chris@1 115 <tr>
Chris@1 116 <td class="paramkey"></td>
Chris@1 117 <td></td>
Chris@1 118 <td class="paramtype">unsigned int&#160;</td>
Chris@1 119 <td class="paramname"><em>index</em>&#160;</td>
Chris@1 120 </tr>
Chris@1 121 <tr>
Chris@1 122 <td></td>
Chris@1 123 <td>)</td>
Chris@1 124 <td></td><td></td>
Chris@1 125 </tr>
Chris@1 126 </table>
Chris@1 127 </div>
Chris@1 128 <div class="memdoc">
Chris@1 129
Chris@1 130 <p>Get the descriptor for a given plugin index in this library. </p>
Chris@1 131 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
Chris@1 132 <p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
Chris@1 133 <p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>
Chris@1 134
Chris@1 135 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 136
Chris@1 137 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
Chris@1 138
Chris@1 139 </div>
Chris@1 140 </div>
Chris@1 141 <hr/><h2>Variable Documentation</h2>
Chris@3 142 <a class="anchor" id="a01871ad1ab2bb64e2c53fe5cce19b780"></a>
Chris@1 143 <div class="memitem">
Chris@1 144 <div class="memproto">
Chris@1 145 <table class="memname">
Chris@1 146 <tr>
Chris@1 147 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classZeroCrossing.html">ZeroCrossing</a>&gt; <a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a><code> [static]</code></td>
Chris@1 148 </tr>
Chris@1 149 </table>
Chris@1 150 </div>
Chris@1 151 <div class="memdoc">
Chris@1 152
Chris@1 153 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00047">47</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 154
Chris@1 155 </div>
Chris@1 156 </div>
Chris@3 157 <a class="anchor" id="ac96bdfb6356a153341b29b43c4961cd5"></a>
Chris@1 158 <div class="memitem">
Chris@1 159 <div class="memproto">
Chris@1 160 <table class="memname">
Chris@1 161 <tr>
Chris@1 162 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classSpectralCentroid.html">SpectralCentroid</a>&gt; <a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a><code> [static]</code></td>
Chris@1 163 </tr>
Chris@1 164 </table>
Chris@1 165 </div>
Chris@1 166 <div class="memdoc">
Chris@1 167
Chris@1 168 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00048">48</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 169
Chris@1 170 </div>
Chris@1 171 </div>
Chris@3 172 <a class="anchor" id="acee3823cb6a43281a2ecf923b69613dd"></a>
Chris@1 173 <div class="memitem">
Chris@1 174 <div class="memproto">
Chris@1 175 <table class="memname">
Chris@1 176 <tr>
Chris@1 177 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a>&gt; <a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a><code> [static]</code></td>
Chris@1 178 </tr>
Chris@1 179 </table>
Chris@1 180 </div>
Chris@1 181 <div class="memdoc">
Chris@1 182
Chris@1 183 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00049">49</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 184
Chris@1 185 </div>
Chris@1 186 </div>
Chris@3 187 <a class="anchor" id="a937de36d22633261716032570064a4be"></a>
Chris@1 188 <div class="memitem">
Chris@1 189 <div class="memproto">
Chris@1 190 <table class="memname">
Chris@1 191 <tr>
Chris@1 192 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a>&gt; <a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a><code> [static]</code></td>
Chris@1 193 </tr>
Chris@1 194 </table>
Chris@1 195 </div>
Chris@1 196 <div class="memdoc">
Chris@1 197
Chris@1 198 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00050">50</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 199
Chris@1 200 </div>
Chris@1 201 </div>
Chris@3 202 <a class="anchor" id="a4e60bb6a99451da5deb18b969e6b16cd"></a>
Chris@1 203 <div class="memitem">
Chris@1 204 <div class="memproto">
Chris@1 205 <table class="memname">
Chris@1 206 <tr>
Chris@1 207 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a>&gt; <a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a><code> [static]</code></td>
Chris@1 208 </tr>
Chris@1 209 </table>
Chris@1 210 </div>
Chris@1 211 <div class="memdoc">
Chris@1 212
Chris@1 213 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00051">51</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 214
Chris@1 215 </div>
Chris@1 216 </div>
Chris@3 217 <a class="anchor" id="a77810f485caaae4a8b2303496046d3d7"></a>
Chris@1 218 <div class="memitem">
Chris@1 219 <div class="memproto">
Chris@1 220 <table class="memname">
Chris@1 221 <tr>
Chris@1 222 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPowerSpectrum.html">PowerSpectrum</a>&gt; <a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a><code> [static]</code></td>
Chris@1 223 </tr>
Chris@1 224 </table>
Chris@1 225 </div>
Chris@1 226 <div class="memdoc">
Chris@1 227
Chris@1 228 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00052">52</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
Chris@1 229
Chris@1 230 </div>
Chris@1 231 </div>
Chris@3 232 </div><!-- contents -->
Chris@1 233 </div>
Chris@1 234 <div id="nav-path" class="navpath">
Chris@1 235 <ul>
Chris@1 236 <li class="navelem"><a class="el" href="plugins_8cpp.html">plugins.cpp</a> </li>
Chris@1 237
Chris@3 238 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
Chris@1 239 <a href="http://www.doxygen.org/index.html">
Chris@3 240 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 241 </ul>
Chris@1 242 </div>
Chris@1 243
Chris@1 244
Chris@1 245 </body>
Chris@1 246 </html>