Mercurial > hg > vamp-docs

comparison code-docs/structVamp_1_1PluginBase_1_1ParameterDescriptor.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: Vamp::PluginBase::ParameterDescriptor Struct Reference</title> 8 <title>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor 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('structVamp_1_1PluginBase_1_1ParameterDescriptor.html',''); 58 $(document).ready(function(){initNavTree('structVamp_1_1PluginBase_1_1ParameterDescriptor.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-methods">Public Member Functions</a> &#124; 63 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pub-attribs">Public Attributes</a> </div> 64 <a href="#pub-attribs">Public Attributes</a> &#124;
65 <a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members</a> </div>
79 <div class="headertitle"> 66 <div class="headertitle">
80 <div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div> 67 <div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div>
81 </div><!--header--> 68 </div><!--header-->
82 <div class="contents"> 69 <div class="contents">
83 70
84 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p> 71 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p>
85
86 <p><a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a></p>
87 <table class="memberdecls"> 72 <table class="memberdecls">
88 <tr><td colspan="2"><h2><a name="pub-methods"></a> 73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
89 Public Member Functions</h2></td></tr> 74 Public Member Functions</h2></td></tr>
90 <tr class="memitem:a5b793130e9746b2302317b3c9a9c1395"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr> 75 <tr class="memitem:a5b793130e9746b2302317b3c9a9c1395"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr>
91 <tr><td colspan="2"><h2><a name="pub-attribs"></a> 76 <tr class="separator:a5b793130e9746b2302317b3c9a9c1395"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 </table><table class="memberdecls">
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
92 Public Attributes</h2></td></tr> 79 Public Attributes</h2></td></tr>
93 <tr class="memitem:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr> 80 <tr class="memitem:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr>
94 <tr class="memdesc:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#a116fd9f0dc94c2bc4bbc60b5443c598c"></a><br/></td></tr> 81 <tr class="memdesc:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#a116fd9f0dc94c2bc4bbc60b5443c598c">More...</a><br /></td></tr>
82 <tr class="separator:a116fd9f0dc94c2bc4bbc60b5443c598c"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:a0ecebb94fb4ada4aad2640e20aa57084"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr> 83 <tr class="memitem:a0ecebb94fb4ada4aad2640e20aa57084"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr>
96 <tr class="memdesc:a0ecebb94fb4ada4aad2640e20aa57084"><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#a0ecebb94fb4ada4aad2640e20aa57084"></a><br/></td></tr> 84 <tr class="memdesc:a0ecebb94fb4ada4aad2640e20aa57084"><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the parameter. <a href="#a0ecebb94fb4ada4aad2640e20aa57084">More...</a><br /></td></tr>
85 <tr class="separator:a0ecebb94fb4ada4aad2640e20aa57084"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:a780ddad41e433d85c82f9ea4d959cbaf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr> 86 <tr class="memitem:a780ddad41e433d85c82f9ea4d959cbaf"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr>
98 <tr class="memdesc:a780ddad41e433d85c82f9ea4d959cbaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#a780ddad41e433d85c82f9ea4d959cbaf"></a><br/></td></tr> 87 <tr class="memdesc:a780ddad41e433d85c82f9ea4d959cbaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#a780ddad41e433d85c82f9ea4d959cbaf">More...</a><br /></td></tr>
88 <tr class="separator:a780ddad41e433d85c82f9ea4d959cbaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr> 89 <tr class="memitem:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr>
100 <tr class="memdesc:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#a3bc3df322e4c02e17e96bc6d44982d7b"></a><br/></td></tr> 90 <tr class="memdesc:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#a3bc3df322e4c02e17e96bc6d44982d7b">More...</a><br /></td></tr>
91 <tr class="separator:a3bc3df322e4c02e17e96bc6d44982d7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr> 92 <tr class="memitem:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr>
102 <tr class="memdesc:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum value of the parameter. <a href="#ab3e4d84f5bc199eea8b642b27e425ec8"></a><br/></td></tr> 93 <tr class="memdesc:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum value of the parameter. <a href="#ab3e4d84f5bc199eea8b642b27e425ec8">More...</a><br /></td></tr>
94 <tr class="separator:ab3e4d84f5bc199eea8b642b27e425ec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <tr class="memitem:ab934b20dd708228a0e3c2811a3e2cec4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr> 95 <tr class="memitem:ab934b20dd708228a0e3c2811a3e2cec4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr>
104 <tr class="memdesc:ab934b20dd708228a0e3c2811a3e2cec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum value of the parameter. <a href="#ab934b20dd708228a0e3c2811a3e2cec4"></a><br/></td></tr> 96 <tr class="memdesc:ab934b20dd708228a0e3c2811a3e2cec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum value of the parameter. <a href="#ab934b20dd708228a0e3c2811a3e2cec4">More...</a><br /></td></tr>
97 <tr class="separator:ab934b20dd708228a0e3c2811a3e2cec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <tr class="memitem:aec4ef77451ec02193ecc4a0856673fbc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr> 98 <tr class="memitem:aec4ef77451ec02193ecc4a0856673fbc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr>
106 <tr class="memdesc:aec4ef77451ec02193ecc4a0856673fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value of the parameter. <a href="#aec4ef77451ec02193ecc4a0856673fbc"></a><br/></td></tr> 99 <tr class="memdesc:aec4ef77451ec02193ecc4a0856673fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value of the parameter. <a href="#aec4ef77451ec02193ecc4a0856673fbc">More...</a><br /></td></tr>
100 <tr class="separator:aec4ef77451ec02193ecc4a0856673fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:a7c556d58d552f737ee5a34efdf7f9425"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr> 101 <tr class="memitem:a7c556d58d552f737ee5a34efdf7f9425"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr>
108 <tr class="memdesc:a7c556d58d552f737ee5a34efdf7f9425"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#a7c556d58d552f737ee5a34efdf7f9425"></a><br/></td></tr> 102 <tr class="memdesc:a7c556d58d552f737ee5a34efdf7f9425"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#a7c556d58d552f737ee5a34efdf7f9425">More...</a><br /></td></tr>
103 <tr class="separator:a7c556d58d552f737ee5a34efdf7f9425"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <tr class="memitem:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr> 104 <tr class="memitem:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr>
110 <tr class="memdesc:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#a01f8387e7c853d5e4e35d4e9a37353d7"></a><br/></td></tr> 105 <tr class="memdesc:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#a01f8387e7c853d5e4e35d4e9a37353d7">More...</a><br /></td></tr>
106 <tr class="separator:a01f8387e7c853d5e4e35d4e9a37353d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a94df96f53835980b4739965007ff222b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">valueNames</a></td></tr> 107 <tr class="memitem:a94df96f53835980b4739965007ff222b"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">valueNames</a></td></tr>
112 <tr class="memdesc:a94df96f53835980b4739965007ff222b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Names for the quantized values. <a href="#a94df96f53835980b4739965007ff222b"></a><br/></td></tr> 108 <tr class="memdesc:a94df96f53835980b4739965007ff222b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Names for the quantized values. <a href="#a94df96f53835980b4739965007ff222b">More...</a><br /></td></tr>
109 <tr class="separator:a94df96f53835980b4739965007ff222b"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 </table> 110 </table>
114 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 111 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
115 <div class="textblock"> 112 <div class="textblock">
116 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00126">126</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 113 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00126">126</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
117 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2> 114 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
118 <a class="anchor" id="a5b793130e9746b2302317b3c9a9c1395"></a> 115 <a id="a5b793130e9746b2302317b3c9a9c1395"></a>
119 <div class="memitem"> 116 <h2 class="memtitle"><span class="permalink"><a href="#a5b793130e9746b2302317b3c9a9c1395">&#9670;&nbsp;</a></span>ParameterDescriptor()</h2>
120 <div class="memproto"> 117
121 <table class="memname"> 118 <div class="memitem">
122 <tr> 119 <div class="memproto">
123 <td class="memname"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor</a> </td> 120 <table class="mlabels">
121 <tr>
122 <td class="mlabels-left">
123 <table class="memname">
124 <tr>
125 <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor </td>
124 <td>(</td> 126 <td>(</td>
125 <td class="paramname"></td><td>)</td> 127 <td class="paramname"></td><td>)</td>
126 <td><code> [inline]</code></td> 128 <td></td>
127 </tr> 129 </tr>
128 </table> 130 </table>
129 </div> 131 </td>
130 <div class="memdoc"> 132 <td class="mlabels-right">
131 133 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
132 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00195">195</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 134 </tr>
133 135 </table>
134 </div> 136 </div><div class="memdoc">
135 </div> 137
136 <hr/><h2>Member Data Documentation</h2> 138 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00195">195</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
137 <a class="anchor" id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a> 139
138 <div class="memitem"> 140 </div>
139 <div class="memproto"> 141 </div>
140 <table class="memname"> 142 <h2 class="groupheader">Member Data Documentation</h2>
141 <tr> 143 <a id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a>
142 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a></td> 144 <h2 class="memtitle"><span class="permalink"><a href="#a116fd9f0dc94c2bc4bbc60b5443c598c">&#9670;&nbsp;</a></span>identifier</h2>
143 </tr> 145
144 </table> 146 <div class="memitem">
145 </div> 147 <div class="memproto">
146 <div class="memdoc"> 148 <table class="memname">
149 <tr>
150 <td class="memname">std::string Vamp::PluginBase::ParameterDescriptor::identifier</td>
151 </tr>
152 </table>
153 </div><div class="memdoc">
147 154
148 <p>The name of the parameter, in computer-usable form. </p> 155 <p>The name of the parameter, in computer-usable form. </p>
149 <p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p> 156 <p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p>
150 157
151 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">133</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 158 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">133</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
152 159
153 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 160 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
154 161
155 </div> 162 </div>
156 </div> 163 </div>
157 <a class="anchor" id="a0ecebb94fb4ada4aad2640e20aa57084"></a> 164 <a id="a0ecebb94fb4ada4aad2640e20aa57084"></a>
158 <div class="memitem"> 165 <h2 class="memtitle"><span class="permalink"><a href="#a0ecebb94fb4ada4aad2640e20aa57084">&#9670;&nbsp;</a></span>name</h2>
159 <div class="memproto"> 166
160 <table class="memname"> 167 <div class="memitem">
161 <tr> 168 <div class="memproto">
162 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a></td> 169 <table class="memname">
163 </tr> 170 <tr>
164 </table> 171 <td class="memname">std::string Vamp::PluginBase::ParameterDescriptor::name</td>
165 </div> 172 </tr>
166 <div class="memdoc"> 173 </table>
174 </div><div class="memdoc">
167 175
168 <p>The human-readable name of the parameter. </p> 176 <p>The human-readable name of the parameter. </p>
169 177
170 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">138</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 178 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">138</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
171 179
172 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 180 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
173 181
174 </div> 182 </div>
175 </div> 183 </div>
176 <a class="anchor" id="a780ddad41e433d85c82f9ea4d959cbaf"></a> 184 <a id="a780ddad41e433d85c82f9ea4d959cbaf"></a>
177 <div class="memitem"> 185 <h2 class="memtitle"><span class="permalink"><a href="#a780ddad41e433d85c82f9ea4d959cbaf">&#9670;&nbsp;</a></span>description</h2>
178 <div class="memproto"> 186
179 <table class="memname"> 187 <div class="memitem">
180 <tr> 188 <div class="memproto">
181 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a></td> 189 <table class="memname">
182 </tr> 190 <tr>
183 </table> 191 <td class="memname">std::string Vamp::PluginBase::ParameterDescriptor::description</td>
184 </div> 192 </tr>
185 <div class="memdoc"> 193 </table>
194 </div><div class="memdoc">
186 195
187 <p>A human-readable short text describing the parameter. </p> 196 <p>A human-readable short text describing the parameter. </p>
188 <p>May be empty if the name has said it all already. </p> 197 <p>May be empty if the name has said it all already. </p>
189 198
190 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">144</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 199 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">144</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
191 200
192 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 201 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
193 202
194 </div> 203 </div>
195 </div> 204 </div>
196 <a class="anchor" id="a3bc3df322e4c02e17e96bc6d44982d7b"></a> 205 <a id="a3bc3df322e4c02e17e96bc6d44982d7b"></a>
197 <div class="memitem"> 206 <h2 class="memtitle"><span class="permalink"><a href="#a3bc3df322e4c02e17e96bc6d44982d7b">&#9670;&nbsp;</a></span>unit</h2>
198 <div class="memproto"> 207
199 <table class="memname"> 208 <div class="memitem">
200 <tr> 209 <div class="memproto">
201 <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a></td> 210 <table class="memname">
202 </tr> 211 <tr>
203 </table> 212 <td class="memname">std::string Vamp::PluginBase::ParameterDescriptor::unit</td>
204 </div> 213 </tr>
205 <div class="memdoc"> 214 </table>
215 </div><div class="memdoc">
206 216
207 <p>The unit of the parameter, in human-readable form. </p> 217 <p>The unit of the parameter, in human-readable form. </p>
208 218
209 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">149</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 219 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">149</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
210 220
211 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 221 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
212 222
213 </div> 223 </div>
214 </div> 224 </div>
215 <a class="anchor" id="ab3e4d84f5bc199eea8b642b27e425ec8"></a> 225 <a id="ab3e4d84f5bc199eea8b642b27e425ec8"></a>
216 <div class="memitem"> 226 <h2 class="memtitle"><span class="permalink"><a href="#ab3e4d84f5bc199eea8b642b27e425ec8">&#9670;&nbsp;</a></span>minValue</h2>
217 <div class="memproto"> 227
218 <table class="memname"> 228 <div class="memitem">
219 <tr> 229 <div class="memproto">
220 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a></td> 230 <table class="memname">
221 </tr> 231 <tr>
222 </table> 232 <td class="memname">float Vamp::PluginBase::ParameterDescriptor::minValue</td>
223 </div> 233 </tr>
224 <div class="memdoc"> 234 </table>
235 </div><div class="memdoc">
225 236
226 <p>The minimum value of the parameter. </p> 237 <p>The minimum value of the parameter. </p>
227 238
228 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">154</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 239 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">154</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
229 240
230 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 241 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
231 242
232 </div> 243 </div>
233 </div> 244 </div>
234 <a class="anchor" id="ab934b20dd708228a0e3c2811a3e2cec4"></a> 245 <a id="ab934b20dd708228a0e3c2811a3e2cec4"></a>
235 <div class="memitem"> 246 <h2 class="memtitle"><span class="permalink"><a href="#ab934b20dd708228a0e3c2811a3e2cec4">&#9670;&nbsp;</a></span>maxValue</h2>
236 <div class="memproto"> 247
237 <table class="memname"> 248 <div class="memitem">
238 <tr> 249 <div class="memproto">
239 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a></td> 250 <table class="memname">
240 </tr> 251 <tr>
241 </table> 252 <td class="memname">float Vamp::PluginBase::ParameterDescriptor::maxValue</td>
242 </div> 253 </tr>
243 <div class="memdoc"> 254 </table>
255 </div><div class="memdoc">
244 256
245 <p>The maximum value of the parameter. </p> 257 <p>The maximum value of the parameter. </p>
246 258
247 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">159</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 259 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">159</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
248 260
249 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 261 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
250 262
251 </div> 263 </div>
252 </div> 264 </div>
253 <a class="anchor" id="aec4ef77451ec02193ecc4a0856673fbc"></a> 265 <a id="aec4ef77451ec02193ecc4a0856673fbc"></a>
254 <div class="memitem"> 266 <h2 class="memtitle"><span class="permalink"><a href="#aec4ef77451ec02193ecc4a0856673fbc">&#9670;&nbsp;</a></span>defaultValue</h2>
255 <div class="memproto"> 267
256 <table class="memname"> 268 <div class="memitem">
257 <tr> 269 <div class="memproto">
258 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a></td> 270 <table class="memname">
259 </tr> 271 <tr>
260 </table> 272 <td class="memname">float Vamp::PluginBase::ParameterDescriptor::defaultValue</td>
261 </div> 273 </tr>
262 <div class="memdoc"> 274 </table>
275 </div><div class="memdoc">
263 276
264 <p>The default value of the parameter. </p> 277 <p>The default value of the parameter. </p>
265 <p>The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). </p> 278 <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>
266 279
267 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">167</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 280 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">167</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
268 281
269 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 282 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
270 283
271 </div> 284 </div>
272 </div> 285 </div>
273 <a class="anchor" id="a7c556d58d552f737ee5a34efdf7f9425"></a> 286 <a id="a7c556d58d552f737ee5a34efdf7f9425"></a>
274 <div class="memitem"> 287 <h2 class="memtitle"><span class="permalink"><a href="#a7c556d58d552f737ee5a34efdf7f9425">&#9670;&nbsp;</a></span>isQuantized</h2>
275 <div class="memproto"> 288
276 <table class="memname"> 289 <div class="memitem">
277 <tr> 290 <div class="memproto">
278 <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a></td> 291 <table class="memname">
279 </tr> 292 <tr>
280 </table> 293 <td class="memname">bool Vamp::PluginBase::ParameterDescriptor::isQuantized</td>
281 </div> 294 </tr>
282 <div class="memdoc"> 295 </table>
296 </div><div class="memdoc">
283 297
284 <p>True if the parameter values are quantized to a particular resolution. </p> 298 <p>True if the parameter values are quantized to a particular resolution. </p>
285 299
286 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">173</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 300 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">173</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
287 301
288 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> 302 <p class="reference">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#l00149">AmplitudeFollower::getParameterDescriptors()</a>.</p>
289 303
290 </div> 304 </div>
291 </div> 305 </div>
292 <a class="anchor" id="a01f8387e7c853d5e4e35d4e9a37353d7"></a> 306 <a id="a01f8387e7c853d5e4e35d4e9a37353d7"></a>
293 <div class="memitem"> 307 <h2 class="memtitle"><span class="permalink"><a href="#a01f8387e7c853d5e4e35d4e9a37353d7">&#9670;&nbsp;</a></span>quantizeStep</h2>
294 <div class="memproto"> 308
295 <table class="memname"> 309 <div class="memitem">
296 <tr> 310 <div class="memproto">
297 <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a></td> 311 <table class="memname">
298 </tr> 312 <tr>
299 </table> 313 <td class="memname">float Vamp::PluginBase::ParameterDescriptor::quantizeStep</td>
300 </div> 314 </tr>
301 <div class="memdoc"> 315 </table>
316 </div><div class="memdoc">
302 317
303 <p>Quantization resolution of the parameter values (e.g. </p> 318 <p>Quantization resolution of the parameter values (e.g. </p>
304 <p>1.0 if they are all integers). Undefined if isQuantized is false. </p> 319 <p>1.0 if they are all integers). Undefined if isQuantized is false. </p>
305 320
306 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00180">180</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 321 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00180">180</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
307 322
308 </div> 323 </div>
309 </div> 324 </div>
310 <a class="anchor" id="a94df96f53835980b4739965007ff222b"></a> 325 <a id="a94df96f53835980b4739965007ff222b"></a>
311 <div class="memitem"> 326 <h2 class="memtitle"><span class="permalink"><a href="#a94df96f53835980b4739965007ff222b">&#9670;&nbsp;</a></span>valueNames</h2>
312 <div class="memproto"> 327
313 <table class="memname"> 328 <div class="memitem">
314 <tr> 329 <div class="memproto">
315 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">Vamp::PluginBase::ParameterDescriptor::valueNames</a></td> 330 <table class="memname">
316 </tr> 331 <tr>
317 </table> 332 <td class="memname">std::vector&lt;std::string&gt; Vamp::PluginBase::ParameterDescriptor::valueNames</td>
318 </div> 333 </tr>
319 <div class="memdoc"> 334 </table>
335 </div><div class="memdoc">
320 336
321 <p>Names for the quantized values. </p> 337 <p>Names for the quantized values. </p>
322 <p>If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.</p> 338 <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>
323 <p>If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. </p> 339 <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>
324 340
325 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00193">193</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 341 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00193">193</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
326 342
327 </div> 343 </div>
328 </div> 344 </div>
329 <hr/>The documentation for this struct was generated from the following file:<ul> 345 <hr/>The documentation for this struct was generated from the following file:<ul>
330 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li> 346 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
331 </ul> 347 </ul>
332 </div><!-- contents --> 348 </div><!-- contents -->
333 </div> 349 </div><!-- doc-content -->
334 <div id="nav-path" class="navpath"> 350 <!-- start footer part -->
335 <ul> 351 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
336 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 352 <ul>
337 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li> 353 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></li><li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a></li>
338 <li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> </li> 354 <li class="footer">Generated by
339
340 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
341 <a href="http://www.doxygen.org/index.html"> 355 <a href="http://www.doxygen.org/index.html">
342 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 356 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
343 </ul> 357 </ul>
344 </div> 358 </div>
345
346
347 </body> 359 </body>
348 </html> 360 </html>