Mercurial > hg > vamp-docs

annotate 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
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('struct__VampParameterDescriptor.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#pub-attribs">Public Attributes</a> </div>
Chris@1 77 <div class="headertitle">
Chris@1 78 <div class="title">_VampParameterDescriptor Struct Reference</div> </div>
Chris@1 79 </div>
Chris@1 80 <div class="contents">
Chris@1 81 <!-- doxytag: class="_VampParameterDescriptor" -->
Chris@1 82 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
Chris@1 83 <a href="struct__VampParameterDescriptor.html#details">More...</a></p>
Chris@1 84
Chris@1 85 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
Chris@1 86
Chris@1 87 <p><a href="struct__VampParameterDescriptor-members.html">List of all members.</a></p>
Chris@1 88 <table class="memberdecls">
Chris@1 89 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
Chris@1 90 Public Attributes</h2></td></tr>
Chris@1 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>
Chris@1 92 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr>
Chris@1 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>
Chris@1 94 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr>
Chris@1 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>
Chris@1 96 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr>
Chris@1 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>
Chris@1 98 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr>
Chris@1 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>
Chris@1 100 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr>
Chris@1 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>
Chris@1 102 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr>
Chris@1 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>
Chris@1 104 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr>
Chris@1 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>
Chris@1 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>
Chris@1 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>
Chris@1 108 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr>
Chris@1 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>
Chris@1 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>
Chris@1 111 </table>
Chris@1 112 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 113 <div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
Chris@1 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>
Chris@1 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>
Chris@1 116
Chris@1 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>
Chris@1 118 </div><hr/><h2>Member Data Documentation</h2>
Chris@1 119 <a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="a26d74afd6a3341a673f15955031845ab" args="" -->
Chris@1 120 <div class="memitem">
Chris@1 121 <div class="memproto">
Chris@1 122 <table class="memname">
Chris@1 123 <tr>
Chris@1 124 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a></td>
Chris@1 125 </tr>
Chris@1 126 </table>
Chris@1 127 </div>
Chris@1 128 <div class="memdoc">
Chris@1 129
Chris@1 130 <p>Computer-usable name of the parameter. </p>
Chris@1 131 <p>Must not change. [a-zA-Z0-9_] </p>
Chris@1 132
Chris@1 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>
Chris@1 134
Chris@1 135 </div>
Chris@1 136 </div>
Chris@1 137 <a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="abba810bce9656f6002777f6c3f655957" args="" -->
Chris@1 138 <div class="memitem">
Chris@1 139 <div class="memproto">
Chris@1 140 <table class="memname">
Chris@1 141 <tr>
Chris@1 142 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a></td>
Chris@1 143 </tr>
Chris@1 144 </table>
Chris@1 145 </div>
Chris@1 146 <div class="memdoc">
Chris@1 147
Chris@1 148 <p>Human-readable name of the parameter. </p>
Chris@1 149 <p>May be translatable. </p>
Chris@1 150
Chris@1 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>
Chris@1 152
Chris@1 153 </div>
Chris@1 154 </div>
Chris@1 155 <a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="a95489272d6cf5a5b487e949da8e4fac6" args="" -->
Chris@1 156 <div class="memitem">
Chris@1 157 <div class="memproto">
Chris@1 158 <table class="memname">
Chris@1 159 <tr>
Chris@1 160 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a></td>
Chris@1 161 </tr>
Chris@1 162 </table>
Chris@1 163 </div>
Chris@1 164 <div class="memdoc">
Chris@1 165
Chris@1 166 <p>Human-readable short text about the parameter. </p>
Chris@1 167 <p>May be translatable. </p>
Chris@1 168
Chris@1 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>
Chris@1 170
Chris@1 171 </div>
Chris@1 172 </div>
Chris@1 173 <a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="a8ca235f816b56dc99125e010eee08fc7" args="" -->
Chris@1 174 <div class="memitem">
Chris@1 175 <div class="memproto">
Chris@1 176 <table class="memname">
Chris@1 177 <tr>
Chris@1 178 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a></td>
Chris@1 179 </tr>
Chris@1 180 </table>
Chris@1 181 </div>
Chris@1 182 <div class="memdoc">
Chris@1 183
Chris@1 184 <p>Human-readable unit of the parameter. </p>
Chris@1 185
Chris@1 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>
Chris@1 187
Chris@1 188 </div>
Chris@1 189 </div>
Chris@1 190 <a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="ab59c84f0bbe0d4d0c578d893c087b0db" args="" -->
Chris@1 191 <div class="memitem">
Chris@1 192 <div class="memproto">
Chris@1 193 <table class="memname">
Chris@1 194 <tr>
Chris@1 195 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a></td>
Chris@1 196 </tr>
Chris@1 197 </table>
Chris@1 198 </div>
Chris@1 199 <div class="memdoc">
Chris@1 200
Chris@1 201 <p>Minimum value. </p>
Chris@1 202
Chris@1 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>
Chris@1 204
Chris@1 205 </div>
Chris@1 206 </div>
Chris@1 207 <a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="a6e7646babdb265c4abfc107ba4350d80" args="" -->
Chris@1 208 <div class="memitem">
Chris@1 209 <div class="memproto">
Chris@1 210 <table class="memname">
Chris@1 211 <tr>
Chris@1 212 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a></td>
Chris@1 213 </tr>
Chris@1 214 </table>
Chris@1 215 </div>
Chris@1 216 <div class="memdoc">
Chris@1 217
Chris@1 218 <p>Maximum value. </p>
Chris@1 219
Chris@1 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>
Chris@1 221
Chris@1 222 </div>
Chris@1 223 </div>
Chris@1 224 <a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="a3d37f986ee152ab55feb9902b35f7aca" args="" -->
Chris@1 225 <div class="memitem">
Chris@1 226 <div class="memproto">
Chris@1 227 <table class="memname">
Chris@1 228 <tr>
Chris@1 229 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a></td>
Chris@1 230 </tr>
Chris@1 231 </table>
Chris@1 232 </div>
Chris@1 233 <div class="memdoc">
Chris@1 234
Chris@1 235 <p>Default value. </p>
Chris@1 236 <p>Plugin is responsible for setting this on initialise. </p>
Chris@1 237
Chris@1 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>
Chris@1 239
Chris@1 240 </div>
Chris@1 241 </div>
Chris@1 242 <a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="a3f41e3b6b69c7a95ff0ce8625794f83a" args="" -->
Chris@1 243 <div class="memitem">
Chris@1 244 <div class="memproto">
Chris@1 245 <table class="memname">
Chris@1 246 <tr>
Chris@1 247 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a></td>
Chris@1 248 </tr>
Chris@1 249 </table>
Chris@1 250 </div>
Chris@1 251 <div class="memdoc">
Chris@1 252
Chris@1 253 <p>1 if parameter values are quantized to a particular resolution. </p>
Chris@1 254
Chris@1 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>
Chris@1 256
Chris@1 257 </div>
Chris@1 258 </div>
Chris@1 259 <a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="a68c91fd3fc0b0b3617c2d343fe32d0e5" args="" -->
Chris@1 260 <div class="memitem">
Chris@1 261 <div class="memproto">
Chris@1 262 <table class="memname">
Chris@1 263 <tr>
Chris@1 264 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a></td>
Chris@1 265 </tr>
Chris@1 266 </table>
Chris@1 267 </div>
Chris@1 268 <div class="memdoc">
Chris@1 269
Chris@1 270 <p>Quantization resolution, if isQuantized. </p>
Chris@1 271
Chris@1 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>
Chris@1 273
Chris@1 274 </div>
Chris@1 275 </div>
Chris@1 276 <a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="a188883325ab1e4a898e3dc53a8f88f9d" args="" -->
Chris@1 277 <div class="memitem">
Chris@1 278 <div class="memproto">
Chris@1 279 <table class="memname">
Chris@1 280 <tr>
Chris@1 281 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a></td>
Chris@1 282 </tr>
Chris@1 283 </table>
Chris@1 284 </div>
Chris@1 285 <div class="memdoc">
Chris@1 286
Chris@1 287 <p>Human-readable names of the values, if isQuantized. </p>
Chris@1 288 <p>May be NULL. </p>
Chris@1 289
Chris@1 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>
Chris@1 291
Chris@1 292 </div>
Chris@1 293 </div>
Chris@1 294 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 295 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
Chris@1 296 </ul>
Chris@1 297 </div>
Chris@1 298 </div>
Chris@1 299 <div id="nav-path" class="navpath">
Chris@1 300 <ul>
Chris@1 301 <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> </li>
Chris@1 302
Chris@1 303 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
Chris@1 304 <a href="http://www.doxygen.org/index.html">
Chris@1 305 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 306 </ul>
Chris@1 307 </div>
Chris@1 308
Chris@1 309
Chris@1 310 </body>
Chris@1 311 </html>