Mercurial > hg > vamp-website
comparison code-doc/struct__VampParameterDescriptor.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 <head> | |
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
3 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title> | 5 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title> |
4 <link href="tabs.css" rel="stylesheet" type="text/css"> | 6 |
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> | 7 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
6 </head><body> | 8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
7 <!-- Generated by Doxygen 1.5.8 --> | 9 <link href="navtree.css" rel="stylesheet" type="text/css"/> |
8 <div class="navigation" id="top"> | 10 <script type="text/javascript" src="jquery.js"></script> |
9 <div class="tabs"> | 11 <script type="text/javascript" src="resize.js"></script> |
10 <ul> | 12 <script type="text/javascript" src="navtree.js"></script> |
11 <li><a href="main.html"><span>Main Page</span></a></li> | 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> | 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> | |
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('struct__VampParameterDescriptor.html',''); | |
72 </script> | |
73 <div id="doc-content"> | |
74 <div class="header"> | |
75 <div class="summary"> | |
76 <a href="#pub-attribs">Public Attributes</a> </div> | |
77 <div class="headertitle"> | |
78 <div class="title">_VampParameterDescriptor Struct Reference</div> </div> | |
79 </div> | |
26 <div class="contents"> | 80 <div class="contents"> |
27 <h1>_VampParameterDescriptor Struct Reference</h1><!-- doxytag: class="_VampParameterDescriptor" -->C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. | 81 <!-- doxytag: class="_VampParameterDescriptor" --> |
28 <a href="#_details">More...</a> | 82 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. |
29 <p> | 83 <a href="struct__VampParameterDescriptor.html#details">More...</a></p> |
30 <code>#include <<a class="el" href="vamp_8h-source.html">vamp.h</a>></code> | 84 |
31 <p> | 85 <p><code>#include <<a class="el" href="vamp_8h_source.html">vamp.h</a>></code></p> |
32 | 86 |
33 <p> | 87 <p><a href="struct__VampParameterDescriptor-members.html">List of all members.</a></p> |
34 <a href="struct__VampParameterDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> | 88 <table class="memberdecls"> |
35 <tr><td></td></tr> | 89 <tr><td colspan="2"><h2><a name="pub-attribs"></a> |
36 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> | 90 Public Attributes</h2></td></tr> |
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">identifier</a></td></tr> | 91 <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr> |
38 | 92 <tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr> |
39 <tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the parameter. <a href="#26d74afd6a3341a673f15955031845ab"></a><br></td></tr> | 93 <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr> |
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">name</a></td></tr> | 94 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr> |
41 | 95 <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr> |
42 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the parameter. <a href="#bba810bce9656f6002777f6c3f655957"></a><br></td></tr> | 96 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr> |
43 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr> | 97 <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr> |
44 | 98 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr> |
45 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the parameter. <a href="#95489272d6cf5a5b487e949da8e4fac6"></a><br></td></tr> | 99 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr> |
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr> | 100 <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr> |
47 | 101 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr> |
48 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable unit of the parameter. <a href="#8ca235f816b56dc99125e010eee08fc7"></a><br></td></tr> | 102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr> |
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr> | 103 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr> |
50 | 104 <tr><td class="mdescLeft"> </td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr> |
51 <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value. <a href="#b59c84f0bbe0d4d0c578d893c087b0db"></a><br></td></tr> | 105 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr> |
52 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr> | 106 <tr><td class="mdescLeft"> </td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a"></a><br/></td></tr> |
53 | 107 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr> |
54 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value. <a href="#6e7646babdb265c4abfc107ba4350d80"></a><br></td></tr> | 108 <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr> |
55 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr> | 109 <tr><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr> |
56 | 110 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#a188883325ab1e4a898e3dc53a8f88f9d"></a><br/></td></tr> |
57 <tr><td class="mdescLeft"> </td><td class="mdescRight">Default value. <a href="#3d37f986ee152ab55feb9902b35f7aca"></a><br></td></tr> | |
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr> | |
59 | |
60 <tr><td class="mdescLeft"> </td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#3f41e3b6b69c7a95ff0ce8625794f83a"></a><br></td></tr> | |
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr> | |
62 | |
63 <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br></td></tr> | |
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr> | |
65 | |
66 <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#188883325ab1e4a898e3dc53a8f88f9d"></a><br></td></tr> | |
67 </table> | 111 </table> |
68 <hr><a name="_details"></a><h2>Detailed Description</h2> | 112 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
69 C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. | 113 <div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p> |
70 <p> | 114 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p> |
71 This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.<p> | 115 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p> |
72 IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. | 116 |
73 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00071">71</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 117 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00071">71</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
74 <hr><h2>Member Data Documentation</h2> | 118 </div><hr/><h2>Member Data Documentation</h2> |
75 <a class="anchor" name="26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="26d74afd6a3341a673f15955031845ab" args="" --> | 119 <a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="a26d74afd6a3341a673f15955031845ab" args="" --> |
76 <div class="memitem"> | 120 <div class="memitem"> |
77 <div class="memproto"> | 121 <div class="memproto"> |
78 <table class="memname"> | 122 <table class="memname"> |
79 <tr> | 123 <tr> |
80 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a> </td> | 124 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a></td> |
81 </tr> | 125 </tr> |
82 </table> | 126 </table> |
83 </div> | 127 </div> |
84 <div class="memdoc"> | 128 <div class="memdoc"> |
85 | 129 |
86 <p> | 130 <p>Computer-usable name of the parameter. </p> |
87 Computer-usable name of the parameter. | 131 <p>Must not change. [a-zA-Z0-9_] </p> |
88 <p> | 132 |
89 Must not change. [a-zA-Z0-9_] | 133 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00074">74</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
90 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00074">74</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 134 |
91 | 135 </div> |
92 </div> | 136 </div> |
93 </div><p> | 137 <a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="abba810bce9656f6002777f6c3f655957" args="" --> |
94 <a class="anchor" name="bba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="bba810bce9656f6002777f6c3f655957" args="" --> | 138 <div class="memitem"> |
95 <div class="memitem"> | 139 <div class="memproto"> |
96 <div class="memproto"> | 140 <table class="memname"> |
97 <table class="memname"> | 141 <tr> |
98 <tr> | 142 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a></td> |
99 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a> </td> | 143 </tr> |
100 </tr> | 144 </table> |
101 </table> | 145 </div> |
102 </div> | 146 <div class="memdoc"> |
103 <div class="memdoc"> | 147 |
104 | 148 <p>Human-readable name of the parameter. </p> |
105 <p> | 149 <p>May be translatable. </p> |
106 Human-readable name of the parameter. | 150 |
107 <p> | 151 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00077">77</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
108 May be translatable. | 152 |
109 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00077">77</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 153 </div> |
110 | 154 </div> |
111 </div> | 155 <a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="a95489272d6cf5a5b487e949da8e4fac6" args="" --> |
112 </div><p> | 156 <div class="memitem"> |
113 <a class="anchor" name="95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="95489272d6cf5a5b487e949da8e4fac6" args="" --> | 157 <div class="memproto"> |
114 <div class="memitem"> | 158 <table class="memname"> |
115 <div class="memproto"> | 159 <tr> |
116 <table class="memname"> | 160 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a></td> |
117 <tr> | 161 </tr> |
118 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a> </td> | 162 </table> |
119 </tr> | 163 </div> |
120 </table> | 164 <div class="memdoc"> |
121 </div> | 165 |
122 <div class="memdoc"> | 166 <p>Human-readable short text about the parameter. </p> |
123 | 167 <p>May be translatable. </p> |
124 <p> | 168 |
125 Human-readable short text about the parameter. | 169 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00080">80</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
126 <p> | 170 |
127 May be translatable. | 171 </div> |
128 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00080">80</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 172 </div> |
129 | 173 <a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="a8ca235f816b56dc99125e010eee08fc7" args="" --> |
130 </div> | 174 <div class="memitem"> |
131 </div><p> | 175 <div class="memproto"> |
132 <a class="anchor" name="8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="8ca235f816b56dc99125e010eee08fc7" args="" --> | 176 <table class="memname"> |
133 <div class="memitem"> | 177 <tr> |
134 <div class="memproto"> | 178 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a></td> |
135 <table class="memname"> | 179 </tr> |
136 <tr> | 180 </table> |
137 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a> </td> | 181 </div> |
138 </tr> | 182 <div class="memdoc"> |
139 </table> | 183 |
140 </div> | 184 <p>Human-readable unit of the parameter. </p> |
141 <div class="memdoc"> | 185 |
142 | 186 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00083">83</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
143 <p> | 187 |
144 Human-readable unit of the parameter. | 188 </div> |
145 <p> | 189 </div> |
146 | 190 <a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="ab59c84f0bbe0d4d0c578d893c087b0db" args="" --> |
147 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00083">83</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 191 <div class="memitem"> |
148 | 192 <div class="memproto"> |
149 </div> | 193 <table class="memname"> |
150 </div><p> | 194 <tr> |
151 <a class="anchor" name="b59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="b59c84f0bbe0d4d0c578d893c087b0db" args="" --> | 195 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a></td> |
152 <div class="memitem"> | 196 </tr> |
153 <div class="memproto"> | 197 </table> |
154 <table class="memname"> | 198 </div> |
155 <tr> | 199 <div class="memdoc"> |
156 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a> </td> | 200 |
157 </tr> | 201 <p>Minimum value. </p> |
158 </table> | 202 |
159 </div> | 203 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00086">86</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
160 <div class="memdoc"> | 204 |
161 | 205 </div> |
162 <p> | 206 </div> |
163 Minimum value. | 207 <a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="a6e7646babdb265c4abfc107ba4350d80" args="" --> |
164 <p> | 208 <div class="memitem"> |
165 | 209 <div class="memproto"> |
166 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00086">86</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 210 <table class="memname"> |
167 | 211 <tr> |
168 </div> | 212 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a></td> |
169 </div><p> | 213 </tr> |
170 <a class="anchor" name="6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="6e7646babdb265c4abfc107ba4350d80" args="" --> | 214 </table> |
171 <div class="memitem"> | 215 </div> |
172 <div class="memproto"> | 216 <div class="memdoc"> |
173 <table class="memname"> | 217 |
174 <tr> | 218 <p>Maximum value. </p> |
175 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a> </td> | 219 |
176 </tr> | 220 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00089">89</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
177 </table> | 221 |
178 </div> | 222 </div> |
179 <div class="memdoc"> | 223 </div> |
180 | 224 <a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="a3d37f986ee152ab55feb9902b35f7aca" args="" --> |
181 <p> | 225 <div class="memitem"> |
182 Maximum value. | 226 <div class="memproto"> |
183 <p> | 227 <table class="memname"> |
184 | 228 <tr> |
185 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00089">89</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 229 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a></td> |
186 | 230 </tr> |
187 </div> | 231 </table> |
188 </div><p> | 232 </div> |
189 <a class="anchor" name="3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="3d37f986ee152ab55feb9902b35f7aca" args="" --> | 233 <div class="memdoc"> |
190 <div class="memitem"> | 234 |
191 <div class="memproto"> | 235 <p>Default value. </p> |
192 <table class="memname"> | 236 <p>Plugin is responsible for setting this on initialise. </p> |
193 <tr> | 237 |
194 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a> </td> | 238 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00092">92</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
195 </tr> | 239 |
196 </table> | 240 </div> |
197 </div> | 241 </div> |
198 <div class="memdoc"> | 242 <a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="a3f41e3b6b69c7a95ff0ce8625794f83a" args="" --> |
199 | 243 <div class="memitem"> |
200 <p> | 244 <div class="memproto"> |
201 Default value. | 245 <table class="memname"> |
202 <p> | 246 <tr> |
203 Plugin is responsible for setting this on initialise. | 247 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a></td> |
204 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00092">92</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 248 </tr> |
205 | 249 </table> |
206 </div> | 250 </div> |
207 </div><p> | 251 <div class="memdoc"> |
208 <a class="anchor" name="3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="3f41e3b6b69c7a95ff0ce8625794f83a" args="" --> | 252 |
209 <div class="memitem"> | 253 <p>1 if parameter values are quantized to a particular resolution. </p> |
210 <div class="memproto"> | 254 |
211 <table class="memname"> | 255 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00095">95</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
212 <tr> | 256 |
213 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a> </td> | 257 </div> |
214 </tr> | 258 </div> |
215 </table> | 259 <a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="a68c91fd3fc0b0b3617c2d343fe32d0e5" args="" --> |
216 </div> | 260 <div class="memitem"> |
217 <div class="memdoc"> | 261 <div class="memproto"> |
218 | 262 <table class="memname"> |
219 <p> | 263 <tr> |
220 1 if parameter values are quantized to a particular resolution. | 264 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a></td> |
221 <p> | 265 </tr> |
222 | 266 </table> |
223 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00095">95</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 267 </div> |
224 | 268 <div class="memdoc"> |
225 </div> | 269 |
226 </div><p> | 270 <p>Quantization resolution, if isQuantized. </p> |
227 <a class="anchor" name="68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="68c91fd3fc0b0b3617c2d343fe32d0e5" args="" --> | 271 |
228 <div class="memitem"> | 272 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00098">98</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
229 <div class="memproto"> | 273 |
230 <table class="memname"> | 274 </div> |
231 <tr> | 275 </div> |
232 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a> </td> | 276 <a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="a188883325ab1e4a898e3dc53a8f88f9d" args="" --> |
233 </tr> | 277 <div class="memitem"> |
234 </table> | 278 <div class="memproto"> |
235 </div> | 279 <table class="memname"> |
236 <div class="memdoc"> | 280 <tr> |
237 | 281 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a></td> |
238 <p> | 282 </tr> |
239 Quantization resolution, if isQuantized. | 283 </table> |
240 <p> | 284 </div> |
241 | 285 <div class="memdoc"> |
242 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00098">98</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 286 |
243 | 287 <p>Human-readable names of the values, if isQuantized. </p> |
244 </div> | 288 <p>May be NULL. </p> |
245 </div><p> | 289 |
246 <a class="anchor" name="188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="188883325ab1e4a898e3dc53a8f88f9d" args="" --> | 290 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00101">101</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> |
247 <div class="memitem"> | 291 |
248 <div class="memproto"> | 292 </div> |
249 <table class="memname"> | 293 </div> |
250 <tr> | 294 <hr/>The documentation for this struct was generated from the following file:<ul> |
251 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a> </td> | 295 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li> |
252 </tr> | 296 </ul> |
253 </table> | 297 </div> |
254 </div> | 298 </div> |
255 <div class="memdoc"> | 299 <div id="nav-path" class="navpath"> |
256 | 300 <ul> |
257 <p> | 301 <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> </li> |
258 Human-readable names of the values, if isQuantized. | 302 |
259 <p> | 303 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by |
260 May be NULL. | 304 <a href="http://www.doxygen.org/index.html"> |
261 <p>Definition at line <a class="el" href="vamp_8h-source.html#l00101">101</a> of file <a class="el" href="vamp_8h-source.html">vamp.h</a>.</p> | 305 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> |
262 | 306 </ul> |
263 </div> | 307 </div> |
264 </div><p> | 308 |
265 <hr>The documentation for this struct was generated from the following file:<ul> | 309 |
266 <li><a class="el" href="vamp_8h-source.html">vamp.h</a></ul> | |
267 </div> | |
268 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 2009 for VampPluginSDK by | |
269 <a href="http://www.doxygen.org/index.html"> | |
270 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> | |
271 </body> | 310 </body> |
272 </html> | 311 </html> |