Mercurial > hg > vamp-docs

annotate code-docs/classVamp_1_1PluginAdapter.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
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@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: Vamp::PluginAdapter&lt; P &gt; Class Template Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('classVamp_1_1PluginAdapter.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 64 <a href="#pro-methods">Protected Member Functions</a> &#124;
Chris@6 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
Chris@6 66 <a href="classVamp_1_1PluginAdapter-members.html">List of all members</a> </div>
Chris@1 67 <div class="headertitle">
Chris@1 68 <div class="title">Vamp::PluginAdapter&lt; P &gt; Class Template Reference</div> </div>
Chris@3 69 </div><!--header-->
Chris@1 70 <div class="contents">
Chris@3 71
Chris@1 72 <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 73 <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p>
Chris@1 74
Chris@1 75 <p><code>#include &lt;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code></p>
Chris@1 76 <div class="dynheader">
Chris@1 77 Inheritance diagram for Vamp::PluginAdapter&lt; P &gt;:</div>
Chris@1 78 <div class="dyncontent">
Chris@1 79 <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 80 <map name="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" id="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map">
Chris@6 81 <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,5,173,31"/>
Chris@6 82 </map>
Chris@1 83 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
Chris@1 84 <table class="memberdecls">
Chris@6 85 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Chris@1 86 Public Member Functions</h2></td></tr>
Chris@3 87 <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@6 88 <tr class="separator:a16312efd629b7063d7b6d67889a2c15a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 89 <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@6 90 <tr class="separator:a9612c9df7d4844959a36921d43d4bd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 91 <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@6 92 <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">More...</a><br /></td></tr>
Chris@6 93 <tr class="separator:ad24595002512f9f00e8e45216d6f5dfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 94 </table><table class="memberdecls">
Chris@6 95 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Chris@1 96 Protected Member Functions</h2></td></tr>
Chris@3 97 <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@6 98 <tr class="separator:a3f387e7e37409e00d32477903b5b13d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 99 </table><table class="memberdecls">
Chris@6 100 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Chris@1 101 Protected Attributes</h2></td></tr>
Chris@3 102 <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@6 103 <tr class="separator:a0e3594c54884efd5a7ef38030645745b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 104 </table>
Chris@6 105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@6 106 <div class="textblock"><h3>template&lt;typename P&gt;<br />
Chris@1 107 class Vamp::PluginAdapter&lt; P &gt;</h3>
Chris@1 108
Chris@1 109 <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 110 <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 111
Chris@6 112 <p class="definition">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@6 113 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 114 <a id="a16312efd629b7063d7b6d67889a2c15a"></a>
Chris@6 115 <h2 class="memtitle"><span class="permalink"><a href="#a16312efd629b7063d7b6d67889a2c15a">&#9670;&nbsp;</a></span>PluginAdapter()</h2>
Chris@6 116
Chris@1 117 <div class="memitem">
Chris@1 118 <div class="memproto">
Chris@1 119 <div class="memtemplate">
Chris@1 120 template&lt;typename P&gt; </div>
Chris@6 121 <table class="mlabels">
Chris@6 122 <tr>
Chris@6 123 <td class="mlabels-left">
Chris@1 124 <table class="memname">
Chris@1 125 <tr>
Chris@1 126 <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 127 <td>(</td>
Chris@1 128 <td class="paramname"></td><td>)</td>
Chris@6 129 <td></td>
Chris@1 130 </tr>
Chris@1 131 </table>
Chris@6 132 </td>
Chris@6 133 <td class="mlabels-right">
Chris@6 134 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
Chris@6 135 </tr>
Chris@6 136 </table>
Chris@6 137 </div><div class="memdoc">
Chris@1 138
Chris@6 139 <p class="definition">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 140
Chris@1 141 </div>
Chris@1 142 </div>
Chris@6 143 <a id="a9612c9df7d4844959a36921d43d4bd50"></a>
Chris@6 144 <h2 class="memtitle"><span class="permalink"><a href="#a9612c9df7d4844959a36921d43d4bd50">&#9670;&nbsp;</a></span>~PluginAdapter()</h2>
Chris@6 145
Chris@1 146 <div class="memitem">
Chris@1 147 <div class="memproto">
Chris@1 148 <div class="memtemplate">
Chris@1 149 template&lt;typename P&gt; </div>
Chris@6 150 <table class="mlabels">
Chris@6 151 <tr>
Chris@6 152 <td class="mlabels-left">
Chris@1 153 <table class="memname">
Chris@1 154 <tr>
Chris@1 155 <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 156 <td>(</td>
Chris@1 157 <td class="paramname"></td><td>)</td>
Chris@6 158 <td></td>
Chris@1 159 </tr>
Chris@1 160 </table>
Chris@6 161 </td>
Chris@6 162 <td class="mlabels-right">
Chris@6 163 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
Chris@6 164 </tr>
Chris@6 165 </table>
Chris@6 166 </div><div class="memdoc">
Chris@1 167
Chris@6 168 <p class="definition">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 169
Chris@1 170 </div>
Chris@1 171 </div>
Chris@6 172 <h2 class="groupheader">Member Function Documentation</h2>
Chris@6 173 <a id="a3f387e7e37409e00d32477903b5b13d3"></a>
Chris@6 174 <h2 class="memtitle"><span class="permalink"><a href="#a3f387e7e37409e00d32477903b5b13d3">&#9670;&nbsp;</a></span>createPlugin()</h2>
Chris@6 175
Chris@1 176 <div class="memitem">
Chris@1 177 <div class="memproto">
Chris@1 178 <div class="memtemplate">
Chris@1 179 template&lt;typename P&gt; </div>
Chris@6 180 <table class="mlabels">
Chris@6 181 <tr>
Chris@6 182 <td class="mlabels-left">
Chris@1 183 <table class="memname">
Chris@1 184 <tr>
Chris@6 185 <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>
Chris@1 186 <td>(</td>
Chris@1 187 <td class="paramtype">float&#160;</td>
Chris@1 188 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
Chris@6 189 <td></td>
Chris@1 190 </tr>
Chris@1 191 </table>
Chris@6 192 </td>
Chris@6 193 <td class="mlabels-right">
Chris@6 194 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
Chris@6 195 </tr>
Chris@6 196 </table>
Chris@6 197 </div><div class="memdoc">
Chris@1 198
Chris@1 199 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
Chris@1 200
Chris@6 201 <p class="definition">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@6 202
Chris@6 203 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
Chris@1 204
Chris@1 205 </div>
Chris@1 206 </div>
Chris@6 207 <a id="ad24595002512f9f00e8e45216d6f5dfb"></a>
Chris@6 208 <h2 class="memtitle"><span class="permalink"><a href="#ad24595002512f9f00e8e45216d6f5dfb">&#9670;&nbsp;</a></span>getDescriptor()</h2>
Chris@6 209
Chris@1 210 <div class="memitem">
Chris@1 211 <div class="memproto">
Chris@6 212 <table class="mlabels">
Chris@6 213 <tr>
Chris@6 214 <td class="mlabels-left">
Chris@1 215 <table class="memname">
Chris@1 216 <tr>
Chris@6 217 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
Chris@1 218 <td>(</td>
Chris@1 219 <td class="paramname"></td><td>)</td>
Chris@6 220 <td></td>
Chris@1 221 </tr>
Chris@1 222 </table>
Chris@6 223 </td>
Chris@6 224 <td class="mlabels-right">
Chris@6 225 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
Chris@6 226 </tr>
Chris@6 227 </table>
Chris@6 228 </div><div class="memdoc">
Chris@1 229
Chris@1 230 <p>Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. </p>
Chris@1 231
Chris@6 232 <p class="reference">Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p>
Chris@1 233
Chris@1 234 </div>
Chris@1 235 </div>
Chris@6 236 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 237 <a id="a0e3594c54884efd5a7ef38030645745b"></a>
Chris@6 238 <h2 class="memtitle"><span class="permalink"><a href="#a0e3594c54884efd5a7ef38030645745b">&#9670;&nbsp;</a></span>m_impl</h2>
Chris@6 239
Chris@1 240 <div class="memitem">
Chris@1 241 <div class="memproto">
Chris@6 242 <table class="mlabels">
Chris@6 243 <tr>
Chris@6 244 <td class="mlabels-left">
Chris@1 245 <table class="memname">
Chris@1 246 <tr>
Chris@6 247 <td class="memname">Impl* Vamp::PluginAdapterBase::m_impl</td>
Chris@1 248 </tr>
Chris@1 249 </table>
Chris@6 250 </td>
Chris@6 251 <td class="mlabels-right">
Chris@6 252 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
Chris@6 253 </tr>
Chris@6 254 </table>
Chris@6 255 </div><div class="memdoc">
Chris@1 256
Chris@6 257 <p class="definition">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 258
Chris@1 259 </div>
Chris@1 260 </div>
Chris@1 261 <hr/>The documentation for this class was generated from the following file:<ul>
Chris@1 262 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li>
Chris@1 263 </ul>
Chris@3 264 </div><!-- contents -->
Chris@6 265 </div><!-- doc-content -->
Chris@6 266 <!-- start footer part -->
Chris@6 267 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 268 <ul>
Chris@6 269 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></li>
Chris@6 270 <li class="footer">Generated by
Chris@6 271 <a href="http://www.doxygen.org/index.html">
Chris@6 272 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 273 </ul>
Chris@1 274 </div>
Chris@1 275 </body>
Chris@1 276 </html>