Mercurial > hg > vamp-docs

comparison code-docs/struct__VampPluginDescriptor.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

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