Mercurial > hg > vamp-docs

comparison code-docs/vamp-sdk_2PluginBase_8h_source.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
comparison
equal deleted inserted replaced
2:52d16fb98e80 3:5c2683745b33
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 <title>VampPluginSDK: PluginBase.h Source File</title> 6 <title>VampPluginSDK: PluginBase.h Source File</title>
6 7
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/> 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
26 <tr style="height: 56px;"> 27 <tr style="height: 56px;">
27 28
28 29
29 <td style="padding-left: 0.5em;"> 30 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK 31 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span> 32 &#160;<span id="projectnumber">2.4</span>
32 </div> 33 </div>
33 34
34 </td> 35 </td>
35 36
36 37
38 </tr> 39 </tr>
39 </tbody> 40 </tbody>
40 </table> 41 </table>
41 </div> 42 </div>
42 43
43 <!-- Generated by Doxygen 1.7.5.1 --> 44 <!-- Generated by Doxygen 1.8.0 -->
44 <div id="navrow1" class="tabs"> 45 <div id="navrow1" class="tabs">
45 <ul class="tablist"> 46 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 47 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li> 49 <li><a href="annotated.html"><span>Classes</span></a></li>
71 </script> 72 </script>
72 <div id="doc-content"> 73 <div id="doc-content">
73 <div class="header"> 74 <div class="header">
74 <div class="headertitle"> 75 <div class="headertitle">
75 <div class="title">vamp-sdk/PluginBase.h</div> </div> 76 <div class="title">vamp-sdk/PluginBase.h</div> </div>
76 </div> 77 </div><!--header-->
77 <div class="contents"> 78 <div class="contents">
78 <a href="vamp-sdk_2PluginBase_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span> 79 <a href="vamp-sdk_2PluginBase_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span>
79 <a name="l00002"></a>00002 80 <a name="l00002"></a>00002
80 <a name="l00003"></a>00003 <span class="comment">/*</span> 81 <a name="l00003"></a>00003 <span class="comment">/*</span>
81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span> 82 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
115 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_BASE_H_</span> 116 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGIN_BASE_H_</span>
116 <a name="l00039"></a>00039 <span class="preprocessor"></span> 117 <a name="l00039"></a>00039 <span class="preprocessor"></span>
117 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span> 118 <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;string&gt;</span>
118 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span> 119 <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;vector&gt;</span>
119 <a name="l00042"></a>00042 120 <a name="l00042"></a>00042
120 <a name="l00043"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#a9b7a8e1ac1c91366bec5f2f33c137a2f">00043</a> <span class="preprocessor">#define VAMP_SDK_VERSION &quot;3.5&quot;</span> 121 <a name="l00043"></a>00043 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span>
121 <a name="l00044"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#ab5f7da6acf45065a6c7b7cd38a0bf588">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MAJOR_VERSION 2</span> 122 <a name="l00044"></a>00044 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(PluginBase.h)
122 <a name="l00045"></a><a class="code" href="vamp-sdk_2PluginBase_8h.html#ad5eef1e2154b42769cd642d2a1d42257">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define VAMP_SDK_MINOR_VERSION 2</span> 123 <a name="l00045"></a>00045
123 <a name="l00046"></a>00046 <span class="preprocessor"></span> 124 <a name="l00046"></a>00046 namespace Vamp {
124 <a name="l00047"></a>00047 <span class="preprocessor">#include &quot;<a class="code" href="plugguard_8h.html">plugguard.h</a>&quot;</span> 125 <a name="l00047"></a>00047
125 <a name="l00048"></a>00048 <a class="code" href="plugguard_8h.html#a1a2724ea453971288d3218e4eab3072c">_VAMP_SDK_PLUGSPACE_BEGIN</a>(PluginBase.h) 126 <a name="l00060"></a><a class="code" href="classVamp_1_1PluginBase.html">00060</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>
126 <a name="l00049"></a>00049 127 <a name="l00061"></a>00061 {
127 <a name="l00050"></a>00050 namespace Vamp { 128 <a name="l00062"></a>00062 <span class="keyword">public</span>:
128 <a name="l00051"></a>00051 129 <a name="l00063"></a><a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">00063</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>() { }
129 <a name="l00064"></a><a class="code" href="classVamp_1_1PluginBase.html">00064</a> <span class="keyword">class </span><a class="code" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a> 130 <a name="l00064"></a>00064
130 <a name="l00065"></a>00065 { 131 <a name="l00068"></a><a class="code" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">00068</a> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 2; }
131 <a name="l00066"></a>00066 <span class="keyword">public</span>: 132 <a name="l00069"></a>00069
132 <a name="l00067"></a><a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">00067</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>() { } 133 <a name="l00083"></a>00083 <span class="keyword">virtual</span> std::string getIdentifier() <span class="keyword">const</span> = 0;
133 <a name="l00068"></a>00068 134 <a name="l00084"></a>00084
134 <a name="l00072"></a><a class="code" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">00072</a> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf" title="Get the Vamp API compatibility level of the plugin.">getVampApiVersion</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 2; } 135 <a name="l00093"></a>00093 <span class="keyword">virtual</span> std::string getName() <span class="keyword">const</span> = 0;
135 <a name="l00073"></a>00073 136 <a name="l00094"></a>00094
136 <a name="l00087"></a>00087 <span class="keyword">virtual</span> std::string getIdentifier() <span class="keyword">const</span> = 0; 137 <a name="l00103"></a>00103 <span class="keyword">virtual</span> std::string getDescription() <span class="keyword">const</span> = 0;
137 <a name="l00088"></a>00088 138 <a name="l00104"></a>00104
138 <a name="l00097"></a>00097 <span class="keyword">virtual</span> std::string getName() <span class="keyword">const</span> = 0; 139 <a name="l00111"></a>00111 <span class="keyword">virtual</span> std::string getMaker() <span class="keyword">const</span> = 0;
139 <a name="l00098"></a>00098 140 <a name="l00112"></a>00112
140 <a name="l00107"></a>00107 <span class="keyword">virtual</span> std::string getDescription() <span class="keyword">const</span> = 0; 141 <a name="l00118"></a>00118 <span class="keyword">virtual</span> std::string getCopyright() <span class="keyword">const</span> = 0;
141 <a name="l00108"></a>00108 142 <a name="l00119"></a>00119
142 <a name="l00115"></a>00115 <span class="keyword">virtual</span> std::string getMaker() <span class="keyword">const</span> = 0; 143 <a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0;
143 <a name="l00116"></a>00116 144 <a name="l00124"></a>00124
144 <a name="l00122"></a>00122 <span class="keyword">virtual</span> std::string getCopyright() <span class="keyword">const</span> = 0; 145 <a name="l00125"></a>00125
145 <a name="l00123"></a>00123 146 <a name="l00126"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">00126</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>
146 <a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">int</span> getPluginVersion() <span class="keyword">const</span> = 0; 147 <a name="l00127"></a>00127 {
147 <a name="l00128"></a>00128 148 <a name="l00133"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">00133</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a>;
148 <a name="l00129"></a>00129 149 <a name="l00134"></a>00134
149 <a name="l00130"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">00130</a> <span class="keyword">struct </span><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> 150 <a name="l00138"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">00138</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a>;
150 <a name="l00131"></a>00131 { 151 <a name="l00139"></a>00139
151 <a name="l00137"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">00137</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c" title="The name of the parameter, in computer-usable form.">identifier</a>; 152 <a name="l00144"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">00144</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a>;
152 <a name="l00138"></a>00138 153 <a name="l00145"></a>00145
153 <a name="l00142"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">00142</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084" title="The human-readable name of the parameter.">name</a>; 154 <a name="l00149"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">00149</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a>;
154 <a name="l00143"></a>00143 155 <a name="l00150"></a>00150
155 <a name="l00148"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">00148</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf" title="A human-readable short text describing the parameter.">description</a>; 156 <a name="l00154"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">00154</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a>;
156 <a name="l00149"></a>00149 157 <a name="l00155"></a>00155
157 <a name="l00153"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">00153</a> std::string <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b" title="The unit of the parameter, in human-readable form.">unit</a>; 158 <a name="l00159"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">00159</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a>;
158 <a name="l00154"></a>00154 159 <a name="l00160"></a>00160
159 <a name="l00158"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">00158</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8" title="The minimum value of the parameter.">minValue</a>; 160 <a name="l00167"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">00167</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a>;
160 <a name="l00159"></a>00159 161 <a name="l00168"></a>00168
161 <a name="l00163"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">00163</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4" title="The maximum value of the parameter.">maxValue</a>; 162 <a name="l00173"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">00173</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a>;
162 <a name="l00164"></a>00164 163 <a name="l00174"></a>00174
163 <a name="l00171"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">00171</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc" title="The default value of the parameter.">defaultValue</a>; 164 <a name="l00180"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">00180</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7" title="Quantization resolution of the parameter values (e.g.">quantizeStep</a>;
164 <a name="l00172"></a>00172 165 <a name="l00181"></a>00181
165 <a name="l00177"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">00177</a> <span class="keywordtype">bool</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425" title="True if the parameter values are quantized to a particular resolution.">isQuantized</a>; 166 <a name="l00193"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">00193</a> std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b" title="Names for the quantized values.">valueNames</a>;
166 <a name="l00178"></a>00178 167 <a name="l00194"></a>00194
167 <a name="l00184"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">00184</a> <span class="keywordtype">float</span> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7" title="Quantization resolution of the parameter values (e.g.">quantizeStep</a>; 168 <a name="l00195"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">00195</a> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>() : <span class="comment">// the defaults are invalid: you must set them</span>
168 <a name="l00185"></a>00185 169 <a name="l00196"></a>00196 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { }
169 <a name="l00197"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">00197</a> std::vector&lt;std::string&gt; <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b" title="Names for the quantized values.">valueNames</a>; 170 <a name="l00197"></a>00197 };
170 <a name="l00198"></a>00198 171 <a name="l00198"></a>00198
171 <a name="l00199"></a><a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">00199</a> <a class="code" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>() : <span class="comment">// the defaults are invalid: you must set them</span> 172 <a name="l00199"></a><a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">00199</a> <span class="keyword">typedef</span> std::vector&lt;ParameterDescriptor&gt; <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>;
172 <a name="l00200"></a>00200 minValue(0), maxValue(0), defaultValue(0), isQuantized(false) { } 173 <a name="l00200"></a>00200
173 <a name="l00201"></a>00201 }; 174 <a name="l00204"></a><a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">00204</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>()<span class="keyword"> const </span>{
174 <a name="l00202"></a>00202 175 <a name="l00205"></a>00205 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>();
175 <a name="l00203"></a><a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">00203</a> <span class="keyword">typedef</span> std::vector&lt;ParameterDescriptor&gt; <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>; 176 <a name="l00206"></a>00206 }
176 <a name="l00204"></a>00204 177 <a name="l00207"></a>00207
177 <a name="l00208"></a><a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">00208</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="code" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21" title="Get the controllable parameters of this plugin.">getParameterDescriptors</a>()<span class="keyword"> const </span>{ 178 <a name="l00212"></a><a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">00212</a> <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7" title="Get the value of a named parameter.">getParameter</a>(std::string)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0.0; }
178 <a name="l00209"></a>00209 <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>(); 179 <a name="l00213"></a>00213
179 <a name="l00210"></a>00210 } 180 <a name="l00218"></a><a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">00218</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>) { }
180 <a name="l00211"></a>00211 181 <a name="l00219"></a>00219
181 <a name="l00216"></a><a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">00216</a> <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7" title="Get the value of a named parameter.">getParameter</a>(std::string)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0.0; } 182 <a name="l00220"></a>00220
182 <a name="l00217"></a>00217 183 <a name="l00221"></a><a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">00221</a> <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>;
183 <a name="l00222"></a><a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">00222</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366" title="Set a named parameter.">setParameter</a>(std::string, <span class="keywordtype">float</span>) { } 184 <a name="l00222"></a>00222
184 <a name="l00223"></a>00223 185 <a name="l00233"></a><a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">00233</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af" title="Get the program settings available in this plugin.">getPrograms</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>(); }
185 <a name="l00224"></a>00224 186 <a name="l00234"></a>00234
186 <a name="l00225"></a><a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">00225</a> <span class="keyword">typedef</span> std::vector&lt;std::string&gt; <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>; 187 <a name="l00238"></a><a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">00238</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3" title="Get the current program.">getCurrentProgram</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }
187 <a name="l00226"></a>00226 188 <a name="l00239"></a>00239
188 <a name="l00237"></a><a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">00237</a> <span class="keyword">virtual</span> <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="code" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af" title="Get the program settings available in this plugin.">getPrograms</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>(); } 189 <a name="l00244"></a><a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">00244</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353" title="Select a program.">selectProgram</a>(std::string) { }
189 <a name="l00238"></a>00238 190 <a name="l00245"></a>00245
190 <a name="l00242"></a><a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">00242</a> <span class="keyword">virtual</span> std::string <a class="code" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3" title="Get the current program.">getCurrentProgram</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; } 191 <a name="l00251"></a>00251 <span class="keyword">virtual</span> std::string getType() <span class="keyword">const</span> = 0;
191 <a name="l00243"></a>00243 192 <a name="l00252"></a>00252 };
192 <a name="l00248"></a><a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">00248</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353" title="Select a program.">selectProgram</a>(std::string) { } 193 <a name="l00253"></a>00253
193 <a name="l00249"></a>00249 194 <a name="l00254"></a>00254 }
194 <a name="l00255"></a>00255 <span class="keyword">virtual</span> std::string getType() <span class="keyword">const</span> = 0; 195 <a name="l00255"></a>00255
195 <a name="l00256"></a>00256 }; 196 <a name="l00256"></a>00256 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(PluginBase.h)
196 <a name="l00257"></a>00257 197 <a name="l00257"></a>00257
197 <a name="l00258"></a>00258 } 198 <a name="l00258"></a>00258 <span class="preprocessor">#endif</span>
198 <a name="l00259"></a>00259 199 </pre></div></div><!-- contents -->
199 <a name="l00260"></a>00260 <a class="code" href="plugguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">_VAMP_SDK_PLUGSPACE_END</a>(PluginBase.h)
200 <a name="l00261"></a>00261
201 <a name="l00262"></a>00262 <span class="preprocessor">#endif</span>
202 </pre></div></div>
203 </div> 200 </div>
204 <div id="nav-path" class="navpath"> 201 <div id="nav-path" class="navpath">
205 <ul> 202 <ul>
206 <li class="navelem"><a class="el" href="vamp-sdk_2PluginBase_8h.html">PluginBase.h</a> </li> 203 <li class="navelem"><a class="el" href="vamp-sdk_2PluginBase_8h.html">PluginBase.h</a> </li>
207 204
208 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by 205 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
209 <a href="http://www.doxygen.org/index.html"> 206 <a href="http://www.doxygen.org/index.html">
210 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 207 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
211 </ul> 208 </ul>
212 </div> 209 </div>
213 210
214 211
215 </body> 212 </body>