Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 7:66d125fb8b42 tip

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