Mercurial > hg > vamp-website

annotate code-doc/struct__VampPluginDescriptor.html @ 38:01e83b3b256b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* link to new build for os/x (first build had only ppc binaries of executables)
author cannam
date Mon, 12 Oct 2009 13:30:40 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: _VampPluginDescriptor Struct Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 </div>
cannam@0 26 <div class="contents">
cannam@0 27 <h1>_VampPluginDescriptor Struct Reference</h1><!-- doxytag: class="_VampPluginDescriptor" --><code>#include &lt;<a class="el" href="vamp_8h-source.html">vamp.h</a>&gt;</code>
cannam@0 28 <p>
cannam@0 29
cannam@0 30 <p>
cannam@35 31 <a href="struct__VampPluginDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 32 <tr><td></td></tr>
cannam@0 33 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@0 34 <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>
cannam@0 35
cannam@0 36 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">API version with which this descriptor is compatible. <a href="#b6c87760e87ddaa9ac3491bccaaa28c2"></a><br></td></tr>
cannam@0 37 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">identifier</a></td></tr>
cannam@0 38
cannam@0 39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer-usable name of the plugin. <a href="#4915ec8276749cb505c01d25a6d02219"></a><br></td></tr>
cannam@0 40 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">name</a></td></tr>
cannam@0 41
cannam@0 42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable name of the plugin. <a href="#9dd5a0190e4d453ff36b5acb7000b150"></a><br></td></tr>
cannam@0 43 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">description</a></td></tr>
cannam@0 44
cannam@0 45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable short text about the plugin. <a href="#9ff8050f92f1a04a68bb34a9d368295e"></a><br></td></tr>
cannam@0 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">maker</a></td></tr>
cannam@0 47
cannam@0 48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable name of plugin's author or vendor. <a href="#4dca3d57331802964716edfa80580c9b"></a><br></td></tr>
cannam@0 49 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">pluginVersion</a></td></tr>
cannam@0 50
cannam@0 51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Version number of the plugin. <a href="#04427c420d9252c7796c0bf5101345ae"></a><br></td></tr>
cannam@0 52 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">copyright</a></td></tr>
cannam@0 53
cannam@0 54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable summary of copyright or licensing for plugin. <a href="#e704bba384af0de056a26da1b13ee521"></a><br></td></tr>
cannam@0 55 <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#e6271dc3ea0cea959c84a64185492cab">parameterCount</a></td></tr>
cannam@0 56
cannam@0 57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of parameter inputs. <a href="#e6271dc3ea0cea959c84a64185492cab"></a><br></td></tr>
cannam@0 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampParameterDescriptor.html">VampParameterDescriptor</a> **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">parameters</a></td></tr>
cannam@0 59
cannam@0 60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fixed descriptors for parameter inputs. <a href="#64d614862604c31d6b84c49005f51913"></a><br></td></tr>
cannam@0 61 <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#1962666aa173e7a9a2c30dc82e4b2e00">programCount</a></td></tr>
cannam@0 62
cannam@0 63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of programs. <a href="#1962666aa173e7a9a2c30dc82e4b2e00"></a><br></td></tr>
cannam@0 64 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">programs</a></td></tr>
cannam@0 65
cannam@0 66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fixed names for programs. <a href="#d488470c582d8472d86455889d71c5ec"></a><br></td></tr>
cannam@0 67 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">inputDomain</a></td></tr>
cannam@0 68
cannam@0 69 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Preferred input domain for audio input (time or frequency). <a href="#ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><br></td></tr>
cannam@0 70 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee">instantiate</a> )(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td></tr>
cannam@0 71
cannam@0 72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create and return a new instance of this plugin. <a href="#19c4ce36fdeb88eeedb539efc544b8ee"></a><br></td></tr>
cannam@0 73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27">cleanup</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 74
cannam@0 75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy an instance of this plugin. <a href="#0e4522c33e59c3c518b9262f2477bc27"></a><br></td></tr>
cannam@0 76 <tr><td class="memItemLeft" nowrap align="right" valign="top">int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22">initialise</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td></tr>
cannam@0 77
cannam@0 78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise an instance following parameter configuration. <a href="#d0978f17a5e568079470a1978a9aad22"></a><br></td></tr>
cannam@0 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336">reset</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 80
cannam@0 81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset an instance, ready to use again on new input data. <a href="#12267f6b506aeda3792ff7c982b02336"></a><br></td></tr>
cannam@0 82 <tr><td class="memItemLeft" nowrap align="right" valign="top">float(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395">getParameter</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td></tr>
cannam@0 83
cannam@0 84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a parameter value. <a href="#07174981875b55ee2ec7521a7f4fc395"></a><br></td></tr>
cannam@0 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481">setParameter</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td></tr>
cannam@0 86
cannam@0 87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a parameter value. <a href="#ad3cfc7a3b432df40bd9db13eee6a481"></a><br></td></tr>
cannam@0 88 <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#861a77525a95d424cb846820b018af53">getCurrentProgram</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 89
cannam@0 90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program (if programCount &gt; 0). <a href="#861a77525a95d424cb846820b018af53"></a><br></td></tr>
cannam@0 91 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf">selectProgram</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
cannam@0 92
cannam@0 93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the current program. <a href="#d9af40cb165ca187e49250964af5f5cf"></a><br></td></tr>
cannam@0 94 <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#2beddf2ce156c05dd24477ac663adcbb">getPreferredStepSize</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 95
cannam@0 96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's preferred processing window increment in samples. <a href="#2beddf2ce156c05dd24477ac663adcbb"></a><br></td></tr>
cannam@0 97 <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#c626e42554ab1532c8d8b5132a0faee8">getPreferredBlockSize</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 98
cannam@0 99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's preferred processing window size in samples. <a href="#c626e42554ab1532c8d8b5132a0faee8"></a><br></td></tr>
cannam@0 100 <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#f175ca17716db5a7545b61b01caabd92">getMinChannelCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 101
cannam@0 102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum number of input channels this plugin can handle. <a href="#f175ca17716db5a7545b61b01caabd92"></a><br></td></tr>
cannam@0 103 <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#d1600203418d9646332f5b917284261b">getMaxChannelCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 104
cannam@0 105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum number of input channels this plugin can handle. <a href="#d1600203418d9646332f5b917284261b"></a><br></td></tr>
cannam@0 106 <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#a8fc88da704e24b2b5f674821dd380c1">getOutputCount</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 107
cannam@0 108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of feature outputs (distinct sets of results). <a href="#a8fc88da704e24b2b5f674821dd380c1"></a><br></td></tr>
cannam@0 109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#92c58b8ff99ad0c23a42333aa55c144d">getOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
cannam@0 110
cannam@0 111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a descriptor for a given feature output. <a href="#92c58b8ff99ad0c23a42333aa55c144d"></a><br></td></tr>
cannam@0 112 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79">releaseOutputDescriptor</a> )(<a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *)</td></tr>
cannam@0 113
cannam@0 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a descriptor for a feature output. <a href="#8cc38edc921616e67e551aa03397ec79"></a><br></td></tr>
cannam@0 115 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#c5a0a75b6e68b22fed536765d1f2f254">process</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td></tr>
cannam@0 116
cannam@0 117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process an input block and return a set of features. <a href="#c5a0a75b6e68b22fed536765d1f2f254"></a><br></td></tr>
cannam@0 118 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#d22c666188aadab83c354a0edb18fcf0">getRemainingFeatures</a> )(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
cannam@0 119
cannam@0 120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return any remaining features at the end of processing. <a href="#d22c666188aadab83c354a0edb18fcf0"></a><br></td></tr>
cannam@0 121 <tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">releaseFeatureSet</a> )(<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *)</td></tr>
cannam@0 122
cannam@0 123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release a feature set returned from process or getRemainingFeatures. <a href="#c4bafe8ad2734d21a433d745b18e7d63"></a><br></td></tr>
cannam@0 124 </table>
cannam@35 125 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 126
cannam@35 127 <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>
cannam@0 128 <hr><h2>Member Data Documentation</h2>
cannam@0 129 <a class="anchor" name="b6c87760e87ddaa9ac3491bccaaa28c2"></a><!-- doxytag: member="_VampPluginDescriptor::vampApiVersion" ref="b6c87760e87ddaa9ac3491bccaaa28c2" args="" -->
cannam@0 130 <div class="memitem">
cannam@0 131 <div class="memproto">
cannam@0 132 <table class="memname">
cannam@0 133 <tr>
cannam@0 134 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#b6c87760e87ddaa9ac3491bccaaa28c2">_VampPluginDescriptor::vampApiVersion</a> </td>
cannam@0 135 </tr>
cannam@0 136 </table>
cannam@0 137 </div>
cannam@0 138 <div class="memdoc">
cannam@0 139
cannam@0 140 <p>
cannam@0 141 API version with which this descriptor is compatible.
cannam@0 142 <p>
cannam@0 143
cannam@21 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>
cannam@0 145
cannam@0 146 </div>
cannam@0 147 </div><p>
cannam@0 148 <a class="anchor" name="4915ec8276749cb505c01d25a6d02219"></a><!-- doxytag: member="_VampPluginDescriptor::identifier" ref="4915ec8276749cb505c01d25a6d02219" args="" -->
cannam@0 149 <div class="memitem">
cannam@0 150 <div class="memproto">
cannam@0 151 <table class="memname">
cannam@0 152 <tr>
cannam@0 153 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#4915ec8276749cb505c01d25a6d02219">_VampPluginDescriptor::identifier</a> </td>
cannam@0 154 </tr>
cannam@0 155 </table>
cannam@0 156 </div>
cannam@0 157 <div class="memdoc">
cannam@0 158
cannam@0 159 <p>
cannam@0 160 Computer-usable name of the plugin.
cannam@0 161 <p>
cannam@0 162 Must not change. [a-zA-Z0-9_]
cannam@21 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>
cannam@0 164
cannam@0 165 </div>
cannam@0 166 </div><p>
cannam@0 167 <a class="anchor" name="9dd5a0190e4d453ff36b5acb7000b150"></a><!-- doxytag: member="_VampPluginDescriptor::name" ref="9dd5a0190e4d453ff36b5acb7000b150" args="" -->
cannam@0 168 <div class="memitem">
cannam@0 169 <div class="memproto">
cannam@0 170 <table class="memname">
cannam@0 171 <tr>
cannam@0 172 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#9dd5a0190e4d453ff36b5acb7000b150">_VampPluginDescriptor::name</a> </td>
cannam@0 173 </tr>
cannam@0 174 </table>
cannam@0 175 </div>
cannam@0 176 <div class="memdoc">
cannam@0 177
cannam@0 178 <p>
cannam@0 179 Human-readable name of the plugin.
cannam@0 180 <p>
cannam@0 181 May be translatable.
cannam@21 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>
cannam@0 183
cannam@0 184 </div>
cannam@0 185 </div><p>
cannam@0 186 <a class="anchor" name="9ff8050f92f1a04a68bb34a9d368295e"></a><!-- doxytag: member="_VampPluginDescriptor::description" ref="9ff8050f92f1a04a68bb34a9d368295e" args="" -->
cannam@0 187 <div class="memitem">
cannam@0 188 <div class="memproto">
cannam@0 189 <table class="memname">
cannam@0 190 <tr>
cannam@0 191 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#9ff8050f92f1a04a68bb34a9d368295e">_VampPluginDescriptor::description</a> </td>
cannam@0 192 </tr>
cannam@0 193 </table>
cannam@0 194 </div>
cannam@0 195 <div class="memdoc">
cannam@0 196
cannam@0 197 <p>
cannam@0 198 Human-readable short text about the plugin.
cannam@0 199 <p>
cannam@0 200 May be translatable.
cannam@21 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>
cannam@0 202
cannam@0 203 </div>
cannam@0 204 </div><p>
cannam@0 205 <a class="anchor" name="4dca3d57331802964716edfa80580c9b"></a><!-- doxytag: member="_VampPluginDescriptor::maker" ref="4dca3d57331802964716edfa80580c9b" args="" -->
cannam@0 206 <div class="memitem">
cannam@0 207 <div class="memproto">
cannam@0 208 <table class="memname">
cannam@0 209 <tr>
cannam@0 210 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#4dca3d57331802964716edfa80580c9b">_VampPluginDescriptor::maker</a> </td>
cannam@0 211 </tr>
cannam@0 212 </table>
cannam@0 213 </div>
cannam@0 214 <div class="memdoc">
cannam@0 215
cannam@0 216 <p>
cannam@0 217 Human-readable name of plugin's author or vendor.
cannam@0 218 <p>
cannam@0 219
cannam@21 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>
cannam@0 221
cannam@0 222 </div>
cannam@0 223 </div><p>
cannam@0 224 <a class="anchor" name="04427c420d9252c7796c0bf5101345ae"></a><!-- doxytag: member="_VampPluginDescriptor::pluginVersion" ref="04427c420d9252c7796c0bf5101345ae" args="" -->
cannam@0 225 <div class="memitem">
cannam@0 226 <div class="memproto">
cannam@0 227 <table class="memname">
cannam@0 228 <tr>
cannam@0 229 <td class="memname">int <a class="el" href="struct__VampPluginDescriptor.html#04427c420d9252c7796c0bf5101345ae">_VampPluginDescriptor::pluginVersion</a> </td>
cannam@0 230 </tr>
cannam@0 231 </table>
cannam@0 232 </div>
cannam@0 233 <div class="memdoc">
cannam@0 234
cannam@0 235 <p>
cannam@0 236 Version number of the plugin.
cannam@0 237 <p>
cannam@0 238
cannam@21 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>
cannam@0 240
cannam@0 241 </div>
cannam@0 242 </div><p>
cannam@0 243 <a class="anchor" name="e704bba384af0de056a26da1b13ee521"></a><!-- doxytag: member="_VampPluginDescriptor::copyright" ref="e704bba384af0de056a26da1b13ee521" args="" -->
cannam@0 244 <div class="memitem">
cannam@0 245 <div class="memproto">
cannam@0 246 <table class="memname">
cannam@0 247 <tr>
cannam@0 248 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#e704bba384af0de056a26da1b13ee521">_VampPluginDescriptor::copyright</a> </td>
cannam@0 249 </tr>
cannam@0 250 </table>
cannam@0 251 </div>
cannam@0 252 <div class="memdoc">
cannam@0 253
cannam@0 254 <p>
cannam@0 255 Human-readable summary of copyright or licensing for plugin.
cannam@0 256 <p>
cannam@0 257
cannam@21 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>
cannam@0 259
cannam@0 260 </div>
cannam@0 261 </div><p>
cannam@0 262 <a class="anchor" name="e6271dc3ea0cea959c84a64185492cab"></a><!-- doxytag: member="_VampPluginDescriptor::parameterCount" ref="e6271dc3ea0cea959c84a64185492cab" args="" -->
cannam@0 263 <div class="memitem">
cannam@0 264 <div class="memproto">
cannam@0 265 <table class="memname">
cannam@0 266 <tr>
cannam@0 267 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#e6271dc3ea0cea959c84a64185492cab">_VampPluginDescriptor::parameterCount</a> </td>
cannam@0 268 </tr>
cannam@0 269 </table>
cannam@0 270 </div>
cannam@0 271 <div class="memdoc">
cannam@0 272
cannam@0 273 <p>
cannam@0 274 Number of parameter inputs.
cannam@0 275 <p>
cannam@0 276
cannam@21 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>
cannam@0 278
cannam@0 279 </div>
cannam@0 280 </div><p>
cannam@0 281 <a class="anchor" name="64d614862604c31d6b84c49005f51913"></a><!-- doxytag: member="_VampPluginDescriptor::parameters" ref="64d614862604c31d6b84c49005f51913" args="" -->
cannam@0 282 <div class="memitem">
cannam@0 283 <div class="memproto">
cannam@0 284 <table class="memname">
cannam@0 285 <tr>
cannam@0 286 <td class="memname">const <a class="el" href="struct__VampParameterDescriptor.html">VampParameterDescriptor</a>** <a class="el" href="struct__VampPluginDescriptor.html#64d614862604c31d6b84c49005f51913">_VampPluginDescriptor::parameters</a> </td>
cannam@0 287 </tr>
cannam@0 288 </table>
cannam@0 289 </div>
cannam@0 290 <div class="memdoc">
cannam@0 291
cannam@0 292 <p>
cannam@0 293 Fixed descriptors for parameter inputs.
cannam@0 294 <p>
cannam@0 295
cannam@21 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>
cannam@0 297
cannam@0 298 </div>
cannam@0 299 </div><p>
cannam@0 300 <a class="anchor" name="1962666aa173e7a9a2c30dc82e4b2e00"></a><!-- doxytag: member="_VampPluginDescriptor::programCount" ref="1962666aa173e7a9a2c30dc82e4b2e00" args="" -->
cannam@0 301 <div class="memitem">
cannam@0 302 <div class="memproto">
cannam@0 303 <table class="memname">
cannam@0 304 <tr>
cannam@0 305 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#1962666aa173e7a9a2c30dc82e4b2e00">_VampPluginDescriptor::programCount</a> </td>
cannam@0 306 </tr>
cannam@0 307 </table>
cannam@0 308 </div>
cannam@0 309 <div class="memdoc">
cannam@0 310
cannam@0 311 <p>
cannam@0 312 Number of programs.
cannam@0 313 <p>
cannam@0 314
cannam@21 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>
cannam@0 316
cannam@0 317 </div>
cannam@0 318 </div><p>
cannam@0 319 <a class="anchor" name="d488470c582d8472d86455889d71c5ec"></a><!-- doxytag: member="_VampPluginDescriptor::programs" ref="d488470c582d8472d86455889d71c5ec" args="" -->
cannam@0 320 <div class="memitem">
cannam@0 321 <div class="memproto">
cannam@0 322 <table class="memname">
cannam@0 323 <tr>
cannam@0 324 <td class="memname">const char** <a class="el" href="struct__VampPluginDescriptor.html#d488470c582d8472d86455889d71c5ec">_VampPluginDescriptor::programs</a> </td>
cannam@0 325 </tr>
cannam@0 326 </table>
cannam@0 327 </div>
cannam@0 328 <div class="memdoc">
cannam@0 329
cannam@0 330 <p>
cannam@0 331 Fixed names for programs.
cannam@0 332 <p>
cannam@0 333
cannam@21 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>
cannam@0 335
cannam@0 336 </div>
cannam@0 337 </div><p>
cannam@0 338 <a class="anchor" name="ffc4d1796da7ced2c0cbb2cc2c4a22f4"></a><!-- doxytag: member="_VampPluginDescriptor::inputDomain" ref="ffc4d1796da7ced2c0cbb2cc2c4a22f4" args="" -->
cannam@0 339 <div class="memitem">
cannam@0 340 <div class="memproto">
cannam@0 341 <table class="memname">
cannam@0 342 <tr>
cannam@0 343 <td class="memname"><a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="el" href="struct__VampPluginDescriptor.html#ffc4d1796da7ced2c0cbb2cc2c4a22f4">_VampPluginDescriptor::inputDomain</a> </td>
cannam@0 344 </tr>
cannam@0 345 </table>
cannam@0 346 </div>
cannam@0 347 <div class="memdoc">
cannam@0 348
cannam@0 349 <p>
cannam@0 350 Preferred input domain for audio input (time or frequency).
cannam@0 351 <p>
cannam@0 352
cannam@21 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>
cannam@0 354
cannam@0 355 </div>
cannam@0 356 </div><p>
cannam@0 357 <a class="anchor" name="19c4ce36fdeb88eeedb539efc544b8ee"></a><!-- doxytag: member="_VampPluginDescriptor::instantiate" ref="19c4ce36fdeb88eeedb539efc544b8ee" args=")(const struct _VampPluginDescriptor *, float inputSampleRate)" -->
cannam@0 358 <div class="memitem">
cannam@0 359 <div class="memproto">
cannam@0 360 <table class="memname">
cannam@0 361 <tr>
cannam@0 362 <td class="memname"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* <a class="el" href="struct__VampPluginDescriptor.html#19c4ce36fdeb88eeedb539efc544b8ee">_VampPluginDescriptor::instantiate</a>)(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate) </td>
cannam@0 363 </tr>
cannam@0 364 </table>
cannam@0 365 </div>
cannam@0 366 <div class="memdoc">
cannam@0 367
cannam@0 368 <p>
cannam@0 369 Create and return a new instance of this plugin.
cannam@0 370 <p>
cannam@0 371
cannam@0 372 </div>
cannam@0 373 </div><p>
cannam@0 374 <a class="anchor" name="0e4522c33e59c3c518b9262f2477bc27"></a><!-- doxytag: member="_VampPluginDescriptor::cleanup" ref="0e4522c33e59c3c518b9262f2477bc27" args=")(VampPluginHandle)" -->
cannam@0 375 <div class="memitem">
cannam@0 376 <div class="memproto">
cannam@0 377 <table class="memname">
cannam@0 378 <tr>
cannam@0 379 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#0e4522c33e59c3c518b9262f2477bc27">_VampPluginDescriptor::cleanup</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 380 </tr>
cannam@0 381 </table>
cannam@0 382 </div>
cannam@0 383 <div class="memdoc">
cannam@0 384
cannam@0 385 <p>
cannam@0 386 Destroy an instance of this plugin.
cannam@0 387 <p>
cannam@0 388
cannam@0 389 </div>
cannam@0 390 </div><p>
cannam@0 391 <a class="anchor" name="d0978f17a5e568079470a1978a9aad22"></a><!-- doxytag: member="_VampPluginDescriptor::initialise" ref="d0978f17a5e568079470a1978a9aad22" args=")(VampPluginHandle, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)" -->
cannam@0 392 <div class="memitem">
cannam@0 393 <div class="memproto">
cannam@0 394 <table class="memname">
cannam@0 395 <tr>
cannam@0 396 <td class="memname">int(* <a class="el" href="struct__VampPluginDescriptor.html#d0978f17a5e568079470a1978a9aad22">_VampPluginDescriptor::initialise</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize) </td>
cannam@0 397 </tr>
cannam@0 398 </table>
cannam@0 399 </div>
cannam@0 400 <div class="memdoc">
cannam@0 401
cannam@0 402 <p>
cannam@0 403 Initialise an instance following parameter configuration.
cannam@0 404 <p>
cannam@0 405
cannam@0 406 </div>
cannam@0 407 </div><p>
cannam@0 408 <a class="anchor" name="12267f6b506aeda3792ff7c982b02336"></a><!-- doxytag: member="_VampPluginDescriptor::reset" ref="12267f6b506aeda3792ff7c982b02336" args=")(VampPluginHandle)" -->
cannam@0 409 <div class="memitem">
cannam@0 410 <div class="memproto">
cannam@0 411 <table class="memname">
cannam@0 412 <tr>
cannam@0 413 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#12267f6b506aeda3792ff7c982b02336">_VampPluginDescriptor::reset</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 414 </tr>
cannam@0 415 </table>
cannam@0 416 </div>
cannam@0 417 <div class="memdoc">
cannam@0 418
cannam@0 419 <p>
cannam@0 420 Reset an instance, ready to use again on new input data.
cannam@0 421 <p>
cannam@0 422
cannam@0 423 </div>
cannam@0 424 </div><p>
cannam@0 425 <a class="anchor" name="07174981875b55ee2ec7521a7f4fc395"></a><!-- doxytag: member="_VampPluginDescriptor::getParameter" ref="07174981875b55ee2ec7521a7f4fc395" args=")(VampPluginHandle, int)" -->
cannam@0 426 <div class="memitem">
cannam@0 427 <div class="memproto">
cannam@0 428 <table class="memname">
cannam@0 429 <tr>
cannam@0 430 <td class="memname">float(* <a class="el" href="struct__VampPluginDescriptor.html#07174981875b55ee2ec7521a7f4fc395">_VampPluginDescriptor::getParameter</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int) </td>
cannam@0 431 </tr>
cannam@0 432 </table>
cannam@0 433 </div>
cannam@0 434 <div class="memdoc">
cannam@0 435
cannam@0 436 <p>
cannam@0 437 Get a parameter value.
cannam@0 438 <p>
cannam@0 439
cannam@0 440 </div>
cannam@0 441 </div><p>
cannam@0 442 <a class="anchor" name="ad3cfc7a3b432df40bd9db13eee6a481"></a><!-- doxytag: member="_VampPluginDescriptor::setParameter" ref="ad3cfc7a3b432df40bd9db13eee6a481" args=")(VampPluginHandle, int, float)" -->
cannam@0 443 <div class="memitem">
cannam@0 444 <div class="memproto">
cannam@0 445 <table class="memname">
cannam@0 446 <tr>
cannam@0 447 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ad3cfc7a3b432df40bd9db13eee6a481">_VampPluginDescriptor::setParameter</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float) </td>
cannam@0 448 </tr>
cannam@0 449 </table>
cannam@0 450 </div>
cannam@0 451 <div class="memdoc">
cannam@0 452
cannam@0 453 <p>
cannam@0 454 Set a parameter value.
cannam@0 455 <p>
cannam@0 456 May only be called before initialise.
cannam@0 457 </div>
cannam@0 458 </div><p>
cannam@0 459 <a class="anchor" name="861a77525a95d424cb846820b018af53"></a><!-- doxytag: member="_VampPluginDescriptor::getCurrentProgram" ref="861a77525a95d424cb846820b018af53" args=")(VampPluginHandle)" -->
cannam@0 460 <div class="memitem">
cannam@0 461 <div class="memproto">
cannam@0 462 <table class="memname">
cannam@0 463 <tr>
cannam@0 464 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#861a77525a95d424cb846820b018af53">_VampPluginDescriptor::getCurrentProgram</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 465 </tr>
cannam@0 466 </table>
cannam@0 467 </div>
cannam@0 468 <div class="memdoc">
cannam@0 469
cannam@0 470 <p>
cannam@0 471 Get the current program (if programCount &gt; 0).
cannam@0 472 <p>
cannam@0 473
cannam@0 474 </div>
cannam@0 475 </div><p>
cannam@0 476 <a class="anchor" name="d9af40cb165ca187e49250964af5f5cf"></a><!-- doxytag: member="_VampPluginDescriptor::selectProgram" ref="d9af40cb165ca187e49250964af5f5cf" args=")(VampPluginHandle, unsigned int)" -->
cannam@0 477 <div class="memitem">
cannam@0 478 <div class="memproto">
cannam@0 479 <table class="memname">
cannam@0 480 <tr>
cannam@0 481 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#d9af40cb165ca187e49250964af5f5cf">_VampPluginDescriptor::selectProgram</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int) </td>
cannam@0 482 </tr>
cannam@0 483 </table>
cannam@0 484 </div>
cannam@0 485 <div class="memdoc">
cannam@0 486
cannam@0 487 <p>
cannam@0 488 Set the current program.
cannam@0 489 <p>
cannam@0 490 May only be called before initialise.
cannam@0 491 </div>
cannam@0 492 </div><p>
cannam@0 493 <a class="anchor" name="2beddf2ce156c05dd24477ac663adcbb"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredStepSize" ref="2beddf2ce156c05dd24477ac663adcbb" args=")(VampPluginHandle)" -->
cannam@0 494 <div class="memitem">
cannam@0 495 <div class="memproto">
cannam@0 496 <table class="memname">
cannam@0 497 <tr>
cannam@0 498 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#2beddf2ce156c05dd24477ac663adcbb">_VampPluginDescriptor::getPreferredStepSize</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 499 </tr>
cannam@0 500 </table>
cannam@0 501 </div>
cannam@0 502 <div class="memdoc">
cannam@0 503
cannam@0 504 <p>
cannam@0 505 Get the plugin's preferred processing window increment in samples.
cannam@0 506 <p>
cannam@0 507
cannam@0 508 </div>
cannam@0 509 </div><p>
cannam@0 510 <a class="anchor" name="c626e42554ab1532c8d8b5132a0faee8"></a><!-- doxytag: member="_VampPluginDescriptor::getPreferredBlockSize" ref="c626e42554ab1532c8d8b5132a0faee8" args=")(VampPluginHandle)" -->
cannam@0 511 <div class="memitem">
cannam@0 512 <div class="memproto">
cannam@0 513 <table class="memname">
cannam@0 514 <tr>
cannam@0 515 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#c626e42554ab1532c8d8b5132a0faee8">_VampPluginDescriptor::getPreferredBlockSize</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 516 </tr>
cannam@0 517 </table>
cannam@0 518 </div>
cannam@0 519 <div class="memdoc">
cannam@0 520
cannam@0 521 <p>
cannam@0 522 Get the plugin's preferred processing window size in samples.
cannam@0 523 <p>
cannam@0 524
cannam@0 525 </div>
cannam@0 526 </div><p>
cannam@0 527 <a class="anchor" name="f175ca17716db5a7545b61b01caabd92"></a><!-- doxytag: member="_VampPluginDescriptor::getMinChannelCount" ref="f175ca17716db5a7545b61b01caabd92" args=")(VampPluginHandle)" -->
cannam@0 528 <div class="memitem">
cannam@0 529 <div class="memproto">
cannam@0 530 <table class="memname">
cannam@0 531 <tr>
cannam@0 532 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#f175ca17716db5a7545b61b01caabd92">_VampPluginDescriptor::getMinChannelCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 533 </tr>
cannam@0 534 </table>
cannam@0 535 </div>
cannam@0 536 <div class="memdoc">
cannam@0 537
cannam@0 538 <p>
cannam@0 539 Get the minimum number of input channels this plugin can handle.
cannam@0 540 <p>
cannam@0 541
cannam@0 542 </div>
cannam@0 543 </div><p>
cannam@0 544 <a class="anchor" name="d1600203418d9646332f5b917284261b"></a><!-- doxytag: member="_VampPluginDescriptor::getMaxChannelCount" ref="d1600203418d9646332f5b917284261b" args=")(VampPluginHandle)" -->
cannam@0 545 <div class="memitem">
cannam@0 546 <div class="memproto">
cannam@0 547 <table class="memname">
cannam@0 548 <tr>
cannam@0 549 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#d1600203418d9646332f5b917284261b">_VampPluginDescriptor::getMaxChannelCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 550 </tr>
cannam@0 551 </table>
cannam@0 552 </div>
cannam@0 553 <div class="memdoc">
cannam@0 554
cannam@0 555 <p>
cannam@0 556 Get the maximum number of input channels this plugin can handle.
cannam@0 557 <p>
cannam@0 558
cannam@0 559 </div>
cannam@0 560 </div><p>
cannam@0 561 <a class="anchor" name="a8fc88da704e24b2b5f674821dd380c1"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputCount" ref="a8fc88da704e24b2b5f674821dd380c1" args=")(VampPluginHandle)" -->
cannam@0 562 <div class="memitem">
cannam@0 563 <div class="memproto">
cannam@0 564 <table class="memname">
cannam@0 565 <tr>
cannam@0 566 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 567 </tr>
cannam@0 568 </table>
cannam@0 569 </div>
cannam@0 570 <div class="memdoc">
cannam@0 571
cannam@0 572 <p>
cannam@0 573 Get the number of feature outputs (distinct sets of results).
cannam@0 574 <p>
cannam@0 575
cannam@0 576 </div>
cannam@0 577 </div><p>
cannam@0 578 <a class="anchor" name="92c58b8ff99ad0c23a42333aa55c144d"></a><!-- doxytag: member="_VampPluginDescriptor::getOutputDescriptor" ref="92c58b8ff99ad0c23a42333aa55c144d" args=")(VampPluginHandle, unsigned int)" -->
cannam@0 579 <div class="memitem">
cannam@0 580 <div class="memproto">
cannam@0 581 <table class="memname">
cannam@0 582 <tr>
cannam@0 583 <td class="memname"><a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#92c58b8ff99ad0c23a42333aa55c144d">_VampPluginDescriptor::getOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int) </td>
cannam@0 584 </tr>
cannam@0 585 </table>
cannam@0 586 </div>
cannam@0 587 <div class="memdoc">
cannam@0 588
cannam@0 589 <p>
cannam@0 590 Get a descriptor for a given feature output.
cannam@0 591 <p>
cannam@0 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.
cannam@0 593 </div>
cannam@0 594 </div><p>
cannam@0 595 <a class="anchor" name="8cc38edc921616e67e551aa03397ec79"></a><!-- doxytag: member="_VampPluginDescriptor::releaseOutputDescriptor" ref="8cc38edc921616e67e551aa03397ec79" args=")(VampOutputDescriptor *)" -->
cannam@0 596 <div class="memitem">
cannam@0 597 <div class="memproto">
cannam@0 598 <table class="memname">
cannam@0 599 <tr>
cannam@0 600 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#8cc38edc921616e67e551aa03397ec79">_VampPluginDescriptor::releaseOutputDescriptor</a>)(<a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> *) </td>
cannam@0 601 </tr>
cannam@0 602 </table>
cannam@0 603 </div>
cannam@0 604 <div class="memdoc">
cannam@0 605
cannam@0 606 <p>
cannam@0 607 Destroy a descriptor for a feature output.
cannam@0 608 <p>
cannam@0 609
cannam@0 610 </div>
cannam@0 611 </div><p>
cannam@0 612 <a class="anchor" name="c5a0a75b6e68b22fed536765d1f2f254"></a><!-- doxytag: member="_VampPluginDescriptor::process" ref="c5a0a75b6e68b22fed536765d1f2f254" args=")(VampPluginHandle, const float *const *inputBuffers, int sec, int nsec)" -->
cannam@0 613 <div class="memitem">
cannam@0 614 <div class="memproto">
cannam@0 615 <table class="memname">
cannam@0 616 <tr>
cannam@0 617 <td class="memname"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#c5a0a75b6e68b22fed536765d1f2f254">_VampPluginDescriptor::process</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec) </td>
cannam@0 618 </tr>
cannam@0 619 </table>
cannam@0 620 </div>
cannam@0 621 <div class="memdoc">
cannam@0 622
cannam@0 623 <p>
cannam@0 624 Process an input block and return a set of features.
cannam@0 625 <p>
cannam@0 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.
cannam@0 627 </div>
cannam@0 628 </div><p>
cannam@0 629 <a class="anchor" name="d22c666188aadab83c354a0edb18fcf0"></a><!-- doxytag: member="_VampPluginDescriptor::getRemainingFeatures" ref="d22c666188aadab83c354a0edb18fcf0" args=")(VampPluginHandle)" -->
cannam@0 630 <div class="memitem">
cannam@0 631 <div class="memproto">
cannam@0 632 <table class="memname">
cannam@0 633 <tr>
cannam@0 634 <td class="memname"><a class="el" href="struct__VampFeatureList.html">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#d22c666188aadab83c354a0edb18fcf0">_VampPluginDescriptor::getRemainingFeatures</a>)(<a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>) </td>
cannam@0 635 </tr>
cannam@0 636 </table>
cannam@0 637 </div>
cannam@0 638 <div class="memdoc">
cannam@0 639
cannam@0 640 <p>
cannam@0 641 Return any remaining features at the end of processing.
cannam@0 642 <p>
cannam@0 643
cannam@0 644 </div>
cannam@0 645 </div><p>
cannam@0 646 <a class="anchor" name="c4bafe8ad2734d21a433d745b18e7d63"></a><!-- doxytag: member="_VampPluginDescriptor::releaseFeatureSet" ref="c4bafe8ad2734d21a433d745b18e7d63" args=")(VampFeatureList *)" -->
cannam@0 647 <div class="memitem">
cannam@0 648 <div class="memproto">
cannam@0 649 <table class="memname">
cannam@0 650 <tr>
cannam@0 651 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#c4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>)(<a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> *) </td>
cannam@0 652 </tr>
cannam@0 653 </table>
cannam@0 654 </div>
cannam@0 655 <div class="memdoc">
cannam@0 656
cannam@0 657 <p>
cannam@0 658 Release a feature set returned from process or getRemainingFeatures.
cannam@0 659 <p>
cannam@0 660
cannam@0 661 </div>
cannam@0 662 </div><p>
cannam@0 663 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@0 664 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul>
cannam@0 665 </div>
cannam@35 666 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@0 667 <a href="http://www.doxygen.org/index.html">
cannam@35 668 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 669 </body>
cannam@0 670 </html>