Mercurial > hg > vamp-docs

comparison 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
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
5 <title>VampPluginSDK: Vamp::PluginAdapter&lt; P &gt; Class Template Reference</title> 6 <title>VampPluginSDK: Vamp::PluginAdapter&lt; P &gt; Class Template Reference</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
76 <a href="#pub-methods">Public Member Functions</a> &#124; 77 <a href="#pub-methods">Public Member Functions</a> &#124;
77 <a href="#pro-methods">Protected Member Functions</a> &#124; 78 <a href="#pro-methods">Protected Member Functions</a> &#124;
78 <a href="#pro-attribs">Protected Attributes</a> </div> 79 <a href="#pro-attribs">Protected Attributes</a> </div>
79 <div class="headertitle"> 80 <div class="headertitle">
80 <div class="title">Vamp::PluginAdapter&lt; P &gt; Class Template Reference</div> </div> 81 <div class="title">Vamp::PluginAdapter&lt; P &gt; Class Template Reference</div> </div>
81 </div> 82 </div><!--header-->
82 <div class="contents"> 83 <div class="contents">
83 <!-- doxytag: class="Vamp::PluginAdapter" --><!-- doxytag: inherits="Vamp::PluginAdapterBase" --> 84
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. 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.
85 <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p> 86 <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p>
86 87
87 <p><code>#include &lt;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code></p> 88 <p><code>#include &lt;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code></p>
88 <div class="dynheader"> 89 <div class="dynheader">
95 96
96 <p><a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a></p> 97 <p><a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a></p>
97 <table class="memberdecls"> 98 <table class="memberdecls">
98 <tr><td colspan="2"><h2><a name="pub-methods"></a> 99 <tr><td colspan="2"><h2><a name="pub-methods"></a>
99 Public Member Functions</h2></td></tr> 100 Public Member Functions</h2></td></tr>
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> 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>
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> 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>
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> 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>
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> 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>
104 <tr><td colspan="2"><h2><a name="pro-methods"></a> 105 <tr><td colspan="2"><h2><a name="pro-methods"></a>
105 Protected Member Functions</h2></td></tr> 106 Protected Member Functions</h2></td></tr>
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> 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>
107 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 108 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
108 Protected Attributes</h2></td></tr> 109 Protected Attributes</h2></td></tr>
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> 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>
110 </table> 111 </table>
111 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 112 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
112 <div class="textblock"><h3>template&lt;typename P&gt;<br/> 113 <div class="textblock"><h3>template&lt;typename P&gt;<br/>
113 class Vamp::PluginAdapter&lt; P &gt;</h3> 114 class Vamp::PluginAdapter&lt; P &gt;</h3>
114 115
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> 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>
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> 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>
117 118
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> 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>
119 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2> 120 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
120 <a class="anchor" id="a16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="a16312efd629b7063d7b6d67889a2c15a" args="()" --> 121 <a class="anchor" id="a16312efd629b7063d7b6d67889a2c15a"></a>
121 <div class="memitem"> 122 <div class="memitem">
122 <div class="memproto"> 123 <div class="memproto">
123 <div class="memtemplate"> 124 <div class="memtemplate">
124 template&lt;typename P&gt; </div> 125 template&lt;typename P&gt; </div>
125 <table class="memname"> 126 <table class="memname">
135 136
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> 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>
137 138
138 </div> 139 </div>
139 </div> 140 </div>
140 <a class="anchor" id="a9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="a9612c9df7d4844959a36921d43d4bd50" args="()" --> 141 <a class="anchor" id="a9612c9df7d4844959a36921d43d4bd50"></a>
141 <div class="memitem"> 142 <div class="memitem">
142 <div class="memproto"> 143 <div class="memproto">
143 <div class="memtemplate"> 144 <div class="memtemplate">
144 template&lt;typename P&gt; </div> 145 template&lt;typename P&gt; </div>
145 <table class="memname"> 146 <table class="memname">
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> 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>
157 158
158 </div> 159 </div>
159 </div> 160 </div>
160 <hr/><h2>Member Function Documentation</h2> 161 <hr/><h2>Member Function Documentation</h2>
161 <a class="anchor" id="a3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="a3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" --> 162 <a class="anchor" id="a3f387e7e37409e00d32477903b5b13d3"></a>
162 <div class="memitem"> 163 <div class="memitem">
163 <div class="memproto"> 164 <div class="memproto">
164 <div class="memtemplate"> 165 <div class="memtemplate">
165 template&lt;typename P&gt; </div> 166 template&lt;typename P&gt; </div>
166 <table class="memname"> 167 <table class="memname">
167 <tr> 168 <tr>
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> 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>
169 <td>(</td> 170 <td>(</td>
170 <td class="paramtype">float&#160;</td> 171 <td class="paramtype">float&#160;</td>
171 <td class="paramname"><em>inputSampleRate</em></td><td>)</td> 172 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
172 <td><code> [inline, protected, virtual]</code></td> 173 <td><code> [inline, protected, virtual]</code></td>
173 </tr> 174 </tr>
179 180
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> 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>
181 182
182 </div> 183 </div>
183 </div> 184 </div>
184 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="ad24595002512f9f00e8e45216d6f5dfb" args="()" --> 185 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a>
185 <div class="memitem"> 186 <div class="memitem">
186 <div class="memproto"> 187 <div class="memproto">
187 <table class="memname"> 188 <table class="memname">
188 <tr> 189 <tr>
189 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td> 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>
190 <td>(</td> 191 <td>(</td>
191 <td class="paramname"></td><td>)</td> 192 <td class="paramname"></td><td>)</td>
192 <td><code> [inherited]</code></td> 193 <td><code> [inherited]</code></td>
193 </tr> 194 </tr>
194 </table> 195 </table>
200 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p> 201 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p>
201 202
202 </div> 203 </div>
203 </div> 204 </div>
204 <hr/><h2>Member Data Documentation</h2> 205 <hr/><h2>Member Data Documentation</h2>
205 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="a0e3594c54884efd5a7ef38030645745b" args="" --> 206 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a>
206 <div class="memitem"> 207 <div class="memitem">
207 <div class="memproto"> 208 <div class="memproto">
208 <table class="memname"> 209 <table class="memname">
209 <tr> 210 <tr>
210 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code></td> 211 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code></td>
218 </div> 219 </div>
219 </div> 220 </div>
220 <hr/>The documentation for this class was generated from the following file:<ul> 221 <hr/>The documentation for this class was generated from the following file:<ul>
221 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li> 222 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li>
222 </ul> 223 </ul>
223 </div> 224 </div><!-- contents -->
224 </div> 225 </div>
225 <div id="nav-path" class="navpath"> 226 <div id="nav-path" class="navpath">
226 <ul> 227 <ul>
227 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 228 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
228 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </li> 229 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </li>
229 230
230 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by 231 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
231 <a href="http://www.doxygen.org/index.html"> 232 <a href="http://www.doxygen.org/index.html">
232 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 233 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
233 </ul> 234 </ul>
234 </div> 235 </div>
235 236
236 237
237 </body> 238 </body>