Mercurial > hg > vamp-docs

comparison code-docs/struct__VampParameterDescriptor.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: _VampParameterDescriptor 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__VampParameterDescriptor.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">_VampParameterDescriptor Struct Reference</div> </div>
79 </div>
80 <div class="contents">
81 <!-- doxytag: class="_VampParameterDescriptor" -->
82 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
83 <a href="struct__VampParameterDescriptor.html#details">More...</a></p>
84
85 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
86
87 <p><a href="struct__VampParameterDescriptor-members.html">List of all members.</a></p>
88 <table class="memberdecls">
89 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
90 Public Attributes</h2></td></tr>
91 <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr>
92 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr>
94 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr>
96 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr>
97 <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr>
98 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr>
100 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr>
102 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr>
104 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr>
106 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a"></a><br/></td></tr>
107 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr>
108 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr>
110 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#a188883325ab1e4a898e3dc53a8f88f9d"></a><br/></td></tr>
111 </table>
112 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
113 <div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
114 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p>
115 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p>
116
117 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00071">71</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
118 </div><hr/><h2>Member Data Documentation</h2>
119 <a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="a26d74afd6a3341a673f15955031845ab" args="" -->
120 <div class="memitem">
121 <div class="memproto">
122 <table class="memname">
123 <tr>
124 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a></td>
125 </tr>
126 </table>
127 </div>
128 <div class="memdoc">
129
130 <p>Computer-usable name of the parameter. </p>
131 <p>Must not change. [a-zA-Z0-9_] </p>
132
133 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00074">74</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
134
135 </div>
136 </div>
137 <a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="abba810bce9656f6002777f6c3f655957" args="" -->
138 <div class="memitem">
139 <div class="memproto">
140 <table class="memname">
141 <tr>
142 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a></td>
143 </tr>
144 </table>
145 </div>
146 <div class="memdoc">
147
148 <p>Human-readable name of the parameter. </p>
149 <p>May be translatable. </p>
150
151 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00077">77</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
152
153 </div>
154 </div>
155 <a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="a95489272d6cf5a5b487e949da8e4fac6" args="" -->
156 <div class="memitem">
157 <div class="memproto">
158 <table class="memname">
159 <tr>
160 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a></td>
161 </tr>
162 </table>
163 </div>
164 <div class="memdoc">
165
166 <p>Human-readable short text about the parameter. </p>
167 <p>May be translatable. </p>
168
169 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00080">80</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
170
171 </div>
172 </div>
173 <a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="a8ca235f816b56dc99125e010eee08fc7" args="" -->
174 <div class="memitem">
175 <div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a></td>
179 </tr>
180 </table>
181 </div>
182 <div class="memdoc">
183
184 <p>Human-readable unit of the parameter. </p>
185
186 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00083">83</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
187
188 </div>
189 </div>
190 <a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="ab59c84f0bbe0d4d0c578d893c087b0db" args="" -->
191 <div class="memitem">
192 <div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a></td>
196 </tr>
197 </table>
198 </div>
199 <div class="memdoc">
200
201 <p>Minimum value. </p>
202
203 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00086">86</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
204
205 </div>
206 </div>
207 <a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="a6e7646babdb265c4abfc107ba4350d80" args="" -->
208 <div class="memitem">
209 <div class="memproto">
210 <table class="memname">
211 <tr>
212 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a></td>
213 </tr>
214 </table>
215 </div>
216 <div class="memdoc">
217
218 <p>Maximum value. </p>
219
220 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00089">89</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="a3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="a3d37f986ee152ab55feb9902b35f7aca" args="" -->
225 <div class="memitem">
226 <div class="memproto">
227 <table class="memname">
228 <tr>
229 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a></td>
230 </tr>
231 </table>
232 </div>
233 <div class="memdoc">
234
235 <p>Default value. </p>
236 <p>Plugin is responsible for setting this on initialise. </p>
237
238 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00092">92</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
239
240 </div>
241 </div>
242 <a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="a3f41e3b6b69c7a95ff0ce8625794f83a" args="" -->
243 <div class="memitem">
244 <div class="memproto">
245 <table class="memname">
246 <tr>
247 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a></td>
248 </tr>
249 </table>
250 </div>
251 <div class="memdoc">
252
253 <p>1 if parameter values are quantized to a particular resolution. </p>
254
255 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00095">95</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
256
257 </div>
258 </div>
259 <a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="a68c91fd3fc0b0b3617c2d343fe32d0e5" args="" -->
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a></td>
265 </tr>
266 </table>
267 </div>
268 <div class="memdoc">
269
270 <p>Quantization resolution, if isQuantized. </p>
271
272 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00098">98</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
273
274 </div>
275 </div>
276 <a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="a188883325ab1e4a898e3dc53a8f88f9d" args="" -->
277 <div class="memitem">
278 <div class="memproto">
279 <table class="memname">
280 <tr>
281 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a></td>
282 </tr>
283 </table>
284 </div>
285 <div class="memdoc">
286
287 <p>Human-readable names of the values, if isQuantized. </p>
288 <p>May be NULL. </p>
289
290 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00101">101</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
291
292 </div>
293 </div>
294 <hr/>The documentation for this struct was generated from the following file:<ul>
295 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
296 </ul>
297 </div>
298 </div>
299 <div id="nav-path" class="navpath">
300 <ul>
301 <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> </li>
302
303 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
304 <a href="http://www.doxygen.org/index.html">
305 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
306 </ul>
307 </div>
308
309
310 </body>
311 </html>