Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.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@35 3 <title>VampPluginSDK: Vamp::PluginBase::PluginBase::ParameterDescriptor 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 class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a>::<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::PluginBase::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@35 33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@35 34 <tr><td></td></tr>
cannam@35 35 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@35 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7759ab75c33d0f4d8bc85c755bfb10f3">ParameterDescriptor</a> ()</td></tr>
cannam@35 37
cannam@35 38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@35 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b34ea7114875647281ac031021e45d06">identifier</a></td></tr>
cannam@35 40
cannam@35 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#b34ea7114875647281ac031021e45d06"></a><br></td></tr>
cannam@35 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#2c1000e78a6414dab6c5af5201053741">name</a></td></tr>
cannam@35 43
cannam@35 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#2c1000e78a6414dab6c5af5201053741"></a><br></td></tr>
cannam@35 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0cbc8fe35b0d15fd8e19de2ade33d147">description</a></td></tr>
cannam@35 46
cannam@35 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#0cbc8fe35b0d15fd8e19de2ade33d147"></a><br></td></tr>
cannam@35 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#e0d6c74d915b99bacb55a0622e0ecb1c">unit</a></td></tr>
cannam@35 49
cannam@35 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#e0d6c74d915b99bacb55a0622e0ecb1c"></a><br></td></tr>
cannam@35 51 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#18221c4bb5c57332fe6a1393c5ec3b6d">minValue</a></td></tr>
cannam@35 52
cannam@35 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The minimum value of the parameter. <a href="#18221c4bb5c57332fe6a1393c5ec3b6d"></a><br></td></tr>
cannam@35 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#52e0c1f0acfc7ff8622ca1ccc97ad69d">maxValue</a></td></tr>
cannam@35 55
cannam@35 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value of the parameter. <a href="#52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><br></td></tr>
cannam@35 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#4b36674815777f54846bb7033205bbea">defaultValue</a></td></tr>
cannam@35 58
cannam@35 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default value of the parameter. <a href="#4b36674815777f54846bb7033205bbea"></a><br></td></tr>
cannam@35 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#6e76a119dafbdd26351521ec486550ea">isQuantized</a></td></tr>
cannam@35 61
cannam@35 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#6e76a119dafbdd26351521ec486550ea"></a><br></td></tr>
cannam@35 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0b84d9928f1ecce8663335f6a80ad2b1">quantizeStep</a></td></tr>
cannam@35 64
cannam@35 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#0b84d9928f1ecce8663335f6a80ad2b1"></a><br></td></tr>
cannam@35 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0a4ab495e32d7746f2c55a5a59af1adc">valueNames</a></td></tr>
cannam@35 67
cannam@35 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#0a4ab495e32d7746f2c55a5a59af1adc"></a><br></td></tr>
cannam@35 69 </table>
cannam@35 70 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 71
cannam@21 72 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00130">130</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@21 73 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@35 74 <a class="anchor" name="7759ab75c33d0f4d8bc85c755bfb10f3"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="7759ab75c33d0f4d8bc85c755bfb10f3" args="()" -->
cannam@21 75 <div class="memitem">
cannam@21 76 <div class="memproto">
cannam@21 77 <table class="memname">
cannam@21 78 <tr>
cannam@35 79 <td class="memname">Vamp::PluginBase::PluginBase::ParameterDescriptor::ParameterDescriptor </td>
cannam@21 80 <td>(</td>
cannam@21 81 <td class="paramname"> </td>
cannam@21 82 <td>&nbsp;)&nbsp;</td>
cannam@21 83 <td><code> [inline]</code></td>
cannam@21 84 </tr>
cannam@21 85 </table>
cannam@21 86 </div>
cannam@21 87 <div class="memdoc">
cannam@21 88
cannam@21 89 <p>
cannam@21 90
cannam@21 91 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@21 92
cannam@21 93 </div>
cannam@21 94 </div><p>
cannam@0 95 <hr><h2>Member Data Documentation</h2>
cannam@35 96 <a class="anchor" name="b34ea7114875647281ac031021e45d06"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="b34ea7114875647281ac031021e45d06" args="" -->
cannam@0 97 <div class="memitem">
cannam@0 98 <div class="memproto">
cannam@0 99 <table class="memname">
cannam@0 100 <tr>
cannam@35 101 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier </td>
cannam@0 102 </tr>
cannam@0 103 </table>
cannam@0 104 </div>
cannam@0 105 <div class="memdoc">
cannam@0 106
cannam@0 107 <p>
cannam@0 108 The name of the parameter, in computer-usable form.
cannam@0 109 <p>
cannam@0 110 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
cannam@21 111 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 112
cannam@35 113 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 114
cannam@0 115 </div>
cannam@0 116 </div><p>
cannam@35 117 <a class="anchor" name="2c1000e78a6414dab6c5af5201053741"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="2c1000e78a6414dab6c5af5201053741" args="" -->
cannam@0 118 <div class="memitem">
cannam@0 119 <div class="memproto">
cannam@0 120 <table class="memname">
cannam@0 121 <tr>
cannam@35 122 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::name </td>
cannam@0 123 </tr>
cannam@0 124 </table>
cannam@0 125 </div>
cannam@0 126 <div class="memdoc">
cannam@0 127
cannam@0 128 <p>
cannam@0 129 The human-readable name of the parameter.
cannam@0 130 <p>
cannam@0 131
cannam@21 132 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 133
cannam@35 134 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 135
cannam@0 136 </div>
cannam@0 137 </div><p>
cannam@35 138 <a class="anchor" name="0cbc8fe35b0d15fd8e19de2ade33d147"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="0cbc8fe35b0d15fd8e19de2ade33d147" args="" -->
cannam@0 139 <div class="memitem">
cannam@0 140 <div class="memproto">
cannam@0 141 <table class="memname">
cannam@0 142 <tr>
cannam@35 143 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::description </td>
cannam@0 144 </tr>
cannam@0 145 </table>
cannam@0 146 </div>
cannam@0 147 <div class="memdoc">
cannam@0 148
cannam@0 149 <p>
cannam@0 150 A human-readable short text describing the parameter.
cannam@0 151 <p>
cannam@0 152 May be empty if the name has said it all already.
cannam@21 153 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 154
cannam@35 155 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 156
cannam@0 157 </div>
cannam@0 158 </div><p>
cannam@35 159 <a class="anchor" name="e0d6c74d915b99bacb55a0622e0ecb1c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="e0d6c74d915b99bacb55a0622e0ecb1c" args="" -->
cannam@0 160 <div class="memitem">
cannam@0 161 <div class="memproto">
cannam@0 162 <table class="memname">
cannam@0 163 <tr>
cannam@35 164 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::unit </td>
cannam@0 165 </tr>
cannam@0 166 </table>
cannam@0 167 </div>
cannam@0 168 <div class="memdoc">
cannam@0 169
cannam@0 170 <p>
cannam@0 171 The unit of the parameter, in human-readable form.
cannam@0 172 <p>
cannam@0 173
cannam@21 174 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 175
cannam@35 176 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 177
cannam@0 178 </div>
cannam@0 179 </div><p>
cannam@35 180 <a class="anchor" name="18221c4bb5c57332fe6a1393c5ec3b6d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="18221c4bb5c57332fe6a1393c5ec3b6d" args="" -->
cannam@0 181 <div class="memitem">
cannam@0 182 <div class="memproto">
cannam@0 183 <table class="memname">
cannam@0 184 <tr>
cannam@35 185 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue </td>
cannam@0 186 </tr>
cannam@0 187 </table>
cannam@0 188 </div>
cannam@0 189 <div class="memdoc">
cannam@0 190
cannam@0 191 <p>
cannam@0 192 The minimum value of the parameter.
cannam@0 193 <p>
cannam@0 194
cannam@21 195 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 196
cannam@35 197 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 198
cannam@0 199 </div>
cannam@0 200 </div><p>
cannam@35 201 <a class="anchor" name="52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="52e0c1f0acfc7ff8622ca1ccc97ad69d" args="" -->
cannam@0 202 <div class="memitem">
cannam@0 203 <div class="memproto">
cannam@0 204 <table class="memname">
cannam@0 205 <tr>
cannam@35 206 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue </td>
cannam@0 207 </tr>
cannam@0 208 </table>
cannam@0 209 </div>
cannam@0 210 <div class="memdoc">
cannam@0 211
cannam@0 212 <p>
cannam@0 213 The maximum value of the parameter.
cannam@0 214 <p>
cannam@0 215
cannam@21 216 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 217
cannam@35 218 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 219
cannam@0 220 </div>
cannam@0 221 </div><p>
cannam@35 222 <a class="anchor" name="4b36674815777f54846bb7033205bbea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="4b36674815777f54846bb7033205bbea" args="" -->
cannam@0 223 <div class="memitem">
cannam@0 224 <div class="memproto">
cannam@0 225 <table class="memname">
cannam@0 226 <tr>
cannam@35 227 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue </td>
cannam@0 228 </tr>
cannam@0 229 </table>
cannam@0 230 </div>
cannam@0 231 <div class="memdoc">
cannam@0 232
cannam@0 233 <p>
cannam@0 234 The default value of the parameter.
cannam@0 235 <p>
cannam@0 236 The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values).
cannam@21 237 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 238
cannam@35 239 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 240
cannam@0 241 </div>
cannam@0 242 </div><p>
cannam@35 243 <a class="anchor" name="6e76a119dafbdd26351521ec486550ea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="6e76a119dafbdd26351521ec486550ea" args="" -->
cannam@0 244 <div class="memitem">
cannam@0 245 <div class="memproto">
cannam@0 246 <table class="memname">
cannam@0 247 <tr>
cannam@35 248 <td class="memname">bool Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized </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 True if the parameter values are quantized to a particular resolution.
cannam@0 256 <p>
cannam@0 257
cannam@21 258 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 259
cannam@35 260 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 261
cannam@0 262 </div>
cannam@0 263 </div><p>
cannam@35 264 <a class="anchor" name="0b84d9928f1ecce8663335f6a80ad2b1"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="0b84d9928f1ecce8663335f6a80ad2b1" args="" -->
cannam@0 265 <div class="memitem">
cannam@0 266 <div class="memproto">
cannam@0 267 <table class="memname">
cannam@0 268 <tr>
cannam@35 269 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::quantizeStep </td>
cannam@0 270 </tr>
cannam@0 271 </table>
cannam@0 272 </div>
cannam@0 273 <div class="memdoc">
cannam@0 274
cannam@0 275 <p>
cannam@0 276 Quantization resolution of the parameter values (e.g.
cannam@0 277 <p>
cannam@0 278 1.0 if they are all integers). Undefined if isQuantized is false.
cannam@21 279 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 280
cannam@0 281 </div>
cannam@0 282 </div><p>
cannam@35 283 <a class="anchor" name="0a4ab495e32d7746f2c55a5a59af1adc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="0a4ab495e32d7746f2c55a5a59af1adc" args="" -->
cannam@0 284 <div class="memitem">
cannam@0 285 <div class="memproto">
cannam@0 286 <table class="memname">
cannam@0 287 <tr>
cannam@35 288 <td class="memname">std::vector&lt;std::string&gt; Vamp::PluginBase::PluginBase::ParameterDescriptor::valueNames </td>
cannam@0 289 </tr>
cannam@0 290 </table>
cannam@0 291 </div>
cannam@0 292 <div class="memdoc">
cannam@0 293
cannam@0 294 <p>
cannam@0 295 Names for the quantized values.
cannam@0 296 <p>
cannam@0 297 If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.<p>
cannam@0 298 If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names.
cannam@21 299 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00197">197</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
cannam@0 300
cannam@0 301 </div>
cannam@0 302 </div><p>
cannam@0 303 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@21 304 <li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul>
cannam@0 305 </div>
cannam@35 306 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 307 <a href="http://www.doxygen.org/index.html">
cannam@35 308 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 309 </body>
cannam@0 310 </html>