Mercurial > hg > vamp-docs

comparison code-docs/classVamp_1_1PluginBase.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: Vamp::PluginBase Class Reference</title> 6 <title>VampPluginSDK: Vamp::PluginBase Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li> 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
76 <a href="#nested-classes">Classes</a> &#124; 77 <a href="#nested-classes">Classes</a> &#124;
77 <a href="#pub-types">Public Types</a> &#124; 78 <a href="#pub-types">Public Types</a> &#124;
78 <a href="#pub-methods">Public Member Functions</a> </div> 79 <a href="#pub-methods">Public Member Functions</a> </div>
79 <div class="headertitle"> 80 <div class="headertitle">
80 <div class="title">Vamp::PluginBase Class Reference</div> </div> 81 <div class="title">Vamp::PluginBase Class Reference</div> </div>
81 </div> 82 </div><!--header-->
82 <div class="contents"> 83 <div class="contents">
83 <!-- doxytag: class="Vamp::PluginBase" --> 84
84 <p>A base class for plugins with optional configurable parameters, programs, etc. 85 <p>A base class for plugins with optional configurable parameters, programs, etc.
85 <a href="classVamp_1_1PluginBase.html#details">More...</a></p> 86 <a href="classVamp_1_1PluginBase.html#details">More...</a></p>
86 87
87 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p> 88 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p>
88 <div class="dynheader"> 89 <div class="dynheader">
95 96
96 <p><a href="classVamp_1_1PluginBase-members.html">List of all members.</a></p> 97 <p><a href="classVamp_1_1PluginBase-members.html">List of all members.</a></p>
97 <table class="memberdecls"> 98 <table class="memberdecls">
98 <tr><td colspan="2"><h2><a name="nested-classes"></a> 99 <tr><td colspan="2"><h2><a name="nested-classes"></a>
99 Classes</h2></td></tr> 100 Classes</h2></td></tr>
100 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a></td></tr> 101 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a></td></tr>
101 <tr><td colspan="2"><h2><a name="pub-types"></a> 102 <tr><td colspan="2"><h2><a name="pub-types"></a>
102 Public Types</h2></td></tr> 103 Public Types</h2></td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 104 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
104 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> 105 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
105 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> 106 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
106 <tr><td colspan="2"><h2><a name="pub-methods"></a> 107 <tr><td colspan="2"><h2><a name="pub-methods"></a>
107 Public Member Functions</h2></td></tr> 108 Public Member Functions</h2></td></tr>
108 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a> ()</td></tr> 109 <tr class="memitem:a3773b37c658cf22d7f135c575a28f5c5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a> ()</td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> 110 <tr class="memitem:a8fd2c48291c64b790f0efb8948508dcf"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
110 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr> 111 <tr class="memdesc:a8fd2c48291c64b790f0efb8948508dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr>
111 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr> 112 <tr class="memitem:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr>
112 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad1c6dfc77aa03d937a885b7f08258f4a"></a><br/></td></tr> 113 <tr class="memdesc:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad1c6dfc77aa03d937a885b7f08258f4a"></a><br/></td></tr>
113 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr> 114 <tr class="memitem:a18619d5097e444ecefee0c359da53232"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr>
114 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a18619d5097e444ecefee0c359da53232"></a><br/></td></tr> 115 <tr class="memdesc:a18619d5097e444ecefee0c359da53232"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a18619d5097e444ecefee0c359da53232"></a><br/></td></tr>
115 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr> 116 <tr class="memitem:a59153a02364f75fff46973b2072e9e5a"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr>
116 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a59153a02364f75fff46973b2072e9e5a"></a><br/></td></tr> 117 <tr class="memdesc:a59153a02364f75fff46973b2072e9e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a59153a02364f75fff46973b2072e9e5a"></a><br/></td></tr>
117 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr> 118 <tr class="memitem:a53d9918bf9ef4d12feedf66b2b26c637"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr>
118 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a53d9918bf9ef4d12feedf66b2b26c637"></a><br/></td></tr> 119 <tr class="memdesc:a53d9918bf9ef4d12feedf66b2b26c637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a53d9918bf9ef4d12feedf66b2b26c637"></a><br/></td></tr>
119 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr> 120 <tr class="memitem:ab7e9dedbe965f5ab9018b72920fe7661"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr>
120 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ab7e9dedbe965f5ab9018b72920fe7661"></a><br/></td></tr> 121 <tr class="memdesc:ab7e9dedbe965f5ab9018b72920fe7661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ab7e9dedbe965f5ab9018b72920fe7661"></a><br/></td></tr>
121 <tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr> 122 <tr class="memitem:a63f686d77bc3d6b807e7944cdde83151"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr>
122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151"></a><br/></td></tr> 123 <tr class="memdesc:a63f686d77bc3d6b807e7944cdde83151"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151"></a><br/></td></tr>
123 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr> 124 <tr class="memitem:aac3e49b3b66cacfbb768dfdf07444f21"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr>
124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr> 125 <tr class="memdesc:aac3e49b3b66cacfbb768dfdf07444f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr>
125 <tr><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr> 126 <tr class="memitem:a97ababcd45348ceec998d0f8e0f38bf7"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr>
126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr> 127 <tr class="memdesc:a97ababcd45348ceec998d0f8e0f38bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr>
127 <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr> 128 <tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr> 129 <tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr>
129 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> 130 <tr class="memitem:abb307c60bdb981d5f5af50c3c4ae84af"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr> 131 <tr class="memdesc:abb307c60bdb981d5f5af50c3c4ae84af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr>
131 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> 132 <tr class="memitem:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
132 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> 133 <tr class="memdesc:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
133 <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> 134 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> 135 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
135 <tr><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">getType</a> () const =0</td></tr> 136 <tr class="memitem:a2da03e9ced8dc7e4382205e6dc05dbff"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">getType</a> () const =0</td></tr>
136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of plugin. <a href="#a2da03e9ced8dc7e4382205e6dc05dbff"></a><br/></td></tr> 137 <tr class="memdesc:a2da03e9ced8dc7e4382205e6dc05dbff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of plugin. <a href="#a2da03e9ced8dc7e4382205e6dc05dbff"></a><br/></td></tr>
137 </table> 138 </table>
138 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 139 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
139 <div class="textblock"><p>A base class for plugins with optional configurable parameters, programs, etc. </p> 140 <div class="textblock"><p>A base class for plugins with optional configurable parameters, programs, etc. </p>
140 <p>The <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is derived from this, and individual <a class="el" href="namespaceVamp.html">Vamp</a> plugins should derive from that.</p> 141 <p>The <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is derived from this, and individual <a class="el" href="namespaceVamp.html">Vamp</a> plugins should derive from that.</p>
141 <p>This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p> 142 <p>This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
142 143
143 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00064">64</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 144 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00060">60</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
144 </div><hr/><h2>Member Typedef Documentation</h2> 145 </div><hr/><h2>Member Typedef Documentation</h2>
145 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> 146 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
146 <div class="memitem"> 147 <div class="memitem">
147 <div class="memproto"> 148 <div class="memproto">
148 <table class="memname"> 149 <table class="memname">
149 <tr> 150 <tr>
150 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td> 151 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td>
151 </tr> 152 </tr>
152 </table> 153 </table>
153 </div> 154 </div>
154 <div class="memdoc"> 155 <div class="memdoc">
155 156
156 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 157 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
157 158
158 </div> 159 </div>
159 </div> 160 </div>
160 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginBase::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" --> 161 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a>
161 <div class="memitem"> 162 <div class="memitem">
162 <div class="memproto"> 163 <div class="memproto">
163 <table class="memname"> 164 <table class="memname">
164 <tr> 165 <tr>
165 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td> 166 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
166 </tr> 167 </tr>
167 </table> 168 </table>
168 </div> 169 </div>
169 <div class="memdoc"> 170 <div class="memdoc">
170 171
171 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 172 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
172 173
173 </div> 174 </div>
174 </div> 175 </div>
175 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 176 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
176 <a class="anchor" id="a3773b37c658cf22d7f135c575a28f5c5"></a><!-- doxytag: member="Vamp::PluginBase::~PluginBase" ref="a3773b37c658cf22d7f135c575a28f5c5" args="()" --> 177 <a class="anchor" id="a3773b37c658cf22d7f135c575a28f5c5"></a>
177 <div class="memitem"> 178 <div class="memitem">
178 <div class="memproto"> 179 <div class="memproto">
179 <table class="memname"> 180 <table class="memname">
180 <tr> 181 <tr>
181 <td class="memname">virtual Vamp::PluginBase::~PluginBase </td> 182 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">Vamp::PluginBase::~PluginBase</a> </td>
182 <td>(</td> 183 <td>(</td>
183 <td class="paramname"></td><td>)</td> 184 <td class="paramname"></td><td>)</td>
184 <td><code> [inline, virtual]</code></td> 185 <td><code> [inline, virtual]</code></td>
185 </tr> 186 </tr>
186 </table> 187 </table>
187 </div> 188 </div>
188 <div class="memdoc"> 189 <div class="memdoc">
189 190
190 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00067">67</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 191 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00063">63</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
191 192
192 </div> 193 </div>
193 </div> 194 </div>
194 <hr/><h2>Member Function Documentation</h2> 195 <hr/><h2>Member Function Documentation</h2>
195 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="Vamp::PluginBase::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " --> 196 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a>
196 <div class="memitem"> 197 <div class="memitem">
197 <div class="memproto"> 198 <div class="memproto">
198 <table class="memname"> 199 <table class="memname">
199 <tr> 200 <tr>
200 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td> 201 <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td>
201 <td>(</td> 202 <td>(</td>
202 <td class="paramname"></td><td>)</td> 203 <td class="paramname"></td><td>)</td>
203 <td> const<code> [inline, virtual]</code></td> 204 <td> const<code> [inline, virtual]</code></td>
204 </tr> 205 </tr>
205 </table> 206 </table>
208 209
209 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 210 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
210 211
211 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> 212 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
212 213
213 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00072">72</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 214 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
214 215
215 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 216 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
216 217
217 </div> 218 </div>
218 </div> 219 </div>
219 <a class="anchor" id="ad1c6dfc77aa03d937a885b7f08258f4a"></a><!-- doxytag: member="Vamp::PluginBase::getIdentifier" ref="ad1c6dfc77aa03d937a885b7f08258f4a" args="() const =0" --> 220 <a class="anchor" id="ad1c6dfc77aa03d937a885b7f08258f4a"></a>
220 <div class="memitem"> 221 <div class="memitem">
221 <div class="memproto"> 222 <div class="memproto">
222 <table class="memname"> 223 <table class="memname">
223 <tr> 224 <tr>
224 <td class="memname">virtual std::string Vamp::PluginBase::getIdentifier </td> 225 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier</a> </td>
225 <td>(</td> 226 <td>(</td>
226 <td class="paramname"></td><td>)</td> 227 <td class="paramname"></td><td>)</td>
227 <td> const<code> [pure virtual]</code></td> 228 <td> const<code> [pure virtual]</code></td>
228 </tr> 229 </tr>
229 </table> 230 </table>
239 240
240 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 241 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p>
241 242
242 </div> 243 </div>
243 </div> 244 </div>
244 <a class="anchor" id="a18619d5097e444ecefee0c359da53232"></a><!-- doxytag: member="Vamp::PluginBase::getName" ref="a18619d5097e444ecefee0c359da53232" args="() const =0" --> 245 <a class="anchor" id="a18619d5097e444ecefee0c359da53232"></a>
245 <div class="memitem"> 246 <div class="memitem">
246 <div class="memproto"> 247 <div class="memproto">
247 <table class="memname"> 248 <table class="memname">
248 <tr> 249 <tr>
249 <td class="memname">virtual std::string Vamp::PluginBase::getName </td> 250 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName</a> </td>
250 <td>(</td> 251 <td>(</td>
251 <td class="paramname"></td><td>)</td> 252 <td class="paramname"></td><td>)</td>
252 <td> const<code> [pure virtual]</code></td> 253 <td> const<code> [pure virtual]</code></td>
253 </tr> 254 </tr>
254 </table> 255 </table>
263 264
264 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p> 265 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p>
265 266
266 </div> 267 </div>
267 </div> 268 </div>
268 <a class="anchor" id="a59153a02364f75fff46973b2072e9e5a"></a><!-- doxytag: member="Vamp::PluginBase::getDescription" ref="a59153a02364f75fff46973b2072e9e5a" args="() const =0" --> 269 <a class="anchor" id="a59153a02364f75fff46973b2072e9e5a"></a>
269 <div class="memitem"> 270 <div class="memitem">
270 <div class="memproto"> 271 <div class="memproto">
271 <table class="memname"> 272 <table class="memname">
272 <tr> 273 <tr>
273 <td class="memname">virtual std::string Vamp::PluginBase::getDescription </td> 274 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription</a> </td>
274 <td>(</td> 275 <td>(</td>
275 <td class="paramname"></td><td>)</td> 276 <td class="paramname"></td><td>)</td>
276 <td> const<code> [pure virtual]</code></td> 277 <td> const<code> [pure virtual]</code></td>
277 </tr> 278 </tr>
278 </table> 279 </table>
287 288
288 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p> 289 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p>
289 290
290 </div> 291 </div>
291 </div> 292 </div>
292 <a class="anchor" id="a53d9918bf9ef4d12feedf66b2b26c637"></a><!-- doxytag: member="Vamp::PluginBase::getMaker" ref="a53d9918bf9ef4d12feedf66b2b26c637" args="() const =0" --> 293 <a class="anchor" id="a53d9918bf9ef4d12feedf66b2b26c637"></a>
293 <div class="memitem"> 294 <div class="memitem">
294 <div class="memproto"> 295 <div class="memproto">
295 <table class="memname"> 296 <table class="memname">
296 <tr> 297 <tr>
297 <td class="memname">virtual std::string Vamp::PluginBase::getMaker </td> 298 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker</a> </td>
298 <td>(</td> 299 <td>(</td>
299 <td class="paramname"></td><td>)</td> 300 <td class="paramname"></td><td>)</td>
300 <td> const<code> [pure virtual]</code></td> 301 <td> const<code> [pure virtual]</code></td>
301 </tr> 302 </tr>
302 </table> 303 </table>
310 311
311 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p> 312 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00797">printPluginCategoryList()</a>.</p>
312 313
313 </div> 314 </div>
314 </div> 315 </div>
315 <a class="anchor" id="ab7e9dedbe965f5ab9018b72920fe7661"></a><!-- doxytag: member="Vamp::PluginBase::getCopyright" ref="ab7e9dedbe965f5ab9018b72920fe7661" args="() const =0" --> 316 <a class="anchor" id="ab7e9dedbe965f5ab9018b72920fe7661"></a>
316 <div class="memitem"> 317 <div class="memitem">
317 <div class="memproto"> 318 <div class="memproto">
318 <table class="memname"> 319 <table class="memname">
319 <tr> 320 <tr>
320 <td class="memname">virtual std::string Vamp::PluginBase::getCopyright </td> 321 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright</a> </td>
321 <td>(</td> 322 <td>(</td>
322 <td class="paramname"></td><td>)</td> 323 <td class="paramname"></td><td>)</td>
323 <td> const<code> [pure virtual]</code></td> 324 <td> const<code> [pure virtual]</code></td>
324 </tr> 325 </tr>
325 </table> 326 </table>
333 334
334 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 335 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
335 336
336 </div> 337 </div>
337 </div> 338 </div>
338 <a class="anchor" id="a63f686d77bc3d6b807e7944cdde83151"></a><!-- doxytag: member="Vamp::PluginBase::getPluginVersion" ref="a63f686d77bc3d6b807e7944cdde83151" args="() const =0" --> 339 <a class="anchor" id="a63f686d77bc3d6b807e7944cdde83151"></a>
339 <div class="memitem"> 340 <div class="memitem">
340 <div class="memproto"> 341 <div class="memproto">
341 <table class="memname"> 342 <table class="memname">
342 <tr> 343 <tr>
343 <td class="memname">virtual int Vamp::PluginBase::getPluginVersion </td> 344 <td class="memname">virtual int <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion</a> </td>
344 <td>(</td> 345 <td>(</td>
345 <td class="paramname"></td><td>)</td> 346 <td class="paramname"></td><td>)</td>
346 <td> const<code> [pure virtual]</code></td> 347 <td> const<code> [pure virtual]</code></td>
347 </tr> 348 </tr>
348 </table> 349 </table>
355 356
356 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 357 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
357 358
358 </div> 359 </div>
359 </div> 360 </div>
360 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="Vamp::PluginBase::getParameterDescriptors" ref="aac3e49b3b66cacfbb768dfdf07444f21" args="() const " --> 361 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a>
361 <div class="memitem"> 362 <div class="memitem">
362 <div class="memproto"> 363 <div class="memproto">
363 <table class="memname"> 364 <table class="memname">
364 <tr> 365 <tr>
365 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td> 366 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase::getParameterDescriptors</a> </td>
366 <td>(</td> 367 <td>(</td>
367 <td class="paramname"></td><td>)</td> 368 <td class="paramname"></td><td>)</td>
368 <td> const<code> [inline, virtual]</code></td> 369 <td> const<code> [inline, virtual]</code></td>
369 </tr> 370 </tr>
370 </table> 371 </table>
373 374
374 <p>Get the controllable parameters of this plugin. </p> 375 <p>Get the controllable parameters of this plugin. </p>
375 376
376 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p> 377 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p>
377 378
378 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 379 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
379 380
380 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 381 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
381 382
382 </div> 383 </div>
383 </div> 384 </div>
384 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="Vamp::PluginBase::getParameter" ref="a97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " --> 385 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a>
385 <div class="memitem"> 386 <div class="memitem">
386 <div class="memproto"> 387 <div class="memproto">
387 <table class="memname"> 388 <table class="memname">
388 <tr> 389 <tr>
389 <td class="memname">virtual float Vamp::PluginBase::getParameter </td> 390 <td class="memname">virtual float <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase::getParameter</a> </td>
390 <td>(</td> 391 <td>(</td>
391 <td class="paramtype">std::string&#160;</td> 392 <td class="paramtype">std::string&#160;</td>
392 <td class="paramname"></td><td>)</td> 393 <td class="paramname"></td><td>)</td>
393 <td> const<code> [inline, virtual]</code></td> 394 <td> const<code> [inline, virtual]</code></td>
394 </tr> 395 </tr>
399 <p>Get the value of a named parameter. </p> 400 <p>Get the value of a named parameter. </p>
400 <p>The argument is the identifier field from that parameter's descriptor. </p> 401 <p>The argument is the identifier field from that parameter's descriptor. </p>
401 402
402 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p> 403 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p>
403 404
404 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 405 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00212">212</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
405 406
406 </div> 407 </div>
407 </div> 408 </div>
408 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="Vamp::PluginBase::setParameter" ref="a6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" --> 409 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a>
409 <div class="memitem"> 410 <div class="memitem">
410 <div class="memproto"> 411 <div class="memproto">
411 <table class="memname"> 412 <table class="memname">
412 <tr> 413 <tr>
413 <td class="memname">virtual void Vamp::PluginBase::setParameter </td> 414 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase::setParameter</a> </td>
414 <td>(</td> 415 <td>(</td>
415 <td class="paramtype">std::string&#160;</td> 416 <td class="paramtype">std::string&#160;</td>
416 <td class="paramname">, </td> 417 <td class="paramname">, </td>
417 </tr> 418 </tr>
418 <tr> 419 <tr>
433 <p>Set a named parameter. </p> 434 <p>Set a named parameter. </p>
434 <p>The first argument is the identifier field from that parameter's descriptor. </p> 435 <p>The first argument is the identifier field from that parameter's descriptor. </p>
435 436
436 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p> 437 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
437 438
438 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 439 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00218">218</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
439 440
440 </div> 441 </div>
441 </div> 442 </div>
442 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="Vamp::PluginBase::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " --> 443 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a>
443 <div class="memitem"> 444 <div class="memitem">
444 <div class="memproto"> 445 <div class="memproto">
445 <table class="memname"> 446 <table class="memname">
446 <tr> 447 <tr>
447 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td> 448 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase::getPrograms</a> </td>
448 <td>(</td> 449 <td>(</td>
449 <td class="paramname"></td><td>)</td> 450 <td class="paramname"></td><td>)</td>
450 <td> const<code> [inline, virtual]</code></td> 451 <td> const<code> [inline, virtual]</code></td>
451 </tr> 452 </tr>
452 </table> 453 </table>
457 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p> 458 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
458 <p>The programs must have unique names. </p> 459 <p>The programs must have unique names. </p>
459 460
460 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> 461 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p>
461 462
462 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 463 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00233">233</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
463 464
464 </div> 465 </div>
465 </div> 466 </div>
466 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="Vamp::PluginBase::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " --> 467 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a>
467 <div class="memitem"> 468 <div class="memitem">
468 <div class="memproto"> 469 <div class="memproto">
469 <table class="memname"> 470 <table class="memname">
470 <tr> 471 <tr>
471 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td> 472 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td>
472 <td>(</td> 473 <td>(</td>
473 <td class="paramname"></td><td>)</td> 474 <td class="paramname"></td><td>)</td>
474 <td> const<code> [inline, virtual]</code></td> 475 <td> const<code> [inline, virtual]</code></td>
475 </tr> 476 </tr>
476 </table> 477 </table>
479 480
480 <p>Get the current program. </p> 481 <p>Get the current program. </p>
481 482
482 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> 483 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
483 484
484 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 485 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00238">238</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
485 486
486 </div> 487 </div>
487 </div> 488 </div>
488 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="Vamp::PluginBase::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" --> 489 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a>
489 <div class="memitem"> 490 <div class="memitem">
490 <div class="memproto"> 491 <div class="memproto">
491 <table class="memname"> 492 <table class="memname">
492 <tr> 493 <tr>
493 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td> 494 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td>
494 <td>(</td> 495 <td>(</td>
495 <td class="paramtype">std::string&#160;</td> 496 <td class="paramtype">std::string&#160;</td>
496 <td class="paramname"></td><td>)</td> 497 <td class="paramname"></td><td>)</td>
497 <td><code> [inline, virtual]</code></td> 498 <td><code> [inline, virtual]</code></td>
498 </tr> 499 </tr>
503 <p>Select a program. </p> 504 <p>Select a program. </p>
504 <p>(If the given program name is not one of the available programs, do nothing.) </p> 505 <p>(If the given program name is not one of the available programs, do nothing.) </p>
505 506
506 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> 507 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
507 508
508 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 509 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00244">244</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
509 510
510 </div> 511 </div>
511 </div> 512 </div>
512 <a class="anchor" id="a2da03e9ced8dc7e4382205e6dc05dbff"></a><!-- doxytag: member="Vamp::PluginBase::getType" ref="a2da03e9ced8dc7e4382205e6dc05dbff" args="() const =0" --> 513 <a class="anchor" id="a2da03e9ced8dc7e4382205e6dc05dbff"></a>
513 <div class="memitem"> 514 <div class="memitem">
514 <div class="memproto"> 515 <div class="memproto">
515 <table class="memname"> 516 <table class="memname">
516 <tr> 517 <tr>
517 <td class="memname">virtual std::string Vamp::PluginBase::getType </td> 518 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase::getType</a> </td>
518 <td>(</td> 519 <td>(</td>
519 <td class="paramname"></td><td>)</td> 520 <td class="paramname"></td><td>)</td>
520 <td> const<code> [pure virtual]</code></td> 521 <td> const<code> [pure virtual]</code></td>
521 </tr> 522 </tr>
522 </table> 523 </table>
531 </div> 532 </div>
532 </div> 533 </div>
533 <hr/>The documentation for this class was generated from the following file:<ul> 534 <hr/>The documentation for this class was generated from the following file:<ul>
534 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li> 535 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
535 </ul> 536 </ul>
536 </div> 537 </div><!-- contents -->
537 </div> 538 </div>
538 <div id="nav-path" class="navpath"> 539 <div id="nav-path" class="navpath">
539 <ul> 540 <ul>
540 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 541 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
541 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li> 542 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li>
542 543
543 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by 544 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
544 <a href="http://www.doxygen.org/index.html"> 545 <a href="http://www.doxygen.org/index.html">
545 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> 546 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
546 </ul> 547 </ul>
547 </div> 548 </div>
548 549
549 550
550 </body> 551 </body>