Mercurial > hg > vamp-website

comparison code-doc/struct__VampPluginDescriptor.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: _VampPluginDescriptor Struct Reference</title> 3 <title>VampPluginSDK: _VampPluginDescriptor Struct Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
28 <p> 28 <p>
29 29
30 <p> 30 <p>
31 <a href="struct__VampPluginDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 31 <a href="struct__VampPluginDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
32 32
33 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00206">206</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 33 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00248">248</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
34 <table border="0" cellpadding="0" cellspacing="0"> 34 <table border="0" cellpadding="0" cellspacing="0">
35 <tr><td></td></tr> 35 <tr><td></td></tr>
36 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 36 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr> 37 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr>
38 38
139 139
140 <p> 140 <p>
141 API version with which this descriptor is compatible. 141 API version with which this descriptor is compatible.
142 <p> 142 <p>
143 143
144 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00209">209</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 144 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00251">251</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
145
146 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00145">Vamp::PluginHostAdapter::getVampApiVersion()</a>.</p>
147 145
148 </div> 146 </div>
149 </div><p> 147 </div><p>
150 <a class="anchor" name="4915ec8276749cb505c01d25a6d02219"></a><!-- doxytag: member="_VampPluginDescriptor::identifier" ref="4915ec8276749cb505c01d25a6d02219" args="" --> 148 <a class="anchor" name="4915ec8276749cb505c01d25a6d02219"></a><!-- doxytag: member="_VampPluginDescriptor::identifier" ref="4915ec8276749cb505c01d25a6d02219" args="" -->
151 <div class="memitem"> 149 <div class="memitem">
160 158
161 <p> 159 <p>
162 Computer-usable name of the plugin. 160 Computer-usable name of the plugin.
163 <p> 161 <p>
164 Must not change. [a-zA-Z0-9_] 162 Must not change. [a-zA-Z0-9_]
165 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00212">212</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 163 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00254">254</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
166
167 <p>Referenced by <a class="el" href="PluginLoader_8cpp-source.html#l00226">Vamp::HostExt::PluginLoader::Impl::enumeratePlugins()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00151">Vamp::PluginHostAdapter::getIdentifier()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00355">Vamp::HostExt::PluginLoader::Impl::loadPlugin()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
168 164
169 </div> 165 </div>
170 </div><p> 166 </div><p>
171 <a class="anchor" name="9dd5a0190e4d453ff36b5acb7000b150"></a><!-- doxytag: member="_VampPluginDescriptor::name" ref="9dd5a0190e4d453ff36b5acb7000b150" args="" --> 167 <a class="anchor" name="9dd5a0190e4d453ff36b5acb7000b150"></a><!-- doxytag: member="_VampPluginDescriptor::name" ref="9dd5a0190e4d453ff36b5acb7000b150" args="" -->
172 <div class="memitem"> 168 <div class="memitem">
181 177
182 <p> 178 <p>
183 Human-readable name of the plugin. 179 Human-readable name of the plugin.
184 <p> 180 <p>
185 May be translatable. 181 May be translatable.
186 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00215">215</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 182 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00257">257</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
187
188 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00157">Vamp::PluginHostAdapter::getName()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
189 183
190 </div> 184 </div>
191 </div><p> 185 </div><p>
192 <a class="anchor" name="9ff8050f92f1a04a68bb34a9d368295e"></a><!-- doxytag: member="_VampPluginDescriptor::description" ref="9ff8050f92f1a04a68bb34a9d368295e" args="" --> 186 <a class="anchor" name="9ff8050f92f1a04a68bb34a9d368295e"></a><!-- doxytag: member="_VampPluginDescriptor::description" ref="9ff8050f92f1a04a68bb34a9d368295e" args="" -->
193 <div class="memitem"> 187 <div class="memitem">
202 196
203 <p> 197 <p>
204 Human-readable short text about the plugin. 198 Human-readable short text about the plugin.
205 <p> 199 <p>
206 May be translatable. 200 May be translatable.
207 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00218">218</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 201 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00260">260</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
208
209 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00163">Vamp::PluginHostAdapter::getDescription()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
210 202
211 </div> 203 </div>
212 </div><p> 204 </div><p>
213 <a class="anchor" name="4dca3d57331802964716edfa80580c9b"></a><!-- doxytag: member="_VampPluginDescriptor::maker" ref="4dca3d57331802964716edfa80580c9b" args="" --> 205 <a class="anchor" name="4dca3d57331802964716edfa80580c9b"></a><!-- doxytag: member="_VampPluginDescriptor::maker" ref="4dca3d57331802964716edfa80580c9b" args="" -->
214 <div class="memitem"> 206 <div class="memitem">
223 215
224 <p> 216 <p>
225 Human-readable name of plugin's author or vendor. 217 Human-readable name of plugin's author or vendor.
226 <p> 218 <p>
227 219
228 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00221">221</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 220 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00263">263</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
229
230 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00169">Vamp::PluginHostAdapter::getMaker()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
231 221
232 </div> 222 </div>
233 </div><p> 223 </div><p>
234 <a class="anchor" name="04427c420d9252c7796c0bf5101345ae"></a><!-- doxytag: member="_VampPluginDescriptor::pluginVersion" ref="04427c420d9252c7796c0bf5101345ae" args="" --> 224 <a class="anchor" name="04427c420d9252c7796c0bf5101345ae"></a><!-- doxytag: member="_VampPluginDescriptor::pluginVersion" ref="04427c420d9252c7796c0bf5101345ae" args="" -->
235 <div class="memitem"> 225 <div class="memitem">
244 234
245 <p> 235 <p>
246 Version number of the plugin. 236 Version number of the plugin.
247 <p> 237 <p>
248 238
249 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00224">224</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 239 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00266">266</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
250
251 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00175">Vamp::PluginHostAdapter::getPluginVersion()</a>.</p>
252 240
253 </div> 241 </div>
254 </div><p> 242 </div><p>
255 <a class="anchor" name="e704bba384af0de056a26da1b13ee521"></a><!-- doxytag: member="_VampPluginDescriptor::copyright" ref="e704bba384af0de056a26da1b13ee521" args="" --> 243 <a class="anchor" name="e704bba384af0de056a26da1b13ee521"></a><!-- doxytag: member="_VampPluginDescriptor::copyright" ref="e704bba384af0de056a26da1b13ee521" args="" -->
256 <div class="memitem"> 244 <div class="memitem">
265 253
266 <p> 254 <p>
267 Human-readable summary of copyright or licensing for plugin. 255 Human-readable summary of copyright or licensing for plugin.
268 <p> 256 <p>
269 257
270 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00227">227</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 258 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00269">269</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
271
272 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00181">Vamp::PluginHostAdapter::getCopyright()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
273 259
274 </div> 260 </div>
275 </div><p> 261 </div><p>
276 <a class="anchor" name="e6271dc3ea0cea959c84a64185492cab"></a><!-- doxytag: member="_VampPluginDescriptor::parameterCount" ref="e6271dc3ea0cea959c84a64185492cab" args="" --> 262 <a class="anchor" name="e6271dc3ea0cea959c84a64185492cab"></a><!-- doxytag: member="_VampPluginDescriptor::parameterCount" ref="e6271dc3ea0cea959c84a64185492cab" args="" -->
277 <div class="memitem"> 263 <div class="memitem">
286 272
287 <p> 273 <p>
288 Number of parameter inputs. 274 Number of parameter inputs.
289 <p> 275 <p>
290 276
291 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00230">230</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 277 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00272">272</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
292
293 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
294 278
295 </div> 279 </div>
296 </div><p> 280 </div><p>
297 <a class="anchor" name="64d614862604c31d6b84c49005f51913"></a><!-- doxytag: member="_VampPluginDescriptor::parameters" ref="64d614862604c31d6b84c49005f51913" args="" --> 281 <a class="anchor" name="64d614862604c31d6b84c49005f51913"></a><!-- doxytag: member="_VampPluginDescriptor::parameters" ref="64d614862604c31d6b84c49005f51913" args="" -->
298 <div class="memitem"> 282 <div class="memitem">
307 291
308 <p> 292 <p>
309 Fixed descriptors for parameter inputs. 293 Fixed descriptors for parameter inputs.
310 <p> 294 <p>
311 295
312 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00233">233</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 296 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00275">275</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
313
314 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
315 297
316 </div> 298 </div>
317 </div><p> 299 </div><p>
318 <a class="anchor" name="1962666aa173e7a9a2c30dc82e4b2e00"></a><!-- doxytag: member="_VampPluginDescriptor::programCount" ref="1962666aa173e7a9a2c30dc82e4b2e00" args="" --> 300 <a class="anchor" name="1962666aa173e7a9a2c30dc82e4b2e00"></a><!-- doxytag: member="_VampPluginDescriptor::programCount" ref="1962666aa173e7a9a2c30dc82e4b2e00" args="" -->
319 <div class="memitem"> 301 <div class="memitem">
328 310
329 <p> 311 <p>
330 Number of programs. 312 Number of programs.
331 <p> 313 <p>
332 314
333 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00236">236</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 315 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00278">278</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
334
335 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">Vamp::PluginHostAdapter::getPrograms()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
336 316
337 </div> 317 </div>
338 </div><p> 318 </div><p>
339 <a class="anchor" name="d488470c582d8472d86455889d71c5ec"></a><!-- doxytag: member="_VampPluginDescriptor::programs" ref="d488470c582d8472d86455889d71c5ec" args="" --> 319 <a class="anchor" name="d488470c582d8472d86455889d71c5ec"></a><!-- doxytag: member="_VampPluginDescriptor::programs" ref="d488470c582d8472d86455889d71c5ec" args="" -->
340 <div class="memitem"> 320 <div class="memitem">
349 329
350 <p> 330 <p>
351 Fixed names for programs. 331 Fixed names for programs.
352 <p> 332 <p>
353 333
354 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00239">239</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 334 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00281">281</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
355
356 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">Vamp::PluginHostAdapter::getCurrentProgram()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00241">Vamp::PluginHostAdapter::getPrograms()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p>
357 335
358 </div> 336 </div>
359 </div><p> 337 </div><p>
360 <a class="anchor" name="ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><!-- doxytag: member="_VampPluginDescriptor::inputDomain" ref="ffc4d1796da7ced2c0cbb2cc2c4a22f4" args="" --> 338 <a class="anchor" name="ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><!-- doxytag: member="_VampPluginDescriptor::inputDomain" ref="ffc4d1796da7ced2c0cbb2cc2c4a22f4" args="" -->
361 <div class="memitem"> 339 <div class="memitem">
370 348
371 <p> 349 <p>
372 Preferred input domain for audio input (time or frequency). 350 Preferred input domain for audio input (time or frequency).
373 <p> 351 <p>
374 352
375 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00242">242</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> 353 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00284">284</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p>
376
377 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00135">Vamp::PluginHostAdapter::getInputDomain()</a>.</p>
378 354
379 </div> 355 </div>
380 </div><p> 356 </div><p>
381 <a class="anchor" name="19c4ce36fdeb88eeedb539efc544b8ee"></a><!-- doxytag: member="_VampPluginDescriptor::instantiate" ref="19c4ce36fdeb88eeedb539efc544b8ee" args=")(const struct _VampPluginDescriptor *, float inputSampleRate)" --> 357 <a class="anchor" name="19c4ce36fdeb88eeedb539efc544b8ee"></a><!-- doxytag: member="_VampPluginDescriptor::instantiate" ref="19c4ce36fdeb88eeedb539efc544b8ee" args=")(const struct _VampPluginDescriptor *, float inputSampleRate)" -->
382 <div class="memitem"> 358 <div class="memitem">
391 367
392 <p> 368 <p>
393 Create and return a new instance of this plugin. 369 Create and return a new instance of this plugin.
394 <p> 370 <p>
395 371
396 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00043">Vamp::PluginHostAdapter::PluginHostAdapter()</a>.</p>
397
398 </div> 372 </div>
399 </div><p> 373 </div><p>
400 <a class="anchor" name="0e4522c33e59c3c518b9262f2477bc27"></a><!-- doxytag: member="_VampPluginDescriptor::cleanup" ref="0e4522c33e59c3c518b9262f2477bc27" args=")(VampPluginHandle)" --> 374 <a class="anchor" name="0e4522c33e59c3c518b9262f2477bc27"></a><!-- doxytag: member="_VampPluginDescriptor::cleanup" ref="0e4522c33e59c3c518b9262f2477bc27" args=")(VampPluginHandle)" -->
401 <div class="memitem"> 375 <div class="memitem">
402 <div class="memproto"> 376 <div class="memproto">
410 384
411 <p> 385 <p>
412 Destroy an instance of this plugin. 386 Destroy an instance of this plugin.
413 <p> 387 <p>
414 388
415 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00055">Vamp::PluginHostAdapter::~PluginHostAdapter()</a>.</p>
416
417 </div> 389 </div>
418 </div><p> 390 </div><p>
419 <a class="anchor" name="d0978f17a5e568079470a1978a9aad22"></a><!-- doxytag: member="_VampPluginDescriptor::initialise" ref="d0978f17a5e568079470a1978a9aad22" args=")(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)" --> 391 <a class="anchor" name="d0978f17a5e568079470a1978a9aad22"></a><!-- doxytag: member="_VampPluginDescriptor::initialise" ref="d0978f17a5e568079470a1978a9aad22" args=")(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)" -->
420 <div class="memitem"> 392 <div class="memitem">
421 <div class="memproto"> 393 <div class="memproto">
429 401
430 <p> 402 <p>
431 Initialise an instance following parameter configuration. 403 Initialise an instance following parameter configuration.
432 <p> 404 <p>
433 405
434 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00118">Vamp::PluginHostAdapter::initialise()</a>.</p>
435
436 </div> 406 </div>
437 </div><p> 407 </div><p>
438 <a class="anchor" name="12267f6b506aeda3792ff7c982b02336"></a><!-- doxytag: member="_VampPluginDescriptor::reset" ref="12267f6b506aeda3792ff7c982b02336" args=")(VampPluginHandle)" --> 408 <a class="anchor" name="12267f6b506aeda3792ff7c982b02336"></a><!-- doxytag: member="_VampPluginDescriptor::reset" ref="12267f6b506aeda3792ff7c982b02336" args=")(VampPluginHandle)" -->
439 <div class="memitem"> 409 <div class="memitem">
440 <div class="memproto"> 410 <div class="memproto">
448 418
449 <p> 419 <p>
450 Reset an instance, ready to use again on new input data. 420 Reset an instance, ready to use again on new input data.
451 <p> 421 <p>
452 422
453 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00128">Vamp::PluginHostAdapter::reset()</a>.</p>
454
455 </div> 423 </div>
456 </div><p> 424 </div><p>
457 <a class="anchor" name="07174981875b55ee2ec7521a7f4fc395"></a><!-- doxytag: member="_VampPluginDescriptor::getParameter" ref="07174981875b55ee2ec7521a7f4fc395" args=")(VampPluginHandle, int)" --> 425 <a class="anchor" name="07174981875b55ee2ec7521a7f4fc395"></a><!-- doxytag: member="_VampPluginDescriptor::getParameter" ref="07174981875b55ee2ec7521a7f4fc395" args=")(VampPluginHandle, int)" -->
458 <div class="memitem"> 426 <div class="memitem">
459 <div class="memproto"> 427 <div class="memproto">
467 435
468 <p> 436 <p>
469 Get a parameter value. 437 Get a parameter value.
470 <p> 438 <p>
471 439
472 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>.</p>
473
474 </div> 440 </div>
475 </div><p> 441 </div><p>
476 <a class="anchor" name="ad3cfc7a3b432df40bd9db13eee6a481"></a><!-- doxytag: member="_VampPluginDescriptor::setParameter" ref="ad3cfc7a3b432df40bd9db13eee6a481" args=")(VampPluginHandle, int, float)" --> 442 <a class="anchor" name="ad3cfc7a3b432df40bd9db13eee6a481"></a><!-- doxytag: member="_VampPluginDescriptor::setParameter" ref="ad3cfc7a3b432df40bd9db13eee6a481" args=")(VampPluginHandle, int, float)" -->
477 <div class="memitem"> 443 <div class="memitem">
478 <div class="memproto"> 444 <div class="memproto">
486 452
487 <p> 453 <p>
488 Set a parameter value. 454 Set a parameter value.
489 <p> 455 <p>
490 May only be called before initialise. 456 May only be called before initialise.
491 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>.</p>
492
493 </div> 457 </div>
494 </div><p> 458 </div><p>
495 <a class="anchor" name="861a77525a95d424cb846820b018af53"></a><!-- doxytag: member="_VampPluginDescriptor::getCurrentProgram" ref="861a77525a95d424cb846820b018af53" args=")(VampPluginHandle)" --> 459 <a class="anchor" name="861a77525a95d424cb846820b018af53"></a><!-- doxytag: member="_VampPluginDescriptor::getCurrentProgram" ref="861a77525a95d424cb846820b018af53" args=")(VampPluginHandle)" -->
496 <div class="memitem"> 460 <div class="memitem">
497 <div class="memproto"> 461 <div class="memproto">
505 469
506 <p> 470 <p>
507 Get the current program (if programCount &gt; 0). 471 Get the current program (if programCount &gt; 0).
508 <p> 472 <p>
509 473
510 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00253">Vamp::PluginHostAdapter::getCurrentProgram()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>.</p>
511
512 </div> 474 </div>
513 </div><p> 475 </div><p>
514 <a class="anchor" name="d9af40cb165ca187e49250964af5f5cf"></a><!-- doxytag: member="_VampPluginDescriptor::selectProgram" ref="d9af40cb165ca187e49250964af5f5cf" args=")(VampPluginHandle, unsigned int)" --> 476 <a class="anchor" name="d9af40cb165ca187e49250964af5f5cf"></a><!-- doxytag: member="_VampPluginDescriptor::selectProgram" ref="d9af40cb165ca187e49250964af5f5cf" args=")(VampPluginHandle, unsigned int)" -->
515 <div class="memitem"> 477 <div class="memitem">
516 <div class="memproto"> 478 <div class="memproto">
524 486
525 <p> 487 <p>
526 Set the current program. 488 Set the current program.
527 <p> 489 <p>
528 May only be called before initialise. 490 May only be called before initialise.
529 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00262">Vamp::PluginHostAdapter::selectProgram()</a>.</p>
530
531 </div> 491 </div>
532 </div><p> 492 </div><p>
533 <a class="anchor" name="2beddf2ce156c05dd24477ac663adcbb"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredStepSize" ref="2beddf2ce156c05dd24477ac663adcbb" args=")(VampPluginHandle)" --> 493 <a class="anchor" name="2beddf2ce156c05dd24477ac663adcbb"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredStepSize" ref="2beddf2ce156c05dd24477ac663adcbb" args=")(VampPluginHandle)" -->
534 <div class="memitem"> 494 <div class="memitem">
535 <div class="memproto"> 495 <div class="memproto">
543 503
544 <p> 504 <p>
545 Get the plugin's preferred processing window increment in samples. 505 Get the plugin's preferred processing window increment in samples.
546 <p> 506 <p>
547 507
548 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00275">Vamp::PluginHostAdapter::getPreferredStepSize()</a>.</p>
549
550 </div> 508 </div>
551 </div><p> 509 </div><p>
552 <a class="anchor" name="c626e42554ab1532c8d8b5132a0faee8"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredBlockSize" ref="c626e42554ab1532c8d8b5132a0faee8" args=")(VampPluginHandle)" --> 510 <a class="anchor" name="c626e42554ab1532c8d8b5132a0faee8"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredBlockSize" ref="c626e42554ab1532c8d8b5132a0faee8" args=")(VampPluginHandle)" -->
553 <div class="memitem"> 511 <div class="memitem">
554 <div class="memproto"> 512 <div class="memproto">
562 520
563 <p> 521 <p>
564 Get the plugin's preferred processing window size in samples. 522 Get the plugin's preferred processing window size in samples.
565 <p> 523 <p>
566 524
567 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00282">Vamp::PluginHostAdapter::getPreferredBlockSize()</a>.</p>
568
569 </div> 525 </div>
570 </div><p> 526 </div><p>
571 <a class="anchor" name="f175ca17716db5a7545b61b01caabd92"></a><!-- doxytag: member="_VampPluginDescriptor::getMinChannelCount" ref="f175ca17716db5a7545b61b01caabd92" args=")(VampPluginHandle)" --> 527 <a class="anchor" name="f175ca17716db5a7545b61b01caabd92"></a><!-- doxytag: member="_VampPluginDescriptor::getMinChannelCount" ref="f175ca17716db5a7545b61b01caabd92" args=")(VampPluginHandle)" -->
572 <div class="memitem"> 528 <div class="memitem">
573 <div class="memproto"> 529 <div class="memproto">
581 537
582 <p> 538 <p>
583 Get the minimum number of input channels this plugin can handle. 539 Get the minimum number of input channels this plugin can handle.
584 <p> 540 <p>
585 541
586 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00289">Vamp::PluginHostAdapter::getMinChannelCount()</a>.</p>
587
588 </div> 542 </div>
589 </div><p> 543 </div><p>
590 <a class="anchor" name="d1600203418d9646332f5b917284261b"></a><!-- doxytag: member="_VampPluginDescriptor::getMaxChannelCount" ref="d1600203418d9646332f5b917284261b" args=")(VampPluginHandle)" --> 544 <a class="anchor" name="d1600203418d9646332f5b917284261b"></a><!-- doxytag: member="_VampPluginDescriptor::getMaxChannelCount" ref="d1600203418d9646332f5b917284261b" args=")(VampPluginHandle)" -->
591 <div class="memitem"> 545 <div class="memitem">
592 <div class="memproto"> 546 <div class="memproto">
600 554
601 <p> 555 <p>
602 Get the maximum number of input channels this plugin can handle. 556 Get the maximum number of input channels this plugin can handle.
603 <p> 557 <p>
604 558
605 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00296">Vamp::PluginHostAdapter::getMaxChannelCount()</a>.</p>
606
607 </div> 559 </div>
608 </div><p> 560 </div><p>
609 <a class="anchor" name="a8fc88da704e24b2b5f674821dd380c1"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputCount" ref="a8fc88da704e24b2b5f674821dd380c1" args=")(VampPluginHandle)" --> 561 <a class="anchor" name="a8fc88da704e24b2b5f674821dd380c1"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputCount" ref="a8fc88da704e24b2b5f674821dd380c1" args=")(VampPluginHandle)" -->
610 <div class="memitem"> 562 <div class="memitem">
611 <div class="memproto"> 563 <div class="memproto">
619 571
620 <p> 572 <p>
621 Get the number of feature outputs (distinct sets of results). 573 Get the number of feature outputs (distinct sets of results).
622 <p> 574 <p>
623 575
624 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
625
626 </div> 576 </div>
627 </div><p> 577 </div><p>
628 <a class="anchor" name="92c58b8ff99ad0c23a42333aa55c144d"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputDescriptor" ref="92c58b8ff99ad0c23a42333aa55c144d" args=")(VampPluginHandle, unsigned int)" --> 578 <a class="anchor" name="92c58b8ff99ad0c23a42333aa55c144d"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputDescriptor" ref="92c58b8ff99ad0c23a42333aa55c144d" args=")(VampPluginHandle, unsigned int)" -->
629 <div class="memitem"> 579 <div class="memitem">
630 <div class="memproto"> 580 <div class="memproto">
638 588
639 <p> 589 <p>
640 Get a descriptor for a given feature output. 590 Get a descriptor for a given feature output.
641 <p> 591 <p>
642 Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use. 592 Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use.
643 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
644
645 </div> 593 </div>
646 </div><p> 594 </div><p>
647 <a class="anchor" name="8cc38edc921616e67e551aa03397ec79"></a><!-- doxytag: member="_VampPluginDescriptor::releaseOutputDescriptor" ref="8cc38edc921616e67e551aa03397ec79" args=")(VampOutputDescriptor *)" --> 595 <a class="anchor" name="8cc38edc921616e67e551aa03397ec79"></a><!-- doxytag: member="_VampPluginDescriptor::releaseOutputDescriptor" ref="8cc38edc921616e67e551aa03397ec79" args=")(VampOutputDescriptor *)" -->
648 <div class="memitem"> 596 <div class="memitem">
649 <div class="memproto"> 597 <div class="memproto">
657 605
658 <p> 606 <p>
659 Destroy a descriptor for a feature output. 607 Destroy a descriptor for a feature output.
660 <p> 608 <p>
661 609
662 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
663
664 </div> 610 </div>
665 </div><p> 611 </div><p>
666 <a class="anchor" name="c5a0a75b6e68b22fed536765d1f2f254"></a><!-- doxytag: member="_VampPluginDescriptor::process" ref="c5a0a75b6e68b22fed536765d1f2f254" args=")(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec)" --> 612 <a class="anchor" name="c5a0a75b6e68b22fed536765d1f2f254"></a><!-- doxytag: member="_VampPluginDescriptor::process" ref="c5a0a75b6e68b22fed536765d1f2f254" args=")(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec)" -->
667 <div class="memitem"> 613 <div class="memitem">
668 <div class="memproto"> 614 <div class="memproto">
676 622
677 <p> 623 <p>
678 Process an input block and return a set of features. 624 Process an input block and return a set of features.
679 <p> 625 <p>
680 Returned pointer is valid only until next call to process, getRemainingFeatures, or cleanup for this handle, or releaseFeatureSet for this feature set. Host must call releaseFeatureSet after use. 626 Returned pointer is valid only until next call to process, getRemainingFeatures, or cleanup for this handle, or releaseFeatureSet for this feature set. Host must call releaseFeatureSet after use.
681 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">Vamp::PluginHostAdapter::process()</a>.</p>
682
683 </div> 627 </div>
684 </div><p> 628 </div><p>
685 <a class="anchor" name="d22c666188aadab83c354a0edb18fcf0"></a><!-- doxytag: member="_VampPluginDescriptor::getRemainingFeatures" ref="d22c666188aadab83c354a0edb18fcf0" args=")(VampPluginHandle)" --> 629 <a class="anchor" name="d22c666188aadab83c354a0edb18fcf0"></a><!-- doxytag: member="_VampPluginDescriptor::getRemainingFeatures" ref="d22c666188aadab83c354a0edb18fcf0" args=")(VampPluginHandle)" -->
686 <div class="memitem"> 630 <div class="memitem">
687 <div class="memproto"> 631 <div class="memproto">
695 639
696 <p> 640 <p>
697 Return any remaining features at the end of processing. 641 Return any remaining features at the end of processing.
698 <p> 642 <p>
699 643
700 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">Vamp::PluginHostAdapter::getRemainingFeatures()</a>.</p>
701
702 </div> 644 </div>
703 </div><p> 645 </div><p>
704 <a class="anchor" name="c4bafe8ad2734d21a433d745b18e7d63"></a><!-- doxytag: member="_VampPluginDescriptor::releaseFeatureSet" ref="c4bafe8ad2734d21a433d745b18e7d63" args=")(VampFeatureList *)" --> 646 <a class="anchor" name="c4bafe8ad2734d21a433d745b18e7d63"></a><!-- doxytag: member="_VampPluginDescriptor::releaseFeatureSet" ref="c4bafe8ad2734d21a433d745b18e7d63" args=")(VampFeatureList *)" -->
705 <div class="memitem"> 647 <div class="memitem">
706 <div class="memproto"> 648 <div class="memproto">
713 <div class="memdoc"> 655 <div class="memdoc">
714 656
715 <p> 657 <p>
716 Release a feature set returned from process or getRemainingFeatures. 658 Release a feature set returned from process or getRemainingFeatures.
717 <p> 659 <p>
718
719 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00372">Vamp::PluginHostAdapter::getRemainingFeatures()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00353">Vamp::PluginHostAdapter::process()</a>.</p>
720 660
721 </div> 661 </div>
722 </div><p> 662 </div><p>
723 <hr>The documentation for this struct was generated from the following file:<ul> 663 <hr>The documentation for this struct was generated from the following file:<ul>
724 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul> 664 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul>
725 </div> 665 </div>
726 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by&nbsp; 666 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:19 2008 for VampPluginSDK by&nbsp;
727 <a href="http://www.doxygen.org/index.html"> 667 <a href="http://www.doxygen.org/index.html">
728 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 668 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
729 </body> 669 </body>
730 </html> 670 </html>