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