Mercurial > hg > vamp-docs

comparison code-docs/struct__VampParameterDescriptor.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title> 8 <title>VampPluginSDK: _VampParameterDescriptor Struct Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34
35 </td> 31 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
59 </ul>
60 </div>
61 </div>
62 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
63 <div id="nav-tree"> 48 <div id="nav-tree">
64 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
65 </div> 51 </div>
66 </div> 52 </div>
67 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
69 </div> 55 </div>
70 </div> 56 </div>
71 <script type="text/javascript"> 57 <script type="text/javascript">
72 initNavTree('struct__VampParameterDescriptor.html',''); 58 $(document).ready(function(){initNavTree('struct__VampParameterDescriptor.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-attribs">Public Attributes</a> </div> 63 <a href="#pub-attribs">Public Attributes</a> &#124;
64 <a href="struct__VampParameterDescriptor-members.html">List of all members</a> </div>
78 <div class="headertitle"> 65 <div class="headertitle">
79 <div class="title">_VampParameterDescriptor Struct Reference</div> </div> 66 <div class="title">_VampParameterDescriptor Struct Reference</div> </div>
80 </div><!--header--> 67 </div><!--header-->
81 <div class="contents"> 68 <div class="contents">
82 69
83 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. 70 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
84 <a href="struct__VampParameterDescriptor.html#details">More...</a></p> 71 <a href="struct__VampParameterDescriptor.html#details">More...</a></p>
85 72
86 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p> 73 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
87
88 <p><a href="struct__VampParameterDescriptor-members.html">List of all members.</a></p>
89 <table class="memberdecls"> 74 <table class="memberdecls">
90 <tr><td colspan="2"><h2><a name="pub-attribs"></a> 75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
91 Public Attributes</h2></td></tr> 76 Public Attributes</h2></td></tr>
92 <tr class="memitem:a26d74afd6a3341a673f15955031845ab"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr> 77 <tr class="memitem:a26d74afd6a3341a673f15955031845ab"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr>
93 <tr class="memdesc:a26d74afd6a3341a673f15955031845ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr> 78 <tr class="memdesc:a26d74afd6a3341a673f15955031845ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab">More...</a><br /></td></tr>
79 <tr class="separator:a26d74afd6a3341a673f15955031845ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:abba810bce9656f6002777f6c3f655957"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr> 80 <tr class="memitem:abba810bce9656f6002777f6c3f655957"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr>
95 <tr class="memdesc:abba810bce9656f6002777f6c3f655957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr> 81 <tr class="memdesc:abba810bce9656f6002777f6c3f655957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957">More...</a><br /></td></tr>
82 <tr class="separator:abba810bce9656f6002777f6c3f655957"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:a95489272d6cf5a5b487e949da8e4fac6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr> 83 <tr class="memitem:a95489272d6cf5a5b487e949da8e4fac6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr>
97 <tr class="memdesc:a95489272d6cf5a5b487e949da8e4fac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr> 84 <tr class="memdesc:a95489272d6cf5a5b487e949da8e4fac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6">More...</a><br /></td></tr>
85 <tr class="separator:a95489272d6cf5a5b487e949da8e4fac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a8ca235f816b56dc99125e010eee08fc7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr> 86 <tr class="memitem:a8ca235f816b56dc99125e010eee08fc7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr>
99 <tr class="memdesc:a8ca235f816b56dc99125e010eee08fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr> 87 <tr class="memdesc:a8ca235f816b56dc99125e010eee08fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7">More...</a><br /></td></tr>
88 <tr class="separator:a8ca235f816b56dc99125e010eee08fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr> 89 <tr class="memitem:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr>
101 <tr class="memdesc:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr> 90 <tr class="memdesc:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db">More...</a><br /></td></tr>
91 <tr class="separator:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a6e7646babdb265c4abfc107ba4350d80"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr> 92 <tr class="memitem:a6e7646babdb265c4abfc107ba4350d80"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr>
103 <tr class="memdesc:a6e7646babdb265c4abfc107ba4350d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr> 93 <tr class="memdesc:a6e7646babdb265c4abfc107ba4350d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80">More...</a><br /></td></tr>
94 <tr class="separator:a6e7646babdb265c4abfc107ba4350d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:a3d37f986ee152ab55feb9902b35f7aca"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr> 95 <tr class="memitem:a3d37f986ee152ab55feb9902b35f7aca"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr>
105 <tr class="memdesc:a3d37f986ee152ab55feb9902b35f7aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr> 96 <tr class="memdesc:a3d37f986ee152ab55feb9902b35f7aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca">More...</a><br /></td></tr>
97 <tr class="separator:a3d37f986ee152ab55feb9902b35f7aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr> 98 <tr class="memitem:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr>
107 <tr class="memdesc:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a"></a><br/></td></tr> 99 <tr class="memdesc:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a">More...</a><br /></td></tr>
100 <tr class="separator:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <tr class="memitem:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr> 101 <tr class="memitem:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr>
109 <tr class="memdesc:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr> 102 <tr class="memdesc:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5">More...</a><br /></td></tr>
103 <tr class="separator:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 <tr class="memitem:a188883325ab1e4a898e3dc53a8f88f9d"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr> 104 <tr class="memitem:a188883325ab1e4a898e3dc53a8f88f9d"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr>
111 <tr class="memdesc:a188883325ab1e4a898e3dc53a8f88f9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#a188883325ab1e4a898e3dc53a8f88f9d"></a><br/></td></tr> 105 <tr class="memdesc:a188883325ab1e4a898e3dc53a8f88f9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#a188883325ab1e4a898e3dc53a8f88f9d">More...</a><br /></td></tr>
106 <tr class="separator:a188883325ab1e4a898e3dc53a8f88f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
112 </table> 107 </table>
113 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 108 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
114 <div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p> 109 <div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
115 <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> 110 <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>
116 <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> 111 <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>
117 112
118 <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> 113 <p class="definition">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>
119 </div><hr/><h2>Member Data Documentation</h2> 114 </div><h2 class="groupheader">Member Data Documentation</h2>
120 <a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a> 115 <a id="a26d74afd6a3341a673f15955031845ab"></a>
121 <div class="memitem"> 116 <h2 class="memtitle"><span class="permalink"><a href="#a26d74afd6a3341a673f15955031845ab">&#9670;&nbsp;</a></span>identifier</h2>
122 <div class="memproto"> 117
123 <table class="memname"> 118 <div class="memitem">
124 <tr> 119 <div class="memproto">
125 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a></td> 120 <table class="memname">
126 </tr> 121 <tr>
127 </table> 122 <td class="memname">const char* _VampParameterDescriptor::identifier</td>
128 </div> 123 </tr>
129 <div class="memdoc"> 124 </table>
125 </div><div class="memdoc">
130 126
131 <p>Computer-usable name of the parameter. </p> 127 <p>Computer-usable name of the parameter. </p>
132 <p>Must not change. [a-zA-Z0-9_] </p> 128 <p>Must not change. [a-zA-Z0-9_-] </p>
133 129
134 <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> 130 <p class="definition">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>
135 131
136 </div> 132 </div>
137 </div> 133 </div>
138 <a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a> 134 <a id="abba810bce9656f6002777f6c3f655957"></a>
139 <div class="memitem"> 135 <h2 class="memtitle"><span class="permalink"><a href="#abba810bce9656f6002777f6c3f655957">&#9670;&nbsp;</a></span>name</h2>
140 <div class="memproto"> 136
141 <table class="memname"> 137 <div class="memitem">
142 <tr> 138 <div class="memproto">
143 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a></td> 139 <table class="memname">
144 </tr> 140 <tr>
145 </table> 141 <td class="memname">const char* _VampParameterDescriptor::name</td>
146 </div> 142 </tr>
147 <div class="memdoc"> 143 </table>
144 </div><div class="memdoc">
148 145
149 <p>Human-readable name of the parameter. </p> 146 <p>Human-readable name of the parameter. </p>
150 <p>May be translatable. </p> 147 <p>May be translatable. </p>
151 148
152 <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> 149 <p class="definition">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 150
154 </div> 151 </div>
155 </div> 152 </div>
156 <a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a> 153 <a id="a95489272d6cf5a5b487e949da8e4fac6"></a>
157 <div class="memitem"> 154 <h2 class="memtitle"><span class="permalink"><a href="#a95489272d6cf5a5b487e949da8e4fac6">&#9670;&nbsp;</a></span>description</h2>
158 <div class="memproto"> 155
159 <table class="memname"> 156 <div class="memitem">
160 <tr> 157 <div class="memproto">
161 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a></td> 158 <table class="memname">
162 </tr> 159 <tr>
163 </table> 160 <td class="memname">const char* _VampParameterDescriptor::description</td>
164 </div> 161 </tr>
165 <div class="memdoc"> 162 </table>
163 </div><div class="memdoc">
166 164
167 <p>Human-readable short text about the parameter. </p> 165 <p>Human-readable short text about the parameter. </p>
168 <p>May be translatable. </p> 166 <p>May be translatable. </p>
169 167
170 <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> 168 <p class="definition">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>
171 169
172 </div> 170 </div>
173 </div> 171 </div>
174 <a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a> 172 <a id="a8ca235f816b56dc99125e010eee08fc7"></a>
175 <div class="memitem"> 173 <h2 class="memtitle"><span class="permalink"><a href="#a8ca235f816b56dc99125e010eee08fc7">&#9670;&nbsp;</a></span>unit</h2>
176 <div class="memproto"> 174
177 <table class="memname"> 175 <div class="memitem">
178 <tr> 176 <div class="memproto">
179 <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a></td> 177 <table class="memname">
180 </tr> 178 <tr>
181 </table> 179 <td class="memname">const char* _VampParameterDescriptor::unit</td>
182 </div> 180 </tr>
183 <div class="memdoc"> 181 </table>
182 </div><div class="memdoc">
184 183
185 <p>Human-readable unit of the parameter. </p> 184 <p>Human-readable unit of the parameter. </p>
186 185
187 <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> 186 <p class="definition">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>
188 187
189 </div> 188 </div>
190 </div> 189 </div>
191 <a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a> 190 <a id="ab59c84f0bbe0d4d0c578d893c087b0db"></a>
192 <div class="memitem"> 191 <h2 class="memtitle"><span class="permalink"><a href="#ab59c84f0bbe0d4d0c578d893c087b0db">&#9670;&nbsp;</a></span>minValue</h2>
193 <div class="memproto"> 192
194 <table class="memname"> 193 <div class="memitem">
195 <tr> 194 <div class="memproto">
196 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a></td> 195 <table class="memname">
197 </tr> 196 <tr>
198 </table> 197 <td class="memname">float _VampParameterDescriptor::minValue</td>
199 </div> 198 </tr>
200 <div class="memdoc"> 199 </table>
200 </div><div class="memdoc">
201 201
202 <p>Minimum value. </p> 202 <p>Minimum value. </p>
203 203
204 <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> 204 <p class="definition">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>
205 205
206 </div> 206 </div>
207 </div> 207 </div>
208 <a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a> 208 <a id="a6e7646babdb265c4abfc107ba4350d80"></a>
209 <div class="memitem"> 209 <h2 class="memtitle"><span class="permalink"><a href="#a6e7646babdb265c4abfc107ba4350d80">&#9670;&nbsp;</a></span>maxValue</h2>
210 <div class="memproto"> 210
211 <table class="memname"> 211 <div class="memitem">
212 <tr> 212 <div class="memproto">
213 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a></td> 213 <table class="memname">
214 </tr> 214 <tr>
215 </table> 215 <td class="memname">float _VampParameterDescriptor::maxValue</td>
216 </div> 216 </tr>
217 <div class="memdoc"> 217 </table>
218 </div><div class="memdoc">
218 219
219 <p>Maximum value. </p> 220 <p>Maximum value. </p>
220 221
221 <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> 222 <p class="definition">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>
222 223
223 </div> 224 </div>
224 </div> 225 </div>
225 <a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a> 226 <a id="a3d37f986ee152ab55feb9902b35f7aca"></a>
226 <div class="memitem"> 227 <h2 class="memtitle"><span class="permalink"><a href="#a3d37f986ee152ab55feb9902b35f7aca">&#9670;&nbsp;</a></span>defaultValue</h2>
227 <div class="memproto"> 228
228 <table class="memname"> 229 <div class="memitem">
229 <tr> 230 <div class="memproto">
230 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a></td> 231 <table class="memname">
231 </tr> 232 <tr>
232 </table> 233 <td class="memname">float _VampParameterDescriptor::defaultValue</td>
233 </div> 234 </tr>
234 <div class="memdoc"> 235 </table>
236 </div><div class="memdoc">
235 237
236 <p>Default value. </p> 238 <p>Default value. </p>
237 <p>Plugin is responsible for setting this on initialise. </p> 239 <p>Plugin is responsible for setting this on initialise. </p>
238 240
239 <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> 241 <p class="definition">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>
240 242
241 </div> 243 </div>
242 </div> 244 </div>
243 <a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a> 245 <a id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a>
244 <div class="memitem"> 246 <h2 class="memtitle"><span class="permalink"><a href="#a3f41e3b6b69c7a95ff0ce8625794f83a">&#9670;&nbsp;</a></span>isQuantized</h2>
245 <div class="memproto"> 247
246 <table class="memname"> 248 <div class="memitem">
247 <tr> 249 <div class="memproto">
248 <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a></td> 250 <table class="memname">
249 </tr> 251 <tr>
250 </table> 252 <td class="memname">int _VampParameterDescriptor::isQuantized</td>
251 </div> 253 </tr>
252 <div class="memdoc"> 254 </table>
255 </div><div class="memdoc">
253 256
254 <p>1 if parameter values are quantized to a particular resolution. </p> 257 <p>1 if parameter values are quantized to a particular resolution. </p>
255 258
256 <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> 259 <p class="definition">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>
257 260
258 </div> 261 </div>
259 </div> 262 </div>
260 <a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a> 263 <a id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a>
261 <div class="memitem"> 264 <h2 class="memtitle"><span class="permalink"><a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5">&#9670;&nbsp;</a></span>quantizeStep</h2>
262 <div class="memproto"> 265
263 <table class="memname"> 266 <div class="memitem">
264 <tr> 267 <div class="memproto">
265 <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a></td> 268 <table class="memname">
266 </tr> 269 <tr>
267 </table> 270 <td class="memname">float _VampParameterDescriptor::quantizeStep</td>
268 </div> 271 </tr>
269 <div class="memdoc"> 272 </table>
273 </div><div class="memdoc">
270 274
271 <p>Quantization resolution, if isQuantized. </p> 275 <p>Quantization resolution, if isQuantized. </p>
272 276
273 <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> 277 <p class="definition">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>
274 278
275 </div> 279 </div>
276 </div> 280 </div>
277 <a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a> 281 <a id="a188883325ab1e4a898e3dc53a8f88f9d"></a>
278 <div class="memitem"> 282 <h2 class="memtitle"><span class="permalink"><a href="#a188883325ab1e4a898e3dc53a8f88f9d">&#9670;&nbsp;</a></span>valueNames</h2>
279 <div class="memproto"> 283
280 <table class="memname"> 284 <div class="memitem">
281 <tr> 285 <div class="memproto">
282 <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a></td> 286 <table class="memname">
283 </tr> 287 <tr>
284 </table> 288 <td class="memname">const char** _VampParameterDescriptor::valueNames</td>
285 </div> 289 </tr>
286 <div class="memdoc"> 290 </table>
291 </div><div class="memdoc">
287 292
288 <p>Human-readable names of the values, if isQuantized. </p> 293 <p>Human-readable names of the values, if isQuantized. </p>
289 <p>May be NULL. </p> 294 <p>May be NULL. </p>
290 295
291 <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> 296 <p class="definition">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>
292 297
293 </div> 298 </div>
294 </div> 299 </div>
295 <hr/>The documentation for this struct was generated from the following file:<ul> 300 <hr/>The documentation for this struct was generated from the following file:<ul>
296 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li> 301 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
297 </ul> 302 </ul>
298 </div><!-- contents --> 303 </div><!-- contents -->
299 </div> 304 </div><!-- doc-content -->
300 <div id="nav-path" class="navpath"> 305 <!-- start footer part -->
301 <ul> 306 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
302 <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> </li> 307 <ul>
303 308 <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></li>
304 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by 309 <li class="footer">Generated by
305 <a href="http://www.doxygen.org/index.html"> 310 <a href="http://www.doxygen.org/index.html">
306 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 311 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
307 </ul> 312 </ul>
308 </div> 313 </div>
309
310
311 </body> 314 </body>
312 </html> 315 </html>