Mercurial > hg > vamp-website

comparison code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
children 8260c0f4e05b
comparison
equal deleted inserted replaced
34:4b4db9230e94 35:0976232e353b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title> 3 <title>VampPluginSDK: Vamp::PluginBase::PluginBase::ParameterDescriptor Struct Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 --> 7 <!-- Generated by Doxygen 1.5.8 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a>::<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a>::<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
29 <h1>Vamp::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>&gt;</code> 29 <h1>Vamp::PluginBase::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
30 <p> 30 <p>
31 31
32 <p> 32 <p>
33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 33 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
34
35 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00130">130</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
36 <table border="0" cellpadding="0" cellspacing="0">
37 <tr><td></td></tr> 34 <tr><td></td></tr>
38 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 35 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr> 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7759ab75c33d0f4d8bc85c755bfb10f3">ParameterDescriptor</a> ()</td></tr>
40 37
41 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr> 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b34ea7114875647281ac031021e45d06">identifier</a></td></tr>
43 40
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#116fd9f0dc94c2bc4bbc60b5443c598c"></a><br></td></tr> 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#b34ea7114875647281ac031021e45d06"></a><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr> 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#2c1000e78a6414dab6c5af5201053741">name</a></td></tr>
46 43
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#0ecebb94fb4ada4aad2640e20aa57084"></a><br></td></tr> 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#2c1000e78a6414dab6c5af5201053741"></a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr> 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0cbc8fe35b0d15fd8e19de2ade33d147">description</a></td></tr>
49 46
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#780ddad41e433d85c82f9ea4d959cbaf"></a><br></td></tr> 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#0cbc8fe35b0d15fd8e19de2ade33d147"></a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr> 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#e0d6c74d915b99bacb55a0622e0ecb1c">unit</a></td></tr>
52 49
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#3bc3df322e4c02e17e96bc6d44982d7b"></a><br></td></tr> 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#e0d6c74d915b99bacb55a0622e0ecb1c"></a><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr> 51 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#18221c4bb5c57332fe6a1393c5ec3b6d">minValue</a></td></tr>
55 52
56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The minimum value of the parameter. <a href="#b3e4d84f5bc199eea8b642b27e425ec8"></a><br></td></tr> 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The minimum value of the parameter. <a href="#18221c4bb5c57332fe6a1393c5ec3b6d"></a><br></td></tr>
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr> 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#52e0c1f0acfc7ff8622ca1ccc97ad69d">maxValue</a></td></tr>
58 55
59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value of the parameter. <a href="#b934b20dd708228a0e3c2811a3e2cec4"></a><br></td></tr> 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value of the parameter. <a href="#52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><br></td></tr>
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr> 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#4b36674815777f54846bb7033205bbea">defaultValue</a></td></tr>
61 58
62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default value of the parameter. <a href="#ec4ef77451ec02193ecc4a0856673fbc"></a><br></td></tr> 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default value of the parameter. <a href="#4b36674815777f54846bb7033205bbea"></a><br></td></tr>
63 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr> 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#6e76a119dafbdd26351521ec486550ea">isQuantized</a></td></tr>
64 61
65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#7c556d58d552f737ee5a34efdf7f9425"></a><br></td></tr> 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#6e76a119dafbdd26351521ec486550ea"></a><br></td></tr>
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr> 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0b84d9928f1ecce8663335f6a80ad2b1">quantizeStep</a></td></tr>
67 64
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#01f8387e7c853d5e4e35d4e9a37353d7"></a><br></td></tr> 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#0b84d9928f1ecce8663335f6a80ad2b1"></a><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b">valueNames</a></td></tr> 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0a4ab495e32d7746f2c55a5a59af1adc">valueNames</a></td></tr>
70 67
71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#94df96f53835980b4739965007ff222b"></a><br></td></tr> 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names for the quantized values. <a href="#0a4ab495e32d7746f2c55a5a59af1adc"></a><br></td></tr>
72 </table> 69 </table>
70 <hr><a name="_details"></a><h2>Detailed Description</h2>
71
72 <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>
73 <hr><h2>Constructor &amp; Destructor Documentation</h2> 73 <hr><h2>Constructor &amp; Destructor Documentation</h2>
74 <a class="anchor" name="5b793130e9746b2302317b3c9a9c1395"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="5b793130e9746b2302317b3c9a9c1395" args="()" --> 74 <a class="anchor" name="7759ab75c33d0f4d8bc85c755bfb10f3"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="7759ab75c33d0f4d8bc85c755bfb10f3" args="()" -->
75 <div class="memitem"> 75 <div class="memitem">
76 <div class="memproto"> 76 <div class="memproto">
77 <table class="memname"> 77 <table class="memname">
78 <tr> 78 <tr>
79 <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor </td> 79 <td class="memname">Vamp::PluginBase::PluginBase::ParameterDescriptor::ParameterDescriptor </td>
80 <td>(</td> 80 <td>(</td>
81 <td class="paramname"> </td> 81 <td class="paramname"> </td>
82 <td>&nbsp;)&nbsp;</td> 82 <td>&nbsp;)&nbsp;</td>
83 <td><code> [inline]</code></td> 83 <td><code> [inline]</code></td>
84 </tr> 84 </tr>
91 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 91 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
92 92
93 </div> 93 </div>
94 </div><p> 94 </div><p>
95 <hr><h2>Member Data Documentation</h2> 95 <hr><h2>Member Data Documentation</h2>
96 <a class="anchor" name="116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="116fd9f0dc94c2bc4bbc60b5443c598c" args="" --> 96 <a class="anchor" name="b34ea7114875647281ac031021e45d06"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="b34ea7114875647281ac031021e45d06" args="" -->
97 <div class="memitem"> 97 <div class="memitem">
98 <div class="memproto"> 98 <div class="memproto">
99 <table class="memname"> 99 <table class="memname">
100 <tr> 100 <tr>
101 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a> </td> 101 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier </td>
102 </tr> 102 </tr>
103 </table> 103 </table>
104 </div> 104 </div>
105 <div class="memdoc"> 105 <div class="memdoc">
106 106
108 The name of the parameter, in computer-usable form. 108 The name of the parameter, in computer-usable form.
109 <p> 109 <p>
110 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. 110 Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-].
111 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 111 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
112 112
113 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 113 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
114 114
115 </div> 115 </div>
116 </div><p> 116 </div><p>
117 <a class="anchor" name="0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="0ecebb94fb4ada4aad2640e20aa57084" args="" --> 117 <a class="anchor" name="2c1000e78a6414dab6c5af5201053741"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="2c1000e78a6414dab6c5af5201053741" args="" -->
118 <div class="memitem"> 118 <div class="memitem">
119 <div class="memproto"> 119 <div class="memproto">
120 <table class="memname"> 120 <table class="memname">
121 <tr> 121 <tr>
122 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a> </td> 122 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::name </td>
123 </tr> 123 </tr>
124 </table> 124 </table>
125 </div> 125 </div>
126 <div class="memdoc"> 126 <div class="memdoc">
127 127
129 The human-readable name of the parameter. 129 The human-readable name of the parameter.
130 <p> 130 <p>
131 131
132 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 132 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
133 133
134 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 134 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
135 135
136 </div> 136 </div>
137 </div><p> 137 </div><p>
138 <a class="anchor" name="780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="780ddad41e433d85c82f9ea4d959cbaf" args="" --> 138 <a class="anchor" name="0cbc8fe35b0d15fd8e19de2ade33d147"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="0cbc8fe35b0d15fd8e19de2ade33d147" args="" -->
139 <div class="memitem"> 139 <div class="memitem">
140 <div class="memproto"> 140 <div class="memproto">
141 <table class="memname"> 141 <table class="memname">
142 <tr> 142 <tr>
143 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a> </td> 143 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::description </td>
144 </tr> 144 </tr>
145 </table> 145 </table>
146 </div> 146 </div>
147 <div class="memdoc"> 147 <div class="memdoc">
148 148
150 A human-readable short text describing the parameter. 150 A human-readable short text describing the parameter.
151 <p> 151 <p>
152 May be empty if the name has said it all already. 152 May be empty if the name has said it all already.
153 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 153 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
154 154
155 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 155 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
156 156
157 </div> 157 </div>
158 </div><p> 158 </div><p>
159 <a class="anchor" name="3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="3bc3df322e4c02e17e96bc6d44982d7b" args="" --> 159 <a class="anchor" name="e0d6c74d915b99bacb55a0622e0ecb1c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="e0d6c74d915b99bacb55a0622e0ecb1c" args="" -->
160 <div class="memitem"> 160 <div class="memitem">
161 <div class="memproto"> 161 <div class="memproto">
162 <table class="memname"> 162 <table class="memname">
163 <tr> 163 <tr>
164 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a> </td> 164 <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::unit </td>
165 </tr> 165 </tr>
166 </table> 166 </table>
167 </div> 167 </div>
168 <div class="memdoc"> 168 <div class="memdoc">
169 169
171 The unit of the parameter, in human-readable form. 171 The unit of the parameter, in human-readable form.
172 <p> 172 <p>
173 173
174 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 174 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
175 175
176 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 176 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
177 177
178 </div> 178 </div>
179 </div><p> 179 </div><p>
180 <a class="anchor" name="b3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="b3e4d84f5bc199eea8b642b27e425ec8" args="" --> 180 <a class="anchor" name="18221c4bb5c57332fe6a1393c5ec3b6d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="18221c4bb5c57332fe6a1393c5ec3b6d" args="" -->
181 <div class="memitem"> 181 <div class="memitem">
182 <div class="memproto"> 182 <div class="memproto">
183 <table class="memname"> 183 <table class="memname">
184 <tr> 184 <tr>
185 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a> </td> 185 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue </td>
186 </tr> 186 </tr>
187 </table> 187 </table>
188 </div> 188 </div>
189 <div class="memdoc"> 189 <div class="memdoc">
190 190
192 The minimum value of the parameter. 192 The minimum value of the parameter.
193 <p> 193 <p>
194 194
195 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 195 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
196 196
197 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 197 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
198 198
199 </div> 199 </div>
200 </div><p> 200 </div><p>
201 <a class="anchor" name="b934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="b934b20dd708228a0e3c2811a3e2cec4" args="" --> 201 <a class="anchor" name="52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="52e0c1f0acfc7ff8622ca1ccc97ad69d" args="" -->
202 <div class="memitem"> 202 <div class="memitem">
203 <div class="memproto"> 203 <div class="memproto">
204 <table class="memname"> 204 <table class="memname">
205 <tr> 205 <tr>
206 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a> </td> 206 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue </td>
207 </tr> 207 </tr>
208 </table> 208 </table>
209 </div> 209 </div>
210 <div class="memdoc"> 210 <div class="memdoc">
211 211
213 The maximum value of the parameter. 213 The maximum value of the parameter.
214 <p> 214 <p>
215 215
216 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 216 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
217 217
218 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 218 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
219 219
220 </div> 220 </div>
221 </div><p> 221 </div><p>
222 <a class="anchor" name="ec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="ec4ef77451ec02193ecc4a0856673fbc" args="" --> 222 <a class="anchor" name="4b36674815777f54846bb7033205bbea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="4b36674815777f54846bb7033205bbea" args="" -->
223 <div class="memitem"> 223 <div class="memitem">
224 <div class="memproto"> 224 <div class="memproto">
225 <table class="memname"> 225 <table class="memname">
226 <tr> 226 <tr>
227 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a> </td> 227 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue </td>
228 </tr> 228 </tr>
229 </table> 229 </table>
230 </div> 230 </div>
231 <div class="memdoc"> 231 <div class="memdoc">
232 232
234 The default value of the parameter. 234 The default value of the parameter.
235 <p> 235 <p>
236 The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). 236 The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values).
237 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 237 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
238 238
239 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 239 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
240 240
241 </div> 241 </div>
242 </div><p> 242 </div><p>
243 <a class="anchor" name="7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="7c556d58d552f737ee5a34efdf7f9425" args="" --> 243 <a class="anchor" name="6e76a119dafbdd26351521ec486550ea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="6e76a119dafbdd26351521ec486550ea" args="" -->
244 <div class="memitem"> 244 <div class="memitem">
245 <div class="memproto"> 245 <div class="memproto">
246 <table class="memname"> 246 <table class="memname">
247 <tr> 247 <tr>
248 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a> </td> 248 <td class="memname">bool Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized </td>
249 </tr> 249 </tr>
250 </table> 250 </table>
251 </div> 251 </div>
252 <div class="memdoc"> 252 <div class="memdoc">
253 253
255 True if the parameter values are quantized to a particular resolution. 255 True if the parameter values are quantized to a particular resolution.
256 <p> 256 <p>
257 257
258 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 258 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
259 259
260 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 260 <p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p>
261 261
262 </div> 262 </div>
263 </div><p> 263 </div><p>
264 <a class="anchor" name="01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="01f8387e7c853d5e4e35d4e9a37353d7" args="" --> 264 <a class="anchor" name="0b84d9928f1ecce8663335f6a80ad2b1"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="0b84d9928f1ecce8663335f6a80ad2b1" args="" -->
265 <div class="memitem"> 265 <div class="memitem">
266 <div class="memproto"> 266 <div class="memproto">
267 <table class="memname"> 267 <table class="memname">
268 <tr> 268 <tr>
269 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a> </td> 269 <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::quantizeStep </td>
270 </tr> 270 </tr>
271 </table> 271 </table>
272 </div> 272 </div>
273 <div class="memdoc"> 273 <div class="memdoc">
274 274
278 1.0 if they are all integers). Undefined if isQuantized is false. 278 1.0 if they are all integers). Undefined if isQuantized is false.
279 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 279 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p>
280 280
281 </div> 281 </div>
282 </div><p> 282 </div><p>
283 <a class="anchor" name="94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="94df96f53835980b4739965007ff222b" args="" --> 283 <a class="anchor" name="0a4ab495e32d7746f2c55a5a59af1adc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="0a4ab495e32d7746f2c55a5a59af1adc" args="" -->
284 <div class="memitem"> 284 <div class="memitem">
285 <div class="memproto"> 285 <div class="memproto">
286 <table class="memname"> 286 <table class="memname">
287 <tr> 287 <tr>
288 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#94df96f53835980b4739965007ff222b">Vamp::PluginBase::ParameterDescriptor::valueNames</a> </td> 288 <td class="memname">std::vector&lt;std::string&gt; Vamp::PluginBase::PluginBase::ParameterDescriptor::valueNames </td>
289 </tr> 289 </tr>
290 </table> 290 </table>
291 </div> 291 </div>
292 <div class="memdoc"> 292 <div class="memdoc">
293 293
301 </div> 301 </div>
302 </div><p> 302 </div><p>
303 <hr>The documentation for this struct was generated from the following file:<ul> 303 <hr>The documentation for this struct was generated from the following file:<ul>
304 <li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul> 304 <li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul>
305 </div> 305 </div>
306 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp; 306 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
307 <a href="http://www.doxygen.org/index.html"> 307 <a href="http://www.doxygen.org/index.html">
308 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> 308 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
309 </body> 309 </body>
310 </html> 310 </html>