Mercurial > hg > vamp-website

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

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