Mercurial > hg > vamp-website

annotate code-doc/struct__VampParameterDescriptor.html @ 40:9391fbda5ad2 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update site for v2.2 release
author cannam
date Thu, 26 Aug 2010 11:36:19 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 </div>
cannam@0 26 <div class="contents">
cannam@35 27 <h1>_VampParameterDescriptor Struct Reference</h1><!-- doxytag: class="_VampParameterDescriptor" -->C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
cannam@35 28 <a href="#_details">More...</a>
cannam@35 29 <p>
cannam@35 30 <code>#include &lt;<a class="el" href="vamp_8h-source.html">vamp.h</a>&gt;</code>
cannam@0 31 <p>
cannam@0 32
cannam@0 33 <p>
cannam@35 34 <a href="struct__VampParameterDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 35 <tr><td></td></tr>
cannam@0 36 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@0 37 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">identifier</a></td></tr>
cannam@0 38
cannam@0 39 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computer-usable name of the parameter. <a href="#26d74afd6a3341a673f15955031845ab"></a><br></td></tr>
cannam@0 40 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">name</a></td></tr>
cannam@0 41
cannam@0 42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable name of the parameter. <a href="#bba810bce9656f6002777f6c3f655957"></a><br></td></tr>
cannam@0 43 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr>
cannam@0 44
cannam@0 45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable short text about the parameter. <a href="#95489272d6cf5a5b487e949da8e4fac6"></a><br></td></tr>
cannam@0 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr>
cannam@0 47
cannam@0 48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable unit of the parameter. <a href="#8ca235f816b56dc99125e010eee08fc7"></a><br></td></tr>
cannam@0 49 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr>
cannam@0 50
cannam@0 51 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum value. <a href="#b59c84f0bbe0d4d0c578d893c087b0db"></a><br></td></tr>
cannam@0 52 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr>
cannam@0 53
cannam@0 54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum value. <a href="#6e7646babdb265c4abfc107ba4350d80"></a><br></td></tr>
cannam@0 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr>
cannam@0 56
cannam@0 57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default value. <a href="#3d37f986ee152ab55feb9902b35f7aca"></a><br></td></tr>
cannam@0 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr>
cannam@0 59
cannam@0 60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#3f41e3b6b69c7a95ff0ce8625794f83a"></a><br></td></tr>
cannam@0 61 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr>
cannam@0 62
cannam@0 63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br></td></tr>
cannam@0 64 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr>
cannam@0 65
cannam@0 66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#188883325ab1e4a898e3dc53a8f88f9d"></a><br></td></tr>
cannam@0 67 </table>
cannam@35 68 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 69 C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
cannam@35 70 <p>
cannam@35 71 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>
cannam@35 72 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.
cannam@35 73 <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>
cannam@0 74 <hr><h2>Member Data Documentation</h2>
cannam@0 75 <a class="anchor" name="26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="26d74afd6a3341a673f15955031845ab" args="" -->
cannam@0 76 <div class="memitem">
cannam@0 77 <div class="memproto">
cannam@0 78 <table class="memname">
cannam@0 79 <tr>
cannam@0 80 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a> </td>
cannam@0 81 </tr>
cannam@0 82 </table>
cannam@0 83 </div>
cannam@0 84 <div class="memdoc">
cannam@0 85
cannam@0 86 <p>
cannam@0 87 Computer-usable name of the parameter.
cannam@0 88 <p>
cannam@0 89 Must not change. [a-zA-Z0-9_]
cannam@0 90 <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>
cannam@0 91
cannam@0 92 </div>
cannam@0 93 </div><p>
cannam@0 94 <a class="anchor" name="bba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="bba810bce9656f6002777f6c3f655957" args="" -->
cannam@0 95 <div class="memitem">
cannam@0 96 <div class="memproto">
cannam@0 97 <table class="memname">
cannam@0 98 <tr>
cannam@0 99 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a> </td>
cannam@0 100 </tr>
cannam@0 101 </table>
cannam@0 102 </div>
cannam@0 103 <div class="memdoc">
cannam@0 104
cannam@0 105 <p>
cannam@0 106 Human-readable name of the parameter.
cannam@0 107 <p>
cannam@0 108 May be translatable.
cannam@0 109 <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>
cannam@0 110
cannam@0 111 </div>
cannam@0 112 </div><p>
cannam@0 113 <a class="anchor" name="95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="95489272d6cf5a5b487e949da8e4fac6" args="" -->
cannam@0 114 <div class="memitem">
cannam@0 115 <div class="memproto">
cannam@0 116 <table class="memname">
cannam@0 117 <tr>
cannam@0 118 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a> </td>
cannam@0 119 </tr>
cannam@0 120 </table>
cannam@0 121 </div>
cannam@0 122 <div class="memdoc">
cannam@0 123
cannam@0 124 <p>
cannam@0 125 Human-readable short text about the parameter.
cannam@0 126 <p>
cannam@0 127 May be translatable.
cannam@0 128 <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>
cannam@0 129
cannam@0 130 </div>
cannam@0 131 </div><p>
cannam@0 132 <a class="anchor" name="8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="8ca235f816b56dc99125e010eee08fc7" args="" -->
cannam@0 133 <div class="memitem">
cannam@0 134 <div class="memproto">
cannam@0 135 <table class="memname">
cannam@0 136 <tr>
cannam@0 137 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a> </td>
cannam@0 138 </tr>
cannam@0 139 </table>
cannam@0 140 </div>
cannam@0 141 <div class="memdoc">
cannam@0 142
cannam@0 143 <p>
cannam@0 144 Human-readable unit of the parameter.
cannam@0 145 <p>
cannam@0 146
cannam@0 147 <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>
cannam@0 148
cannam@0 149 </div>
cannam@0 150 </div><p>
cannam@0 151 <a class="anchor" name="b59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="b59c84f0bbe0d4d0c578d893c087b0db" args="" -->
cannam@0 152 <div class="memitem">
cannam@0 153 <div class="memproto">
cannam@0 154 <table class="memname">
cannam@0 155 <tr>
cannam@0 156 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a> </td>
cannam@0 157 </tr>
cannam@0 158 </table>
cannam@0 159 </div>
cannam@0 160 <div class="memdoc">
cannam@0 161
cannam@0 162 <p>
cannam@0 163 Minimum value.
cannam@0 164 <p>
cannam@0 165
cannam@0 166 <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>
cannam@0 167
cannam@0 168 </div>
cannam@0 169 </div><p>
cannam@0 170 <a class="anchor" name="6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="6e7646babdb265c4abfc107ba4350d80" args="" -->
cannam@0 171 <div class="memitem">
cannam@0 172 <div class="memproto">
cannam@0 173 <table class="memname">
cannam@0 174 <tr>
cannam@0 175 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a> </td>
cannam@0 176 </tr>
cannam@0 177 </table>
cannam@0 178 </div>
cannam@0 179 <div class="memdoc">
cannam@0 180
cannam@0 181 <p>
cannam@0 182 Maximum value.
cannam@0 183 <p>
cannam@0 184
cannam@0 185 <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>
cannam@0 186
cannam@0 187 </div>
cannam@0 188 </div><p>
cannam@0 189 <a class="anchor" name="3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="3d37f986ee152ab55feb9902b35f7aca" args="" -->
cannam@0 190 <div class="memitem">
cannam@0 191 <div class="memproto">
cannam@0 192 <table class="memname">
cannam@0 193 <tr>
cannam@0 194 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a> </td>
cannam@0 195 </tr>
cannam@0 196 </table>
cannam@0 197 </div>
cannam@0 198 <div class="memdoc">
cannam@0 199
cannam@0 200 <p>
cannam@0 201 Default value.
cannam@0 202 <p>
cannam@0 203 Plugin is responsible for setting this on initialise.
cannam@0 204 <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>
cannam@0 205
cannam@0 206 </div>
cannam@0 207 </div><p>
cannam@0 208 <a class="anchor" name="3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="3f41e3b6b69c7a95ff0ce8625794f83a" args="" -->
cannam@0 209 <div class="memitem">
cannam@0 210 <div class="memproto">
cannam@0 211 <table class="memname">
cannam@0 212 <tr>
cannam@0 213 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a> </td>
cannam@0 214 </tr>
cannam@0 215 </table>
cannam@0 216 </div>
cannam@0 217 <div class="memdoc">
cannam@0 218
cannam@0 219 <p>
cannam@0 220 1 if parameter values are quantized to a particular resolution.
cannam@0 221 <p>
cannam@0 222
cannam@0 223 <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>
cannam@0 224
cannam@0 225 </div>
cannam@0 226 </div><p>
cannam@0 227 <a class="anchor" name="68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="68c91fd3fc0b0b3617c2d343fe32d0e5" args="" -->
cannam@0 228 <div class="memitem">
cannam@0 229 <div class="memproto">
cannam@0 230 <table class="memname">
cannam@0 231 <tr>
cannam@0 232 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a> </td>
cannam@0 233 </tr>
cannam@0 234 </table>
cannam@0 235 </div>
cannam@0 236 <div class="memdoc">
cannam@0 237
cannam@0 238 <p>
cannam@0 239 Quantization resolution, if isQuantized.
cannam@0 240 <p>
cannam@0 241
cannam@0 242 <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>
cannam@0 243
cannam@0 244 </div>
cannam@0 245 </div><p>
cannam@0 246 <a class="anchor" name="188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="188883325ab1e4a898e3dc53a8f88f9d" args="" -->
cannam@0 247 <div class="memitem">
cannam@0 248 <div class="memproto">
cannam@0 249 <table class="memname">
cannam@0 250 <tr>
cannam@0 251 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a> </td>
cannam@0 252 </tr>
cannam@0 253 </table>
cannam@0 254 </div>
cannam@0 255 <div class="memdoc">
cannam@0 256
cannam@0 257 <p>
cannam@0 258 Human-readable names of the values, if isQuantized.
cannam@0 259 <p>
cannam@0 260 May be NULL.
cannam@0 261 <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>
cannam@0 262
cannam@0 263 </div>
cannam@0 264 </div><p>
cannam@0 265 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@0 266 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul>
cannam@0 267 </div>
cannam@35 268 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by&nbsp;
cannam@0 269 <a href="http://www.doxygen.org/index.html">
cannam@35 270 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 271 </body>
cannam@0 272 </html>