Mercurial > hg > vamp-docs

comparison 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
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
5 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title> 6 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
75 <div class="summary"> 76 <div class="summary">
76 <a href="#pub-methods">Public Member Functions</a> &#124; 77 <a href="#pub-methods">Public Member Functions</a> &#124;
77 <a href="#pub-attribs">Public Attributes</a> </div> 78 <a href="#pub-attribs">Public Attributes</a> </div>
78 <div class="headertitle"> 79 <div class="headertitle">
79 <div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div> 80 <div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div>
80 </div> 81 </div><!--header-->
81 <div class="contents"> 82 <div class="contents">
82 <!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --> 83
83 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p> 84 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p>
84 85
85 <p><a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a></p> 86 <p><a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a></p>
86 <table class="memberdecls"> 87 <table class="memberdecls">
87 <tr><td colspan="2"><h2><a name="pub-methods"></a> 88 <tr><td colspan="2"><h2><a name="pub-methods"></a>
88 Public Member Functions</h2></td></tr> 89 Public Member Functions</h2></td></tr>
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> 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>
90 <tr><td colspan="2"><h2><a name="pub-attribs"></a> 91 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
91 Public Attributes</h2></td></tr> 92 Public Attributes</h2></td></tr>
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> 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>
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> 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>
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> 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>
95 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#a0ecebb94fb4ada4aad2640e20aa57084"></a><br/></td></tr> 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>
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> 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>
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> 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>
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> 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>
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> 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>
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> 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>
101 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum value of the parameter. <a href="#ab3e4d84f5bc199eea8b642b27e425ec8"></a><br/></td></tr> 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>
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> 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>
103 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum value of the parameter. <a href="#ab934b20dd708228a0e3c2811a3e2cec4"></a><br/></td></tr> 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>
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> 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>
105 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value of the parameter. <a href="#aec4ef77451ec02193ecc4a0856673fbc"></a><br/></td></tr> 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>
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> 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>
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> 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>
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> 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>
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> 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>
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> 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>
111 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Names for the quantized values. <a href="#a94df96f53835980b4739965007ff222b"></a><br/></td></tr> 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>
112 </table> 113 </table>
113 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 114 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
114 <div class="textblock"> 115 <div class="textblock">
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> 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>
116 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2> 117 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
117 <a class="anchor" id="a5b793130e9746b2302317b3c9a9c1395"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="a5b793130e9746b2302317b3c9a9c1395" args="()" --> 118 <a class="anchor" id="a5b793130e9746b2302317b3c9a9c1395"></a>
118 <div class="memitem"> 119 <div class="memitem">
119 <div class="memproto"> 120 <div class="memproto">
120 <table class="memname"> 121 <table class="memname">
121 <tr> 122 <tr>
122 <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor </td> 123 <td class="memname"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor</a> </td>
123 <td>(</td> 124 <td>(</td>
124 <td class="paramname"></td><td>)</td> 125 <td class="paramname"></td><td>)</td>
125 <td><code> [inline]</code></td> 126 <td><code> [inline]</code></td>
126 </tr> 127 </tr>
127 </table> 128 </table>
128 </div> 129 </div>
129 <div class="memdoc"> 130 <div class="memdoc">
130 131
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> 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>
132 133
133 </div> 134 </div>
134 </div> 135 </div>
135 <hr/><h2>Member Data Documentation</h2> 136 <hr/><h2>Member Data Documentation</h2>
136 <a class="anchor" id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="a116fd9f0dc94c2bc4bbc60b5443c598c" args="" --> 137 <a class="anchor" id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a>
137 <div class="memitem"> 138 <div class="memitem">
138 <div class="memproto"> 139 <div class="memproto">
139 <table class="memname"> 140 <table class="memname">
140 <tr> 141 <tr>
141 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a></td> 142 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a></td>
145 <div class="memdoc"> 146 <div class="memdoc">
146 147
147 <p>The name of the parameter, in computer-usable form. </p> 148 <p>The name of the parameter, in computer-usable form. </p>
148 <p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p> 149 <p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p>
149 150
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> 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>
151 152
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> 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>
153 154
154 </div> 155 </div>
155 </div> 156 </div>
156 <a class="anchor" id="a0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="a0ecebb94fb4ada4aad2640e20aa57084" args="" --> 157 <a class="anchor" id="a0ecebb94fb4ada4aad2640e20aa57084"></a>
157 <div class="memitem"> 158 <div class="memitem">
158 <div class="memproto"> 159 <div class="memproto">
159 <table class="memname"> 160 <table class="memname">
160 <tr> 161 <tr>
161 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a></td> 162 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a></td>
164 </div> 165 </div>
165 <div class="memdoc"> 166 <div class="memdoc">
166 167
167 <p>The human-readable name of the parameter. </p> 168 <p>The human-readable name of the parameter. </p>
168 169
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> 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>
170 171
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> 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>
172 173
173 </div> 174 </div>
174 </div> 175 </div>
175 <a class="anchor" id="a780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="a780ddad41e433d85c82f9ea4d959cbaf" args="" --> 176 <a class="anchor" id="a780ddad41e433d85c82f9ea4d959cbaf"></a>
176 <div class="memitem"> 177 <div class="memitem">
177 <div class="memproto"> 178 <div class="memproto">
178 <table class="memname"> 179 <table class="memname">
179 <tr> 180 <tr>
180 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a></td> 181 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a></td>
184 <div class="memdoc"> 185 <div class="memdoc">
185 186
186 <p>A human-readable short text describing the parameter. </p> 187 <p>A human-readable short text describing the parameter. </p>
187 <p>May be empty if the name has said it all already. </p> 188 <p>May be empty if the name has said it all already. </p>
188 189
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> 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>
190 191
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> 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>
192 193
193 </div> 194 </div>
194 </div> 195 </div>
195 <a class="anchor" id="a3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="a3bc3df322e4c02e17e96bc6d44982d7b" args="" --> 196 <a class="anchor" id="a3bc3df322e4c02e17e96bc6d44982d7b"></a>
196 <div class="memitem"> 197 <div class="memitem">
197 <div class="memproto"> 198 <div class="memproto">
198 <table class="memname"> 199 <table class="memname">
199 <tr> 200 <tr>
200 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a></td> 201 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a></td>
203 </div> 204 </div>
204 <div class="memdoc"> 205 <div class="memdoc">
205 206
206 <p>The unit of the parameter, in human-readable form. </p> 207 <p>The unit of the parameter, in human-readable form. </p>
207 208
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> 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>
209 210
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> 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>
211 212
212 </div> 213 </div>
213 </div> 214 </div>
214 <a class="anchor" id="ab3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="ab3e4d84f5bc199eea8b642b27e425ec8" args="" --> 215 <a class="anchor" id="ab3e4d84f5bc199eea8b642b27e425ec8"></a>
215 <div class="memitem"> 216 <div class="memitem">
216 <div class="memproto"> 217 <div class="memproto">
217 <table class="memname"> 218 <table class="memname">
218 <tr> 219 <tr>
219 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a></td> 220 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a></td>
222 </div> 223 </div>
223 <div class="memdoc"> 224 <div class="memdoc">
224 225
225 <p>The minimum value of the parameter. </p> 226 <p>The minimum value of the parameter. </p>
226 227
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> 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>
228 229
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> 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>
230 231
231 </div> 232 </div>
232 </div> 233 </div>
233 <a class="anchor" id="ab934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="ab934b20dd708228a0e3c2811a3e2cec4" args="" --> 234 <a class="anchor" id="ab934b20dd708228a0e3c2811a3e2cec4"></a>
234 <div class="memitem"> 235 <div class="memitem">
235 <div class="memproto"> 236 <div class="memproto">
236 <table class="memname"> 237 <table class="memname">
237 <tr> 238 <tr>
238 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a></td> 239 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a></td>
241 </div> 242 </div>
242 <div class="memdoc"> 243 <div class="memdoc">
243 244
244 <p>The maximum value of the parameter. </p> 245 <p>The maximum value of the parameter. </p>
245 246
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> 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>
247 248
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> 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>
249 250
250 </div> 251 </div>
251 </div> 252 </div>
252 <a class="anchor" id="aec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="aec4ef77451ec02193ecc4a0856673fbc" args="" --> 253 <a class="anchor" id="aec4ef77451ec02193ecc4a0856673fbc"></a>
253 <div class="memitem"> 254 <div class="memitem">
254 <div class="memproto"> 255 <div class="memproto">
255 <table class="memname"> 256 <table class="memname">
256 <tr> 257 <tr>
257 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a></td> 258 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a></td>
261 <div class="memdoc"> 262 <div class="memdoc">
262 263
263 <p>The default value of the parameter. </p> 264 <p>The default value of the parameter. </p>
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> 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>
265 266
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> 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>
267 268
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> 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>
269 270
270 </div> 271 </div>
271 </div> 272 </div>
272 <a class="anchor" id="a7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="a7c556d58d552f737ee5a34efdf7f9425" args="" --> 273 <a class="anchor" id="a7c556d58d552f737ee5a34efdf7f9425"></a>
273 <div class="memitem"> 274 <div class="memitem">
274 <div class="memproto"> 275 <div class="memproto">
275 <table class="memname"> 276 <table class="memname">
276 <tr> 277 <tr>
277 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a></td> 278 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a></td>
280 </div> 281 </div>
281 <div class="memdoc"> 282 <div class="memdoc">
282 283
283 <p>True if the parameter values are quantized to a particular resolution. </p> 284 <p>True if the parameter values are quantized to a particular resolution. </p>
284 285
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> 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>
286 287
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> 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>
288 289
289 </div> 290 </div>
290 </div> 291 </div>
291 <a class="anchor" id="a01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="a01f8387e7c853d5e4e35d4e9a37353d7" args="" --> 292 <a class="anchor" id="a01f8387e7c853d5e4e35d4e9a37353d7"></a>
292 <div class="memitem"> 293 <div class="memitem">
293 <div class="memproto"> 294 <div class="memproto">
294 <table class="memname"> 295 <table class="memname">
295 <tr> 296 <tr>
296 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a></td> 297 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a></td>
300 <div class="memdoc"> 301 <div class="memdoc">
301 302
302 <p>Quantization resolution of the parameter values (e.g. </p> 303 <p>Quantization resolution of the parameter values (e.g. </p>
303 <p>1.0 if they are all integers). Undefined if isQuantized is false. </p> 304 <p>1.0 if they are all integers). Undefined if isQuantized is false. </p>
304 305
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> 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>
306 307
307 </div> 308 </div>
308 </div> 309 </div>
309 <a class="anchor" id="a94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="a94df96f53835980b4739965007ff222b" args="" --> 310 <a class="anchor" id="a94df96f53835980b4739965007ff222b"></a>
310 <div class="memitem"> 311 <div class="memitem">
311 <div class="memproto"> 312 <div class="memproto">
312 <table class="memname"> 313 <table class="memname">
313 <tr> 314 <tr>
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> 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>
319 320
320 <p>Names for the quantized values. </p> 321 <p>Names for the quantized values. </p>
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> 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>
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> 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>
323 324
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> 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>
325 326
326 </div> 327 </div>
327 </div> 328 </div>
328 <hr/>The documentation for this struct was generated from the following file:<ul> 329 <hr/>The documentation for this struct was generated from the following file:<ul>
329 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li> 330 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
330 </ul> 331 </ul>
331 </div> 332 </div><!-- contents -->
332 </div> 333 </div>
333 <div id="nav-path" class="navpath"> 334 <div id="nav-path" class="navpath">
334 <ul> 335 <ul>
335 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 336 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
336 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li> 337 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li>
337 <li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> </li> 338 <li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> </li>
338 339
339 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by 340 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
340 <a href="http://www.doxygen.org/index.html"> 341 <a href="http://www.doxygen.org/index.html">
341 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 342 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
342 </ul> 343 </ul>
343 </div> 344 </div>
344 345
345 346
346 </body> 347 </body>