Mercurial > hg > vamp-docs
view code-docs/struct__VampPluginDescriptor.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
| author | Chris Cannam |
|---|---|
| date | Fri, 13 Jul 2012 13:30:27 +0100 |
| parents | 3c430ef1ed66 |
| children | 27319718b1f8 |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>VampPluginSDK: _VampPluginDescriptor Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.4</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.8.0 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('struct__VampPluginDescriptor.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">_VampPluginDescriptor Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="vamp_8h_source.html">vamp.h</a>></code></p> <p><a href="struct__VampPluginDescriptor-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr class="memitem:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ab6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr> <tr class="memdesc:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="mdescLeft"> </td><td class="mdescRight">API version with which this descriptor is compatible. <a href="#ab6c87760e87ddaa9ac3491bccaaa28c2"></a><br/></td></tr> <tr class="memitem:a4915ec8276749cb505c01d25a6d02219"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4915ec8276749cb505c01d25a6d02219">identifier</a></td></tr> <tr class="memdesc:a4915ec8276749cb505c01d25a6d02219"><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the plugin. <a href="#a4915ec8276749cb505c01d25a6d02219"></a><br/></td></tr> <tr class="memitem:a9dd5a0190e4d453ff36b5acb7000b150"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9dd5a0190e4d453ff36b5acb7000b150">name</a></td></tr> <tr class="memdesc:a9dd5a0190e4d453ff36b5acb7000b150"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the plugin. <a href="#a9dd5a0190e4d453ff36b5acb7000b150"></a><br/></td></tr> <tr class="memitem:a9ff8050f92f1a04a68bb34a9d368295e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9ff8050f92f1a04a68bb34a9d368295e">description</a></td></tr> <tr class="memdesc:a9ff8050f92f1a04a68bb34a9d368295e"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the plugin. <a href="#a9ff8050f92f1a04a68bb34a9d368295e"></a><br/></td></tr> <tr class="memitem:a4dca3d57331802964716edfa80580c9b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4dca3d57331802964716edfa80580c9b">maker</a></td></tr> <tr class="memdesc:a4dca3d57331802964716edfa80580c9b"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of plugin's author or vendor. <a href="#a4dca3d57331802964716edfa80580c9b"></a><br/></td></tr> <tr class="memitem:a04427c420d9252c7796c0bf5101345ae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a04427c420d9252c7796c0bf5101345ae">pluginVersion</a></td></tr> <tr class="memdesc:a04427c420d9252c7796c0bf5101345ae"><td class="mdescLeft"> </td><td class="mdescRight">Version number of the plugin. <a href="#a04427c420d9252c7796c0bf5101345ae"></a><br/></td></tr> <tr class="memitem:ae704bba384af0de056a26da1b13ee521"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae704bba384af0de056a26da1b13ee521">copyright</a></td></tr> <tr class="memdesc:ae704bba384af0de056a26da1b13ee521"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable summary of copyright or licensing for plugin. <a href="#ae704bba384af0de056a26da1b13ee521"></a><br/></td></tr> <tr class="memitem:ae6271dc3ea0cea959c84a64185492cab"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae6271dc3ea0cea959c84a64185492cab">parameterCount</a></td></tr> <tr class="memdesc:ae6271dc3ea0cea959c84a64185492cab"><td class="mdescLeft"> </td><td class="mdescRight">Number of parameter inputs. <a href="#ae6271dc3ea0cea959c84a64185492cab"></a><br/></td></tr> <tr class="memitem:a64d614862604c31d6b84c49005f51913"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a64d614862604c31d6b84c49005f51913">parameters</a></td></tr> <tr class="memdesc:a64d614862604c31d6b84c49005f51913"><td class="mdescLeft"> </td><td class="mdescRight">Fixed descriptors for parameter inputs. <a href="#a64d614862604c31d6b84c49005f51913"></a><br/></td></tr> <tr class="memitem:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a1962666aa173e7a9a2c30dc82e4b2e00">programCount</a></td></tr> <tr class="memdesc:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="mdescLeft"> </td><td class="mdescRight">Number of programs. <a href="#a1962666aa173e7a9a2c30dc82e4b2e00"></a><br/></td></tr> <tr class="memitem:ad488470c582d8472d86455889d71c5ec"><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad488470c582d8472d86455889d71c5ec">programs</a></td></tr> <tr class="memdesc:ad488470c582d8472d86455889d71c5ec"><td class="mdescLeft"> </td><td class="mdescRight">Fixed names for programs. <a href="#ad488470c582d8472d86455889d71c5ec"></a><br/></td></tr> <tr class="memitem:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#affc4d1796da7ced2c0cbb2cc2c4a22f4">inputDomain</a></td></tr> <tr class="memdesc:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="mdescLeft"> </td><td class="mdescRight">Preferred input domain for audio input (time or frequency). <a href="#affc4d1796da7ced2c0cbb2cc2c4a22f4"></a><br/></td></tr> <tr class="memitem:a19c4ce36fdeb88eeedb539efc544b8ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a19c4ce36fdeb88eeedb539efc544b8ee">instantiate</a> )(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td></tr> <tr class="memdesc:a19c4ce36fdeb88eeedb539efc544b8ee"><td class="mdescLeft"> </td><td class="mdescRight">Create and return a new instance of this plugin. <a href="#a19c4ce36fdeb88eeedb539efc544b8ee"></a><br/></td></tr> <tr class="memitem:a0e4522c33e59c3c518b9262f2477bc27"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a0e4522c33e59c3c518b9262f2477bc27">cleanup</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:a0e4522c33e59c3c518b9262f2477bc27"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an instance of this plugin. <a href="#a0e4522c33e59c3c518b9262f2477bc27"></a><br/></td></tr> <tr class="memitem:ad0978f17a5e568079470a1978a9aad22"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad0978f17a5e568079470a1978a9aad22">initialise</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td></tr> <tr class="memdesc:ad0978f17a5e568079470a1978a9aad22"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an instance following parameter configuration. <a href="#ad0978f17a5e568079470a1978a9aad22"></a><br/></td></tr> <tr class="memitem:a12267f6b506aeda3792ff7c982b02336"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a12267f6b506aeda3792ff7c982b02336">reset</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:a12267f6b506aeda3792ff7c982b02336"><td class="mdescLeft"> </td><td class="mdescRight">Reset an instance, ready to use again on new input data. <a href="#a12267f6b506aeda3792ff7c982b02336"></a><br/></td></tr> <tr class="memitem:a07174981875b55ee2ec7521a7f4fc395"><td class="memItemLeft" align="right" valign="top">float(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a07174981875b55ee2ec7521a7f4fc395">getParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td></tr> <tr class="memdesc:a07174981875b55ee2ec7521a7f4fc395"><td class="mdescLeft"> </td><td class="mdescRight">Get a parameter value. <a href="#a07174981875b55ee2ec7521a7f4fc395"></a><br/></td></tr> <tr class="memitem:aad3cfc7a3b432df40bd9db13eee6a481"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aad3cfc7a3b432df40bd9db13eee6a481">setParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td></tr> <tr class="memdesc:aad3cfc7a3b432df40bd9db13eee6a481"><td class="mdescLeft"> </td><td class="mdescRight">Set a parameter value. <a href="#aad3cfc7a3b432df40bd9db13eee6a481"></a><br/></td></tr> <tr class="memitem:a861a77525a95d424cb846820b018af53"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a861a77525a95d424cb846820b018af53">getCurrentProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:a861a77525a95d424cb846820b018af53"><td class="mdescLeft"> </td><td class="mdescRight">Get the current program (if programCount > 0). <a href="#a861a77525a95d424cb846820b018af53"></a><br/></td></tr> <tr class="memitem:ad9af40cb165ca187e49250964af5f5cf"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad9af40cb165ca187e49250964af5f5cf">selectProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr> <tr class="memdesc:ad9af40cb165ca187e49250964af5f5cf"><td class="mdescLeft"> </td><td class="mdescRight">Set the current program. <a href="#ad9af40cb165ca187e49250964af5f5cf"></a><br/></td></tr> <tr class="memitem:a2beddf2ce156c05dd24477ac663adcbb"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a2beddf2ce156c05dd24477ac663adcbb">getPreferredStepSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:a2beddf2ce156c05dd24477ac663adcbb"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's preferred processing window increment in samples. <a href="#a2beddf2ce156c05dd24477ac663adcbb"></a><br/></td></tr> <tr class="memitem:ac626e42554ab1532c8d8b5132a0faee8"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac626e42554ab1532c8d8b5132a0faee8">getPreferredBlockSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:ac626e42554ab1532c8d8b5132a0faee8"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's preferred processing window size in samples. <a href="#ac626e42554ab1532c8d8b5132a0faee8"></a><br/></td></tr> <tr class="memitem:af175ca17716db5a7545b61b01caabd92"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#af175ca17716db5a7545b61b01caabd92">getMinChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:af175ca17716db5a7545b61b01caabd92"><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum number of input channels this plugin can handle. <a href="#af175ca17716db5a7545b61b01caabd92"></a><br/></td></tr> <tr class="memitem:ad1600203418d9646332f5b917284261b"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad1600203418d9646332f5b917284261b">getMaxChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:ad1600203418d9646332f5b917284261b"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum number of input channels this plugin can handle. <a href="#ad1600203418d9646332f5b917284261b"></a><br/></td></tr> <tr class="memitem:aa8fc88da704e24b2b5f674821dd380c1"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aa8fc88da704e24b2b5f674821dd380c1">getOutputCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:aa8fc88da704e24b2b5f674821dd380c1"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of feature outputs (distinct sets of results). <a href="#aa8fc88da704e24b2b5f674821dd380c1"></a><br/></td></tr> <tr class="memitem:a92c58b8ff99ad0c23a42333aa55c144d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a92c58b8ff99ad0c23a42333aa55c144d">getOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr> <tr class="memdesc:a92c58b8ff99ad0c23a42333aa55c144d"><td class="mdescLeft"> </td><td class="mdescRight">Get a descriptor for a given feature output. <a href="#a92c58b8ff99ad0c23a42333aa55c144d"></a><br/></td></tr> <tr class="memitem:a8cc38edc921616e67e551aa03397ec79"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a8cc38edc921616e67e551aa03397ec79">releaseOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td></tr> <tr class="memdesc:a8cc38edc921616e67e551aa03397ec79"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a descriptor for a feature output. <a href="#a8cc38edc921616e67e551aa03397ec79"></a><br/></td></tr> <tr class="memitem:ac5a0a75b6e68b22fed536765d1f2f254"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac5a0a75b6e68b22fed536765d1f2f254">process</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td></tr> <tr class="memdesc:ac5a0a75b6e68b22fed536765d1f2f254"><td class="mdescLeft"> </td><td class="mdescRight">Process an input block and return a set of features. <a href="#ac5a0a75b6e68b22fed536765d1f2f254"></a><br/></td></tr> <tr class="memitem:ad22c666188aadab83c354a0edb18fcf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad22c666188aadab83c354a0edb18fcf0">getRemainingFeatures</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr> <tr class="memdesc:ad22c666188aadab83c354a0edb18fcf0"><td class="mdescLeft"> </td><td class="mdescRight">Return any remaining features at the end of processing. <a href="#ad22c666188aadab83c354a0edb18fcf0"></a><br/></td></tr> <tr class="memitem:ac4bafe8ad2734d21a433d745b18e7d63"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac4bafe8ad2734d21a433d745b18e7d63">releaseFeatureSet</a> )(<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td></tr> <tr class="memdesc:ac4bafe8ad2734d21a433d745b18e7d63"><td class="mdescLeft"> </td><td class="mdescRight">Release a feature set returned from process or getRemainingFeatures. <a href="#ac4bafe8ad2734d21a433d745b18e7d63"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"> <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> </div><hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ab6c87760e87ddaa9ac3491bccaaa28c2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#ab6c87760e87ddaa9ac3491bccaaa28c2">_VampPluginDescriptor::vampApiVersion</a></td> </tr> </table> </div> <div class="memdoc"> <p>API version with which this descriptor is compatible. </p> <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> </div> </div> <a class="anchor" id="a4915ec8276749cb505c01d25a6d02219"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a4915ec8276749cb505c01d25a6d02219">_VampPluginDescriptor::identifier</a></td> </tr> </table> </div> <div class="memdoc"> <p>Computer-usable name of the plugin. </p> <p>Must not change. [a-zA-Z0-9_] </p> <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> </div> </div> <a class="anchor" id="a9dd5a0190e4d453ff36b5acb7000b150"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a9dd5a0190e4d453ff36b5acb7000b150">_VampPluginDescriptor::name</a></td> </tr> </table> </div> <div class="memdoc"> <p>Human-readable name of the plugin. </p> <p>May be translatable. </p> <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> </div> </div> <a class="anchor" id="a9ff8050f92f1a04a68bb34a9d368295e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a9ff8050f92f1a04a68bb34a9d368295e">_VampPluginDescriptor::description</a></td> </tr> </table> </div> <div class="memdoc"> <p>Human-readable short text about the plugin. </p> <p>May be translatable. </p> <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> </div> </div> <a class="anchor" id="a4dca3d57331802964716edfa80580c9b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a4dca3d57331802964716edfa80580c9b">_VampPluginDescriptor::maker</a></td> </tr> </table> </div> <div class="memdoc"> <p>Human-readable name of plugin's author or vendor. </p> <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> </div> </div> <a class="anchor" id="a04427c420d9252c7796c0bf5101345ae"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="struct__VampPluginDescriptor.html#a04427c420d9252c7796c0bf5101345ae">_VampPluginDescriptor::pluginVersion</a></td> </tr> </table> </div> <div class="memdoc"> <p>Version number of the plugin. </p> <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> </div> </div> <a class="anchor" id="ae704bba384af0de056a26da1b13ee521"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#ae704bba384af0de056a26da1b13ee521">_VampPluginDescriptor::copyright</a></td> </tr> </table> </div> <div class="memdoc"> <p>Human-readable summary of copyright or licensing for plugin. </p> <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> </div> </div> <a class="anchor" id="ae6271dc3ea0cea959c84a64185492cab"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#ae6271dc3ea0cea959c84a64185492cab">_VampPluginDescriptor::parameterCount</a></td> </tr> </table> </div> <div class="memdoc"> <p>Number of parameter inputs. </p> <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> </div> </div> <a class="anchor" id="a64d614862604c31d6b84c49005f51913"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a>** <a class="el" href="struct__VampPluginDescriptor.html#a64d614862604c31d6b84c49005f51913">_VampPluginDescriptor::parameters</a></td> </tr> </table> </div> <div class="memdoc"> <p>Fixed descriptors for parameter inputs. </p> <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> </div> </div> <a class="anchor" id="a1962666aa173e7a9a2c30dc82e4b2e00"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#a1962666aa173e7a9a2c30dc82e4b2e00">_VampPluginDescriptor::programCount</a></td> </tr> </table> </div> <div class="memdoc"> <p>Number of programs. </p> <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> </div> </div> <a class="anchor" id="ad488470c582d8472d86455889d71c5ec"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char** <a class="el" href="struct__VampPluginDescriptor.html#ad488470c582d8472d86455889d71c5ec">_VampPluginDescriptor::programs</a></td> </tr> </table> </div> <div class="memdoc"> <p>Fixed names for programs. </p> <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> </div> </div> <a class="anchor" id="affc4d1796da7ced2c0cbb2cc2c4a22f4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="el" href="struct__VampPluginDescriptor.html#affc4d1796da7ced2c0cbb2cc2c4a22f4">_VampPluginDescriptor::inputDomain</a></td> </tr> </table> </div> <div class="memdoc"> <p>Preferred input domain for audio input (time or frequency). </p> <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> </div> </div> <a class="anchor" id="a19c4ce36fdeb88eeedb539efc544b8ee"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* <a class="el" href="struct__VampPluginDescriptor.html#a19c4ce36fdeb88eeedb539efc544b8ee">_VampPluginDescriptor::instantiate</a>)(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td> </tr> </table> </div> <div class="memdoc"> <p>Create and return a new instance of this plugin. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00287">287</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a0e4522c33e59c3c518b9262f2477bc27"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a0e4522c33e59c3c518b9262f2477bc27">_VampPluginDescriptor::cleanup</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Destroy an instance of this plugin. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00291">291</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ad0978f17a5e568079470a1978a9aad22"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int(* <a class="el" href="struct__VampPluginDescriptor.html#ad0978f17a5e568079470a1978a9aad22">_VampPluginDescriptor::initialise</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td> </tr> </table> </div> <div class="memdoc"> <p>Initialise an instance following parameter configuration. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00294">294</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a12267f6b506aeda3792ff7c982b02336"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a12267f6b506aeda3792ff7c982b02336">_VampPluginDescriptor::reset</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Reset an instance, ready to use again on new input data. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00300">300</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a07174981875b55ee2ec7521a7f4fc395"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float(* <a class="el" href="struct__VampPluginDescriptor.html#a07174981875b55ee2ec7521a7f4fc395">_VampPluginDescriptor::getParameter</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td> </tr> </table> </div> <div class="memdoc"> <p>Get a parameter value. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00303">303</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="aad3cfc7a3b432df40bd9db13eee6a481"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#aad3cfc7a3b432df40bd9db13eee6a481">_VampPluginDescriptor::setParameter</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td> </tr> </table> </div> <div class="memdoc"> <p>Set a parameter value. </p> <p>May only be called before initialise. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00306">306</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a861a77525a95d424cb846820b018af53"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a861a77525a95d424cb846820b018af53">_VampPluginDescriptor::getCurrentProgram</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the current program (if programCount > 0). </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00309">309</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ad9af40cb165ca187e49250964af5f5cf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ad9af40cb165ca187e49250964af5f5cf">_VampPluginDescriptor::selectProgram</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td> </tr> </table> </div> <div class="memdoc"> <p>Set the current program. </p> <p>May only be called before initialise. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00312">312</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a2beddf2ce156c05dd24477ac663adcbb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a2beddf2ce156c05dd24477ac663adcbb">_VampPluginDescriptor::getPreferredStepSize</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the plugin's preferred processing window increment in samples. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00315">315</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ac626e42554ab1532c8d8b5132a0faee8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#ac626e42554ab1532c8d8b5132a0faee8">_VampPluginDescriptor::getPreferredBlockSize</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the plugin's preferred processing window size in samples. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00318">318</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="af175ca17716db5a7545b61b01caabd92"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#af175ca17716db5a7545b61b01caabd92">_VampPluginDescriptor::getMinChannelCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the minimum number of input channels this plugin can handle. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00321">321</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ad1600203418d9646332f5b917284261b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#ad1600203418d9646332f5b917284261b">_VampPluginDescriptor::getMaxChannelCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the maximum number of input channels this plugin can handle. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00324">324</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="aa8fc88da704e24b2b5f674821dd380c1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#aa8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Get the number of feature outputs (distinct sets of results). </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00327">327</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a92c58b8ff99ad0c23a42333aa55c144d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#a92c58b8ff99ad0c23a42333aa55c144d">_VampPluginDescriptor::getOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td> </tr> </table> </div> <div class="memdoc"> <p>Get a descriptor for a given feature output. </p> <p>Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00333">333</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="a8cc38edc921616e67e551aa03397ec79"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a8cc38edc921616e67e551aa03397ec79">_VampPluginDescriptor::releaseOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td> </tr> </table> </div> <div class="memdoc"> <p>Destroy a descriptor for a feature output. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00337">337</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ac5a0a75b6e68b22fed536765d1f2f254"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#ac5a0a75b6e68b22fed536765d1f2f254">_VampPluginDescriptor::process</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td> </tr> </table> </div> <div class="memdoc"> <p>Process an input block and return a set of features. </p> <p>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. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00344">344</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ad22c666188aadab83c354a0edb18fcf0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#ad22c666188aadab83c354a0edb18fcf0">_VampPluginDescriptor::getRemainingFeatures</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td> </tr> </table> </div> <div class="memdoc"> <p>Return any remaining features at the end of processing. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00350">350</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <a class="anchor" id="ac4bafe8ad2734d21a433d745b18e7d63"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ac4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>)(<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td> </tr> </table> </div> <div class="memdoc"> <p>Release a feature set returned from process or getRemainingFeatures. </p> <p>Definition at line <a class="el" href="vamp_8h_source.html#l00353">353</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li> </ul> </div><!-- contents --> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> </li> <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div> </body> </html>