Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1PluginAdapter.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: Vamp::PluginAdapter&lt; P &gt; Class Template 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li><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="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 59 </ul>
Chris@1 60 </div>
Chris@1 61 </div>
Chris@1 62 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 63 <div id="nav-tree">
Chris@1 64 <div id="nav-tree-contents">
Chris@1 65 </div>
Chris@1 66 </div>
Chris@1 67 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 68 class="ui-resizable-handle">
Chris@1 69 </div>
Chris@1 70 </div>
Chris@1 71 <script type="text/javascript">
Chris@1 72 initNavTree('classVamp_1_1PluginAdapter.html','');
Chris@1 73 </script>
Chris@1 74 <div id="doc-content">
Chris@1 75 <div class="header">
Chris@1 76 <div class="summary">
Chris@1 77 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 78 <a href="#pro-methods">Protected Member Functions</a> &#124;
Chris@1 79 <a href="#pro-attribs">Protected Attributes</a> </div>
Chris@1 80 <div class="headertitle">
Chris@1 81 <div class="title">Vamp::PluginAdapter&lt; P &gt; Class Template Reference</div> </div>
Chris@3 82 </div><!--header-->
Chris@1 83 <div class="contents">
Chris@3 84
Chris@1 85 <p><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.
Chris@1 86 <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p>
Chris@1 87
Chris@1 88 <p><code>#include &lt;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code></p>
Chris@1 89 <div class="dynheader">
Chris@1 90 Inheritance diagram for Vamp::PluginAdapter&lt; P &gt;:</div>
Chris@1 91 <div class="dyncontent">
Chris@1 92 <div class="center"><img src="classVamp_1_1PluginAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" alt="Inheritance graph"/></div>
Chris@1 93 <map name="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" id="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map">
Chris@1 94 <area shape="rect" id="node2" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its..." alt="" coords="7,6,165,31"/></map>
Chris@1 95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 96
Chris@1 97 <p><a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a></p>
Chris@1 98 <table class="memberdecls">
Chris@1 99 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 100 Public Member Functions</h2></td></tr>
Chris@3 101 <tr class="memitem:a16312efd629b7063d7b6d67889a2c15a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a> ()</td></tr>
Chris@3 102 <tr class="memitem:a9612c9df7d4844959a36921d43d4bd50"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a> ()</td></tr>
Chris@3 103 <tr class="memitem:ad24595002512f9f00e8e45216d6f5dfb"><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="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr>
Chris@3 104 <tr class="memdesc:ad24595002512f9f00e8e45216d6f5dfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#ad24595002512f9f00e8e45216d6f5dfb"></a><br/></td></tr>
Chris@1 105 <tr><td colspan="2"><h2><a name="pro-methods"></a>
Chris@1 106 Protected Member Functions</h2></td></tr>
Chris@3 107 <tr class="memitem:a3f387e7e37409e00d32477903b5b13d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">createPlugin</a> (float inputSampleRate)</td></tr>
Chris@1 108 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
Chris@1 109 Protected Attributes</h2></td></tr>
Chris@3 110 <tr class="memitem:a0e3594c54884efd5a7ef38030645745b"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr>
Chris@1 111 </table>
Chris@1 112 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 113 <div class="textblock"><h3>template&lt;typename P&gt;<br/>
Chris@1 114 class Vamp::PluginAdapter&lt; P &gt;</h3>
Chris@1 115
Chris@1 116 <p><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. </p>
Chris@1 117 <p>See <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>. </p>
Chris@1 118
Chris@1 119 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00095">95</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
Chris@1 120 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@3 121 <a class="anchor" id="a16312efd629b7063d7b6d67889a2c15a"></a>
Chris@1 122 <div class="memitem">
Chris@1 123 <div class="memproto">
Chris@1 124 <div class="memtemplate">
Chris@1 125 template&lt;typename P&gt; </div>
Chris@1 126 <table class="memname">
Chris@1 127 <tr>
Chris@1 128 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td>
Chris@1 129 <td>(</td>
Chris@1 130 <td class="paramname"></td><td>)</td>
Chris@1 131 <td><code> [inline]</code></td>
Chris@1 132 </tr>
Chris@1 133 </table>
Chris@1 134 </div>
Chris@1 135 <div class="memdoc">
Chris@1 136
Chris@1 137 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00098">98</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
Chris@1 138
Chris@1 139 </div>
Chris@1 140 </div>
Chris@3 141 <a class="anchor" id="a9612c9df7d4844959a36921d43d4bd50"></a>
Chris@1 142 <div class="memitem">
Chris@1 143 <div class="memproto">
Chris@1 144 <div class="memtemplate">
Chris@1 145 template&lt;typename P&gt; </div>
Chris@1 146 <table class="memname">
Chris@1 147 <tr>
Chris@1 148 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::~<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td>
Chris@1 149 <td>(</td>
Chris@1 150 <td class="paramname"></td><td>)</td>
Chris@1 151 <td><code> [inline, virtual]</code></td>
Chris@1 152 </tr>
Chris@1 153 </table>
Chris@1 154 </div>
Chris@1 155 <div class="memdoc">
Chris@1 156
Chris@1 157 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00099">99</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
Chris@1 158
Chris@1 159 </div>
Chris@1 160 </div>
Chris@1 161 <hr/><h2>Member Function Documentation</h2>
Chris@3 162 <a class="anchor" id="a3f387e7e37409e00d32477903b5b13d3"></a>
Chris@1 163 <div class="memitem">
Chris@1 164 <div class="memproto">
Chris@1 165 <div class="memtemplate">
Chris@1 166 template&lt;typename P&gt; </div>
Chris@1 167 <table class="memname">
Chris@1 168 <tr>
Chris@3 169 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::<a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">createPlugin</a> </td>
Chris@1 170 <td>(</td>
Chris@1 171 <td class="paramtype">float&#160;</td>
Chris@1 172 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@1 173 <td><code> [inline, protected, virtual]</code></td>
Chris@1 174 </tr>
Chris@1 175 </table>
Chris@1 176 </div>
Chris@1 177 <div class="memdoc">
Chris@1 178
Chris@1 179 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
Chris@1 180
Chris@1 181 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00102">102</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
Chris@1 182
Chris@1 183 </div>
Chris@1 184 </div>
Chris@3 185 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a>
Chris@1 186 <div class="memitem">
Chris@1 187 <div class="memproto">
Chris@1 188 <table class="memname">
Chris@1 189 <tr>
Chris@3 190 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor</a> </td>
Chris@1 191 <td>(</td>
Chris@1 192 <td class="paramname"></td><td>)</td>
Chris@1 193 <td><code> [inherited]</code></td>
Chris@1 194 </tr>
Chris@1 195 </table>
Chris@1 196 </div>
Chris@1 197 <div class="memdoc">
Chris@1 198
Chris@1 199 <p>Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. </p>
Chris@1 200
Chris@1 201 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p>
Chris@1 202
Chris@1 203 </div>
Chris@1 204 </div>
Chris@1 205 <hr/><h2>Member Data Documentation</h2>
Chris@3 206 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a>
Chris@1 207 <div class="memitem">
Chris@1 208 <div class="memproto">
Chris@1 209 <table class="memname">
Chris@1 210 <tr>
Chris@1 211 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code></td>
Chris@1 212 </tr>
Chris@1 213 </table>
Chris@1 214 </div>
Chris@1 215 <div class="memdoc">
Chris@1 216
Chris@1 217 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00081">81</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
Chris@1 218
Chris@1 219 </div>
Chris@1 220 </div>
Chris@1 221 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@1 222 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li>
Chris@1 223 </ul>
Chris@3 224 </div><!-- contents -->
Chris@1 225 </div>
Chris@1 226 <div id="nav-path" class="navpath">
Chris@1 227 <ul>
Chris@1 228 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@1 229 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </li>
Chris@1 230
Chris@3 231 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
Chris@1 232 <a href="http://www.doxygen.org/index.html">
Chris@3 233 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 234 </ul>
Chris@1 235 </div>
Chris@1 236
Chris@1 237
Chris@1 238 </body>
Chris@1 239 </html>