Mercurial > hg > vamp-website

comparison code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title> 3 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </div>
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> 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>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
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> 29 <h1>Vamp::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>
30 <p> 30 <p>
31 31
32 <p> 32 <p>
33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
34 34
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> 35 <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>
36 <table border="0" cellpadding="0" cellspacing="0"> 36 <table border="0" cellpadding="0" cellspacing="0">
37 <tr><td></td></tr> 37 <tr><td></td></tr>
38 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
39 <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#5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr>
40
38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 41 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
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> 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#116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr>
40 43
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> 44 <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>
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> 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#0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr>
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> 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#01f8387e7c853d5e4e35d4e9a37353d7"></a><br></td></tr>
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> 69 <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>
67 70
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#94df96f53835980b4739965007ff222b"></a><br></td></tr> 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#94df96f53835980b4739965007ff222b"></a><br></td></tr>
69 </table> 72 </table>
73 <hr><h2>Constructor &amp; Destructor Documentation</h2>
74 <a class="anchor" name="5b793130e9746b2302317b3c9a9c1395"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="5b793130e9746b2302317b3c9a9c1395" args="()" -->
75 <div class="memitem">
76 <div class="memproto">
77 <table class="memname">
78 <tr>
79 <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor </td>
80 <td>(</td>
81 <td class="paramname"> </td>
82 <td>&nbsp;)&nbsp;</td>
83 <td><code> [inline]</code></td>
84 </tr>
85 </table>
86 </div>
87 <div class="memdoc">
88
89 <p>
90
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>
92
93 </div>
94 </div><p>
70 <hr><h2>Member Data Documentation</h2> 95 <hr><h2>Member Data Documentation</h2>
71 <a class="anchor" name="116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="116fd9f0dc94c2bc4bbc60b5443c598c" args="" --> 96 <a class="anchor" name="116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="116fd9f0dc94c2bc4bbc60b5443c598c" args="" -->
72 <div class="memitem"> 97 <div class="memitem">
73 <div class="memproto"> 98 <div class="memproto">
74 <table class="memname"> 99 <table class="memname">
81 106
82 <p> 107 <p>
83 The name of the parameter, in computer-usable form. 108 The name of the parameter, in computer-usable form.
84 <p> 109 <p>
85 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. 110 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
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> 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>
87 112
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
89 114
90 </div> 115 </div>
91 </div><p> 116 </div><p>
92 <a class="anchor" name="0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="0ecebb94fb4ada4aad2640e20aa57084" args="" --> 117 <a class="anchor" name="0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="0ecebb94fb4ada4aad2640e20aa57084" args="" -->
93 <div class="memitem"> 118 <div class="memitem">
102 127
103 <p> 128 <p>
104 The human-readable name of the parameter. 129 The human-readable name of the parameter.
105 <p> 130 <p>
106 131
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> 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>
108 133
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
110 135
111 </div> 136 </div>
112 </div><p> 137 </div><p>
113 <a class="anchor" name="780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="780ddad41e433d85c82f9ea4d959cbaf" args="" --> 138 <a class="anchor" name="780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="780ddad41e433d85c82f9ea4d959cbaf" args="" -->
114 <div class="memitem"> 139 <div class="memitem">
123 148
124 <p> 149 <p>
125 A human-readable short text describing the parameter. 150 A human-readable short text describing the parameter.
126 <p> 151 <p>
127 May be empty if the name has said it all already. 152 May be empty if the name has said it all already.
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> 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>
129 154
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
131 156
132 </div> 157 </div>
133 </div><p> 158 </div><p>
134 <a class="anchor" name="3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="3bc3df322e4c02e17e96bc6d44982d7b" args="" --> 159 <a class="anchor" name="3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="3bc3df322e4c02e17e96bc6d44982d7b" args="" -->
135 <div class="memitem"> 160 <div class="memitem">
144 169
145 <p> 170 <p>
146 The unit of the parameter, in human-readable form. 171 The unit of the parameter, in human-readable form.
147 <p> 172 <p>
148 173
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> 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>
150 175
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
152 177
153 </div> 178 </div>
154 </div><p> 179 </div><p>
155 <a class="anchor" name="b3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="b3e4d84f5bc199eea8b642b27e425ec8" args="" --> 180 <a class="anchor" name="b3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="b3e4d84f5bc199eea8b642b27e425ec8" args="" -->
156 <div class="memitem"> 181 <div class="memitem">
165 190
166 <p> 191 <p>
167 The minimum value of the parameter. 192 The minimum value of the parameter.
168 <p> 193 <p>
169 194
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> 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>
171 196
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
173 198
174 </div> 199 </div>
175 </div><p> 200 </div><p>
176 <a class="anchor" name="b934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="b934b20dd708228a0e3c2811a3e2cec4" args="" --> 201 <a class="anchor" name="b934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="b934b20dd708228a0e3c2811a3e2cec4" args="" -->
177 <div class="memitem"> 202 <div class="memitem">
186 211
187 <p> 212 <p>
188 The maximum value of the parameter. 213 The maximum value of the parameter.
189 <p> 214 <p>
190 215
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> 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>
192 217
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
194 219
195 </div> 220 </div>
196 </div><p> 221 </div><p>
197 <a class="anchor" name="ec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="ec4ef77451ec02193ecc4a0856673fbc" args="" --> 222 <a class="anchor" name="ec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="ec4ef77451ec02193ecc4a0856673fbc" args="" -->
198 <div class="memitem"> 223 <div class="memitem">
207 232
208 <p> 233 <p>
209 The default value of the parameter. 234 The default value of the parameter.
210 <p> 235 <p>
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). 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).
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> 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>
213 238
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
215 240
216 </div> 241 </div>
217 </div><p> 242 </div><p>
218 <a class="anchor" name="7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="7c556d58d552f737ee5a34efdf7f9425" args="" --> 243 <a class="anchor" name="7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="7c556d58d552f737ee5a34efdf7f9425" args="" -->
219 <div class="memitem"> 244 <div class="memitem">
228 253
229 <p> 254 <p>
230 True if the parameter values are quantized to a particular resolution. 255 True if the parameter values are quantized to a particular resolution.
231 <p> 256 <p>
232 257
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> 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>
234 259
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> 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::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
236 261
237 </div> 262 </div>
238 </div><p> 263 </div><p>
239 <a class="anchor" name="01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="01f8387e7c853d5e4e35d4e9a37353d7" args="" --> 264 <a class="anchor" name="01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="01f8387e7c853d5e4e35d4e9a37353d7" args="" -->
240 <div class="memitem"> 265 <div class="memitem">
249 274
250 <p> 275 <p>
251 Quantization resolution of the parameter values (e.g. 276 Quantization resolution of the parameter values (e.g.
252 <p> 277 <p>
253 1.0 if they are all integers). Undefined if isQuantized is false. 278 1.0 if they are all integers). Undefined if isQuantized is false.
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> 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>
255
256 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
257 280
258 </div> 281 </div>
259 </div><p> 282 </div><p>
260 <a class="anchor" name="94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="94df96f53835980b4739965007ff222b" args="" --> 283 <a class="anchor" name="94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="94df96f53835980b4739965007ff222b" args="" -->
261 <div class="memitem"> 284 <div class="memitem">
271 <p> 294 <p>
272 Names for the quantized values. 295 Names for the quantized values.
273 <p> 296 <p>
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> 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>
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. 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.
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> 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>
277
278 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p>
279 300
280 </div> 301 </div>
281 </div><p> 302 </div><p>
282 <hr>The documentation for this struct was generated from the following file:<ul> 303 <hr>The documentation for this struct was generated from the following file:<ul>
283 <li><a class="el" href="PluginBase_8h-source.html">PluginBase.h</a></ul> 304 <li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul>
284 </div> 305 </div>
285 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:10 2008 for VampPluginSDK by&nbsp; 306 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp;
286 <a href="http://www.doxygen.org/index.html"> 307 <a href="http://www.doxygen.org/index.html">
287 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 308 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
288 </body> 309 </body>
289 </html> 310 </html>