Mercurial > hg > vamp-docs

comparison code-docs/classVamp_1_1PluginAdapterBase.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::PluginAdapterBase Class Reference</title> 6 <title>VampPluginSDK: Vamp::PluginAdapterBase Class 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::PluginAdapterBase Class Reference</div> </div> 81 <div class="title">Vamp::PluginAdapterBase Class Reference</div> </div>
81 </div> 82 </div><!--header-->
82 <div class="contents"> 83 <div class="contents">
83 <!-- doxytag: class="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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. 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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API.
85 <a href="classVamp_1_1PluginAdapterBase.html#details">More...</a></p> 86 <a href="classVamp_1_1PluginAdapterBase.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_1PluginAdapterBase-members.html">List of all members.</a></p> 97 <p><a href="classVamp_1_1PluginAdapterBase-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">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</a> ()</td></tr> 101 <tr class="memitem:aaa8afd318b6c3da108e1cbcc7e46603d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</a> ()</td></tr>
101 <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> 102 <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>
102 <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> 103 <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>
103 <tr><td colspan="2"><h2><a name="pro-methods"></a> 104 <tr><td colspan="2"><h2><a name="pro-methods"></a>
104 Protected Member Functions</h2></td></tr> 105 Protected Member Functions</h2></td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr> 106 <tr class="memitem:a5dad6a9b4b170c0f284962e125ac988e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</td></tr> 107 <tr class="memitem:a9116adb9b7a426f4f0ded15e45a5531b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</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"><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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. </p> 113 <div class="textblock"><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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. </p>
113 <p>Almost all <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter&lt;T&gt; for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. </p> 114 <p>Almost all <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter&lt;T&gt; for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. </p>
114 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl> 115 <dl class="section see"><dt>See also:</dt><dd><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl>
115 116
116 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00065">65</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p> 117 <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00065">65</a> of file <a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a>.</p>
117 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2> 118 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
118 <a class="anchor" id="aaa8afd318b6c3da108e1cbcc7e46603d"></a><!-- doxytag: member="Vamp::PluginAdapterBase::~PluginAdapterBase" ref="aaa8afd318b6c3da108e1cbcc7e46603d" args="()" --> 119 <a class="anchor" id="aaa8afd318b6c3da108e1cbcc7e46603d"></a>
119 <div class="memitem"> 120 <div class="memitem">
120 <div class="memproto"> 121 <div class="memproto">
121 <table class="memname"> 122 <table class="memname">
122 <tr> 123 <tr>
123 <td class="memname">virtual Vamp::PluginAdapterBase::~PluginAdapterBase </td> 124 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">Vamp::PluginAdapterBase::~PluginAdapterBase</a> </td>
124 <td>(</td> 125 <td>(</td>
125 <td class="paramname"></td><td>)</td> 126 <td class="paramname"></td><td>)</td>
126 <td><code> [virtual]</code></td> 127 <td><code> [virtual]</code></td>
127 </tr> 128 </tr>
128 </table> 129 </table>
129 </div> 130 </div>
130 <div class="memdoc"> 131 <div class="memdoc">
131 132
132 </div> 133 </div>
133 </div> 134 </div>
134 <a class="anchor" id="a5dad6a9b4b170c0f284962e125ac988e"></a><!-- doxytag: member="Vamp::PluginAdapterBase::PluginAdapterBase" ref="a5dad6a9b4b170c0f284962e125ac988e" args="()" --> 135 <a class="anchor" id="a5dad6a9b4b170c0f284962e125ac988e"></a>
135 <div class="memitem"> 136 <div class="memitem">
136 <div class="memproto"> 137 <div class="memproto">
137 <table class="memname"> 138 <table class="memname">
138 <tr> 139 <tr>
139 <td class="memname">Vamp::PluginAdapterBase::PluginAdapterBase </td> 140 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">Vamp::PluginAdapterBase::PluginAdapterBase</a> </td>
140 <td>(</td> 141 <td>(</td>
141 <td class="paramname"></td><td>)</td> 142 <td class="paramname"></td><td>)</td>
142 <td><code> [protected]</code></td> 143 <td><code> [protected]</code></td>
143 </tr> 144 </tr>
144 </table> 145 </table>
146 <div class="memdoc"> 147 <div class="memdoc">
147 148
148 </div> 149 </div>
149 </div> 150 </div>
150 <hr/><h2>Member Function Documentation</h2> 151 <hr/><h2>Member Function Documentation</h2>
151 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapterBase::getDescriptor" ref="ad24595002512f9f00e8e45216d6f5dfb" args="()" --> 152 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a>
152 <div class="memitem"> 153 <div class="memitem">
153 <div class="memproto"> 154 <div class="memproto">
154 <table class="memname"> 155 <table class="memname">
155 <tr> 156 <tr>
156 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td> 157 <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>
157 <td>(</td> 158 <td>(</td>
158 <td class="paramname"></td><td>)</td> 159 <td class="paramname"></td><td>)</td>
159 <td></td> 160 <td></td>
160 </tr> 161 </tr>
161 </table> 162 </table>
166 167
167 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p> 168 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p>
168 169
169 </div> 170 </div>
170 </div> 171 </div>
171 <a class="anchor" id="a9116adb9b7a426f4f0ded15e45a5531b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::createPlugin" ref="a9116adb9b7a426f4f0ded15e45a5531b" args="(float inputSampleRate)=0" --> 172 <a class="anchor" id="a9116adb9b7a426f4f0ded15e45a5531b"></a>
172 <div class="memitem"> 173 <div class="memitem">
173 <div class="memproto"> 174 <div class="memproto">
174 <table class="memname"> 175 <table class="memname">
175 <tr> 176 <tr>
176 <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::PluginAdapterBase::createPlugin </td> 177 <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase::createPlugin</a> </td>
177 <td>(</td> 178 <td>(</td>
178 <td class="paramtype">float&#160;</td> 179 <td class="paramtype">float&#160;</td>
179 <td class="paramname"><em>inputSampleRate</em></td><td>)</td> 180 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
180 <td><code> [protected, pure virtual]</code></td> 181 <td><code> [protected, pure virtual]</code></td>
181 </tr> 182 </tr>
186 <p>Implemented in <a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">Vamp::PluginAdapter&lt; P &gt;</a>.</p> 187 <p>Implemented in <a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">Vamp::PluginAdapter&lt; P &gt;</a>.</p>
187 188
188 </div> 189 </div>
189 </div> 190 </div>
190 <hr/><h2>Member Data Documentation</h2> 191 <hr/><h2>Member Data Documentation</h2>
191 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::m_impl" ref="a0e3594c54884efd5a7ef38030645745b" args="" --> 192 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a>
192 <div class="memitem"> 193 <div class="memitem">
193 <div class="memproto"> 194 <div class="memproto">
194 <table class="memname"> 195 <table class="memname">
195 <tr> 196 <tr>
196 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected]</code></td> 197 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected]</code></td>
204 </div> 205 </div>
205 </div> 206 </div>
206 <hr/>The documentation for this class was generated from the following file:<ul> 207 <hr/>The documentation for this class was generated from the following file:<ul>
207 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li> 208 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li>
208 </ul> 209 </ul>
209 </div> 210 </div><!-- contents -->
210 </div> 211 </div>
211 <div id="nav-path" class="navpath"> 212 <div id="nav-path" class="navpath">
212 <ul> 213 <ul>
213 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 214 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
214 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a> </li> 215 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a> </li>
215 216
216 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by 217 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
217 <a href="http://www.doxygen.org/index.html"> 218 <a href="http://www.doxygen.org/index.html">
218 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 219 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
219 </ul> 220 </ul>
220 </div> 221 </div>
221 222
222 223
223 </body> 224 </body>