Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@1 6 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title>
Chris@1 7
Chris@1 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 11 <script type="text/javascript" src="jquery.js"></script>
Chris@1 12 <script type="text/javascript" src="resize.js"></script>
Chris@1 13 <script type="text/javascript" src="navtree.js"></script>
Chris@1 14 <script type="text/javascript">
Chris@1 15 $(document).ready(initResizable);
Chris@1 16 </script>
Chris@1 17
Chris@1 18
Chris@1 19 </head>
Chris@1 20 <body>
Chris@1 21 <div id="top"><!-- do not remove this div! -->
Chris@1 22
Chris@1 23
Chris@1 24 <div id="titlearea">
Chris@1 25 <table cellspacing="0" cellpadding="0">
Chris@1 26 <tbody>
Chris@1 27 <tr style="height: 56px;">
Chris@1 28
Chris@1 29
Chris@1 30 <td style="padding-left: 0.5em;">
Chris@1 31 <div id="projectname">VampPluginSDK
Chris@3 32 &#160;<span id="projectnumber">2.4</span>
Chris@1 33 </div>
Chris@1 34
Chris@1 35 </td>
Chris@1 36
Chris@1 37
Chris@1 38
Chris@1 39 </tr>
Chris@1 40 </tbody>
Chris@1 41 </table>
Chris@1 42 </div>
Chris@1 43
Chris@3 44 <!-- Generated by Doxygen 1.8.0 -->
Chris@1 45 <div id="navrow1" class="tabs">
Chris@1 46 <ul class="tablist">
Chris@1 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 50 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 51 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 52 </ul>
Chris@1 53 </div>
Chris@1 54 <div id="navrow2" class="tabs2">
Chris@1 55 <ul class="tablist">
Chris@1 56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 59 </ul>
Chris@1 60 </div>
Chris@1 61 </div>
Chris@1 62 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 63 <div id="nav-tree">
Chris@1 64 <div id="nav-tree-contents">
Chris@1 65 </div>
Chris@1 66 </div>
Chris@1 67 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 68 class="ui-resizable-handle">
Chris@1 69 </div>
Chris@1 70 </div>
Chris@1 71 <script type="text/javascript">
Chris@1 72 initNavTree('structVamp_1_1PluginBase_1_1ParameterDescriptor.html','');
Chris@1 73 </script>
Chris@1 74 <div id="doc-content">
Chris@1 75 <div class="header">
Chris@1 76 <div class="summary">
Chris@1 77 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 78 <a href="#pub-attribs">Public Attributes</a> </div>
Chris@1 79 <div class="headertitle">
Chris@1 80 <div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div>
Chris@3 81 </div><!--header-->
Chris@1 82 <div class="contents">
Chris@3 83
Chris@1 84 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p>
Chris@1 85
Chris@1 86 <p><a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a></p>
Chris@1 87 <table class="memberdecls">
Chris@1 88 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 89 Public Member Functions</h2></td></tr>
Chris@3 90 <tr class="memitem:a5b793130e9746b2302317b3c9a9c1395"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr>
Chris@1 91 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
Chris@1 92 Public Attributes</h2></td></tr>
Chris@3 93 <tr class="memitem:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr>
Chris@3 94 <tr class="memdesc:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#a116fd9f0dc94c2bc4bbc60b5443c598c"></a><br/></td></tr>
Chris@3 95 <tr class="memitem:a0ecebb94fb4ada4aad2640e20aa57084"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr>
Chris@3 96 <tr class="memdesc:a0ecebb94fb4ada4aad2640e20aa57084"><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#a0ecebb94fb4ada4aad2640e20aa57084"></a><br/></td></tr>
Chris@3 97 <tr class="memitem:a780ddad41e433d85c82f9ea4d959cbaf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr>
Chris@3 98 <tr class="memdesc:a780ddad41e433d85c82f9ea4d959cbaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#a780ddad41e433d85c82f9ea4d959cbaf"></a><br/></td></tr>
Chris@3 99 <tr class="memitem:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr>
Chris@3 100 <tr class="memdesc:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#a3bc3df322e4c02e17e96bc6d44982d7b"></a><br/></td></tr>
Chris@3 101 <tr class="memitem:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr>
Chris@3 102 <tr class="memdesc:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum value of the parameter. <a href="#ab3e4d84f5bc199eea8b642b27e425ec8"></a><br/></td></tr>
Chris@3 103 <tr class="memitem:ab934b20dd708228a0e3c2811a3e2cec4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr>
Chris@3 104 <tr class="memdesc:ab934b20dd708228a0e3c2811a3e2cec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum value of the parameter. <a href="#ab934b20dd708228a0e3c2811a3e2cec4"></a><br/></td></tr>
Chris@3 105 <tr class="memitem:aec4ef77451ec02193ecc4a0856673fbc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr>
Chris@3 106 <tr class="memdesc:aec4ef77451ec02193ecc4a0856673fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value of the parameter. <a href="#aec4ef77451ec02193ecc4a0856673fbc"></a><br/></td></tr>
Chris@3 107 <tr class="memitem:a7c556d58d552f737ee5a34efdf7f9425"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr>
Chris@3 108 <tr class="memdesc:a7c556d58d552f737ee5a34efdf7f9425"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#a7c556d58d552f737ee5a34efdf7f9425"></a><br/></td></tr>
Chris@3 109 <tr class="memitem:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr>
Chris@3 110 <tr class="memdesc:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#a01f8387e7c853d5e4e35d4e9a37353d7"></a><br/></td></tr>
Chris@3 111 <tr class="memitem:a94df96f53835980b4739965007ff222b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">valueNames</a></td></tr>
Chris@3 112 <tr class="memdesc:a94df96f53835980b4739965007ff222b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Names for the quantized values. <a href="#a94df96f53835980b4739965007ff222b"></a><br/></td></tr>
Chris@1 113 </table>
Chris@1 114 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 115 <div class="textblock">
Chris@3 116 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00126">126</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 117 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@3 118 <a class="anchor" id="a5b793130e9746b2302317b3c9a9c1395"></a>
Chris@1 119 <div class="memitem">
Chris@1 120 <div class="memproto">
Chris@1 121 <table class="memname">
Chris@1 122 <tr>
Chris@3 123 <td class="memname"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor</a> </td>
Chris@1 124 <td>(</td>
Chris@1 125 <td class="paramname"></td><td>)</td>
Chris@1 126 <td><code> [inline]</code></td>
Chris@1 127 </tr>
Chris@1 128 </table>
Chris@1 129 </div>
Chris@1 130 <div class="memdoc">
Chris@1 131
Chris@3 132 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00195">195</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 133
Chris@1 134 </div>
Chris@1 135 </div>
Chris@1 136 <hr/><h2>Member Data Documentation</h2>
Chris@3 137 <a class="anchor" id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a>
Chris@1 138 <div class="memitem">
Chris@1 139 <div class="memproto">
Chris@1 140 <table class="memname">
Chris@1 141 <tr>
Chris@1 142 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a></td>
Chris@1 143 </tr>
Chris@1 144 </table>
Chris@1 145 </div>
Chris@1 146 <div class="memdoc">
Chris@1 147
Chris@1 148 <p>The name of the parameter, in computer-usable form. </p>
Chris@1 149 <p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p>
Chris@1 150
Chris@3 151 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">133</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 152
Chris@1 153 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 154
Chris@1 155 </div>
Chris@1 156 </div>
Chris@3 157 <a class="anchor" id="a0ecebb94fb4ada4aad2640e20aa57084"></a>
Chris@1 158 <div class="memitem">
Chris@1 159 <div class="memproto">
Chris@1 160 <table class="memname">
Chris@1 161 <tr>
Chris@1 162 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a></td>
Chris@1 163 </tr>
Chris@1 164 </table>
Chris@1 165 </div>
Chris@1 166 <div class="memdoc">
Chris@1 167
Chris@1 168 <p>The human-readable name of the parameter. </p>
Chris@1 169
Chris@3 170 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">138</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 171
Chris@1 172 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 173
Chris@1 174 </div>
Chris@1 175 </div>
Chris@3 176 <a class="anchor" id="a780ddad41e433d85c82f9ea4d959cbaf"></a>
Chris@1 177 <div class="memitem">
Chris@1 178 <div class="memproto">
Chris@1 179 <table class="memname">
Chris@1 180 <tr>
Chris@1 181 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a></td>
Chris@1 182 </tr>
Chris@1 183 </table>
Chris@1 184 </div>
Chris@1 185 <div class="memdoc">
Chris@1 186
Chris@1 187 <p>A human-readable short text describing the parameter. </p>
Chris@1 188 <p>May be empty if the name has said it all already. </p>
Chris@1 189
Chris@3 190 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">144</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 191
Chris@1 192 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 193
Chris@1 194 </div>
Chris@1 195 </div>
Chris@3 196 <a class="anchor" id="a3bc3df322e4c02e17e96bc6d44982d7b"></a>
Chris@1 197 <div class="memitem">
Chris@1 198 <div class="memproto">
Chris@1 199 <table class="memname">
Chris@1 200 <tr>
Chris@1 201 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a></td>
Chris@1 202 </tr>
Chris@1 203 </table>
Chris@1 204 </div>
Chris@1 205 <div class="memdoc">
Chris@1 206
Chris@1 207 <p>The unit of the parameter, in human-readable form. </p>
Chris@1 208
Chris@3 209 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">149</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 210
Chris@1 211 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 212
Chris@1 213 </div>
Chris@1 214 </div>
Chris@3 215 <a class="anchor" id="ab3e4d84f5bc199eea8b642b27e425ec8"></a>
Chris@1 216 <div class="memitem">
Chris@1 217 <div class="memproto">
Chris@1 218 <table class="memname">
Chris@1 219 <tr>
Chris@1 220 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a></td>
Chris@1 221 </tr>
Chris@1 222 </table>
Chris@1 223 </div>
Chris@1 224 <div class="memdoc">
Chris@1 225
Chris@1 226 <p>The minimum value of the parameter. </p>
Chris@1 227
Chris@3 228 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">154</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 229
Chris@1 230 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 231
Chris@1 232 </div>
Chris@1 233 </div>
Chris@3 234 <a class="anchor" id="ab934b20dd708228a0e3c2811a3e2cec4"></a>
Chris@1 235 <div class="memitem">
Chris@1 236 <div class="memproto">
Chris@1 237 <table class="memname">
Chris@1 238 <tr>
Chris@1 239 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a></td>
Chris@1 240 </tr>
Chris@1 241 </table>
Chris@1 242 </div>
Chris@1 243 <div class="memdoc">
Chris@1 244
Chris@1 245 <p>The maximum value of the parameter. </p>
Chris@1 246
Chris@3 247 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">159</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 248
Chris@1 249 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 250
Chris@1 251 </div>
Chris@1 252 </div>
Chris@3 253 <a class="anchor" id="aec4ef77451ec02193ecc4a0856673fbc"></a>
Chris@1 254 <div class="memitem">
Chris@1 255 <div class="memproto">
Chris@1 256 <table class="memname">
Chris@1 257 <tr>
Chris@1 258 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a></td>
Chris@1 259 </tr>
Chris@1 260 </table>
Chris@1 261 </div>
Chris@1 262 <div class="memdoc">
Chris@1 263
Chris@1 264 <p>The default value of the parameter. </p>
Chris@1 265 <p>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). </p>
Chris@1 266
Chris@3 267 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">167</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 268
Chris@1 269 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 270
Chris@1 271 </div>
Chris@1 272 </div>
Chris@3 273 <a class="anchor" id="a7c556d58d552f737ee5a34efdf7f9425"></a>
Chris@1 274 <div class="memitem">
Chris@1 275 <div class="memproto">
Chris@1 276 <table class="memname">
Chris@1 277 <tr>
Chris@1 278 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a></td>
Chris@1 279 </tr>
Chris@1 280 </table>
Chris@1 281 </div>
Chris@1 282 <div class="memdoc">
Chris@1 283
Chris@1 284 <p>True if the parameter values are quantized to a particular resolution. </p>
Chris@1 285
Chris@3 286 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">173</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 287
Chris@1 288 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::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>
Chris@1 289
Chris@1 290 </div>
Chris@1 291 </div>
Chris@3 292 <a class="anchor" id="a01f8387e7c853d5e4e35d4e9a37353d7"></a>
Chris@1 293 <div class="memitem">
Chris@1 294 <div class="memproto">
Chris@1 295 <table class="memname">
Chris@1 296 <tr>
Chris@1 297 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a></td>
Chris@1 298 </tr>
Chris@1 299 </table>
Chris@1 300 </div>
Chris@1 301 <div class="memdoc">
Chris@1 302
Chris@1 303 <p>Quantization resolution of the parameter values (e.g. </p>
Chris@1 304 <p>1.0 if they are all integers). Undefined if isQuantized is false. </p>
Chris@1 305
Chris@3 306 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00180">180</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 307
Chris@1 308 </div>
Chris@1 309 </div>
Chris@3 310 <a class="anchor" id="a94df96f53835980b4739965007ff222b"></a>
Chris@1 311 <div class="memitem">
Chris@1 312 <div class="memproto">
Chris@1 313 <table class="memname">
Chris@1 314 <tr>
Chris@1 315 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">Vamp::PluginBase::ParameterDescriptor::valueNames</a></td>
Chris@1 316 </tr>
Chris@1 317 </table>
Chris@1 318 </div>
Chris@1 319 <div class="memdoc">
Chris@1 320
Chris@1 321 <p>Names for the quantized values. </p>
Chris@1 322 <p>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>
Chris@1 323 <p>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. </p>
Chris@1 324
Chris@3 325 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00193">193</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
Chris@1 326
Chris@1 327 </div>
Chris@1 328 </div>
Chris@1 329 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 330 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
Chris@1 331 </ul>
Chris@3 332 </div><!-- contents -->
Chris@1 333 </div>
Chris@1 334 <div id="nav-path" class="navpath">
Chris@1 335 <ul>
Chris@1 336 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@1 337 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li>
Chris@1 338 <li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> </li>
Chris@1 339
Chris@3 340 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
Chris@1 341 <a href="http://www.doxygen.org/index.html">
Chris@3 342 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
Chris@1 343 </ul>
Chris@1 344 </div>
Chris@1 345
Chris@1 346
Chris@1 347 </body>
Chris@1 348 </html>