Mercurial > hg > vamp-website

annotate code-doc/struct__VampParameterDescriptor.html @ 28:68ef31b9dc44 website

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