annotate code-doc/struct__VampParameterDescriptor.html @ 128:817c3988afc7 website tip

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