Mercurial > hg > vamp-website

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

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