Mercurial > hg > vamp-docs

annotate code-docs/struct__VampParameterDescriptor.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

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