Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 1:632b1ffb5fb2 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Add some more provisional RDFs plus index
author cannam
date Fri, 17 Oct 2008 14:53:59 +0000
parents 351c4ebce5f9
children cc0be37dc9d3
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: Vamp::PluginBase::ParameterDescriptor 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@0 7 <!-- Generated by Doxygen 1.5.5 -->
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@0 29 <h1>Vamp::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@0 33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 34
cannam@0 35 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00125">125</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 36 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 37 <tr><td></td></tr>
cannam@0 38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@0 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#116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr>
cannam@0 40
cannam@0 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#116fd9f0dc94c2bc4bbc60b5443c598c"></a><br></td></tr>
cannam@0 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#0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr>
cannam@0 43
cannam@0 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#0ecebb94fb4ada4aad2640e20aa57084"></a><br></td></tr>
cannam@0 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#780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr>
cannam@0 46
cannam@0 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#780ddad41e433d85c82f9ea4d959cbaf"></a><br></td></tr>
cannam@0 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#3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr>
cannam@0 49
cannam@0 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#3bc3df322e4c02e17e96bc6d44982d7b"></a><br></td></tr>
cannam@0 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#b3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr>
cannam@0 52
cannam@0 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The minimum value of the parameter. <a href="#b3e4d84f5bc199eea8b642b27e425ec8"></a><br></td></tr>
cannam@0 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#b934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr>
cannam@0 55
cannam@0 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value of the parameter. <a href="#b934b20dd708228a0e3c2811a3e2cec4"></a><br></td></tr>
cannam@0 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#ec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr>
cannam@0 58
cannam@0 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default value of the parameter. <a href="#ec4ef77451ec02193ecc4a0856673fbc"></a><br></td></tr>
cannam@0 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#7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr>
cannam@0 61
cannam@0 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#7c556d58d552f737ee5a34efdf7f9425"></a><br></td></tr>
cannam@0 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#01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr>
cannam@0 64
cannam@0 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#01f8387e7c853d5e4e35d4e9a37353d7"></a><br></td></tr>
cannam@0 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#94df96f53835980b4739965007ff222b">valueNames</a></td></tr>
cannam@0 67
cannam@0 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#94df96f53835980b4739965007ff222b"></a><br></td></tr>
cannam@0 69 </table>
cannam@0 70 <hr><h2>Member Data Documentation</h2>
cannam@0 71 <a class="anchor" name="116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="116fd9f0dc94c2bc4bbc60b5443c598c" args="" -->
cannam@0 72 <div class="memitem">
cannam@0 73 <div class="memproto">
cannam@0 74 <table class="memname">
cannam@0 75 <tr>
cannam@0 76 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a> </td>
cannam@0 77 </tr>
cannam@0 78 </table>
cannam@0 79 </div>
cannam@0 80 <div class="memdoc">
cannam@0 81
cannam@0 82 <p>
cannam@0 83 The name of the parameter, in computer-usable form.
cannam@0 84 <p>
cannam@0 85 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
cannam@0 86 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00132">132</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 87
cannam@0 88 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 89
cannam@0 90 </div>
cannam@0 91 </div><p>
cannam@0 92 <a class="anchor" name="0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="0ecebb94fb4ada4aad2640e20aa57084" args="" -->
cannam@0 93 <div class="memitem">
cannam@0 94 <div class="memproto">
cannam@0 95 <table class="memname">
cannam@0 96 <tr>
cannam@0 97 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a> </td>
cannam@0 98 </tr>
cannam@0 99 </table>
cannam@0 100 </div>
cannam@0 101 <div class="memdoc">
cannam@0 102
cannam@0 103 <p>
cannam@0 104 The human-readable name of the parameter.
cannam@0 105 <p>
cannam@0 106
cannam@0 107 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 108
cannam@0 109 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 110
cannam@0 111 </div>
cannam@0 112 </div><p>
cannam@0 113 <a class="anchor" name="780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="780ddad41e433d85c82f9ea4d959cbaf" 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">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::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 A human-readable short text describing the parameter.
cannam@0 126 <p>
cannam@0 127 May be empty if the name has said it all already.
cannam@0 128 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00143">143</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 129
cannam@0 130 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 131
cannam@0 132 </div>
cannam@0 133 </div><p>
cannam@0 134 <a class="anchor" name="3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="3bc3df322e4c02e17e96bc6d44982d7b" args="" -->
cannam@0 135 <div class="memitem">
cannam@0 136 <div class="memproto">
cannam@0 137 <table class="memname">
cannam@0 138 <tr>
cannam@0 139 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a> </td>
cannam@0 140 </tr>
cannam@0 141 </table>
cannam@0 142 </div>
cannam@0 143 <div class="memdoc">
cannam@0 144
cannam@0 145 <p>
cannam@0 146 The unit of the parameter, in human-readable form.
cannam@0 147 <p>
cannam@0 148
cannam@0 149 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 150
cannam@0 151 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 152
cannam@0 153 </div>
cannam@0 154 </div><p>
cannam@0 155 <a class="anchor" name="b3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="b3e4d84f5bc199eea8b642b27e425ec8" args="" -->
cannam@0 156 <div class="memitem">
cannam@0 157 <div class="memproto">
cannam@0 158 <table class="memname">
cannam@0 159 <tr>
cannam@0 160 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a> </td>
cannam@0 161 </tr>
cannam@0 162 </table>
cannam@0 163 </div>
cannam@0 164 <div class="memdoc">
cannam@0 165
cannam@0 166 <p>
cannam@0 167 The minimum value of the parameter.
cannam@0 168 <p>
cannam@0 169
cannam@0 170 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 171
cannam@0 172 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 173
cannam@0 174 </div>
cannam@0 175 </div><p>
cannam@0 176 <a class="anchor" name="b934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="b934b20dd708228a0e3c2811a3e2cec4" args="" -->
cannam@0 177 <div class="memitem">
cannam@0 178 <div class="memproto">
cannam@0 179 <table class="memname">
cannam@0 180 <tr>
cannam@0 181 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a> </td>
cannam@0 182 </tr>
cannam@0 183 </table>
cannam@0 184 </div>
cannam@0 185 <div class="memdoc">
cannam@0 186
cannam@0 187 <p>
cannam@0 188 The maximum value of the parameter.
cannam@0 189 <p>
cannam@0 190
cannam@0 191 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 192
cannam@0 193 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 194
cannam@0 195 </div>
cannam@0 196 </div><p>
cannam@0 197 <a class="anchor" name="ec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="ec4ef77451ec02193ecc4a0856673fbc" args="" -->
cannam@0 198 <div class="memitem">
cannam@0 199 <div class="memproto">
cannam@0 200 <table class="memname">
cannam@0 201 <tr>
cannam@0 202 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a> </td>
cannam@0 203 </tr>
cannam@0 204 </table>
cannam@0 205 </div>
cannam@0 206 <div class="memdoc">
cannam@0 207
cannam@0 208 <p>
cannam@0 209 The default value of the parameter.
cannam@0 210 <p>
cannam@0 211 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@0 212 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00166">166</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 213
cannam@0 214 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 215
cannam@0 216 </div>
cannam@0 217 </div><p>
cannam@0 218 <a class="anchor" name="7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="7c556d58d552f737ee5a34efdf7f9425" args="" -->
cannam@0 219 <div class="memitem">
cannam@0 220 <div class="memproto">
cannam@0 221 <table class="memname">
cannam@0 222 <tr>
cannam@0 223 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a> </td>
cannam@0 224 </tr>
cannam@0 225 </table>
cannam@0 226 </div>
cannam@0 227 <div class="memdoc">
cannam@0 228
cannam@0 229 <p>
cannam@0 230 True if the parameter values are quantized to a particular resolution.
cannam@0 231 <p>
cannam@0 232
cannam@0 233 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00172">172</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 234
cannam@0 235 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
cannam@0 236
cannam@0 237 </div>
cannam@0 238 </div><p>
cannam@0 239 <a class="anchor" name="01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="01f8387e7c853d5e4e35d4e9a37353d7" args="" -->
cannam@0 240 <div class="memitem">
cannam@0 241 <div class="memproto">
cannam@0 242 <table class="memname">
cannam@0 243 <tr>
cannam@0 244 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a> </td>
cannam@0 245 </tr>
cannam@0 246 </table>
cannam@0 247 </div>
cannam@0 248 <div class="memdoc">
cannam@0 249
cannam@0 250 <p>
cannam@0 251 Quantization resolution of the parameter values (e.g.
cannam@0 252 <p>
cannam@0 253 1.0 if they are all integers). Undefined if isQuantized is false.
cannam@0 254 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00179">179</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 255
cannam@0 256 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
cannam@0 257
cannam@0 258 </div>
cannam@0 259 </div><p>
cannam@0 260 <a class="anchor" name="94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="94df96f53835980b4739965007ff222b" args="" -->
cannam@0 261 <div class="memitem">
cannam@0 262 <div class="memproto">
cannam@0 263 <table class="memname">
cannam@0 264 <tr>
cannam@0 265 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b">Vamp::PluginBase::ParameterDescriptor::valueNames</a> </td>
cannam@0 266 </tr>
cannam@0 267 </table>
cannam@0 268 </div>
cannam@0 269 <div class="memdoc">
cannam@0 270
cannam@0 271 <p>
cannam@0 272 Names for the quantized values.
cannam@0 273 <p>
cannam@0 274 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 275 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@0 276 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00192">192</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p>
cannam@0 277
cannam@0 278 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
cannam@0 279
cannam@0 280 </div>
cannam@0 281 </div><p>
cannam@0 282 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@0 283 <li><a class="el" href="PluginBase_8h-source.html">PluginBase.h</a></ul>
cannam@0 284 </div>
cannam@0 285 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp;
cannam@0 286 <a href="http://www.doxygen.org/index.html">
cannam@0 287 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 288 </body>
cannam@0 289 </html>