Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginBase.html @ 40:9391fbda5ad2 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update site for v2.2 release
author cannam
date Thu, 26 Aug 2010 11:36:19 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::PluginBase Class Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::PluginBase Class Reference</h1><!-- doxytag: class="Vamp::PluginBase" -->A base class for plugins with optional configurable parameters, programs, etc.
cannam@35 30 <a href="#_details">More...</a>
cannam@35 31 <p>
cannam@35 32 <code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>&gt;</code>
cannam@0 33 <p>
cannam@0 34 <div class="dynheader">
cannam@0 35 Inheritance diagram for Vamp::PluginBase:</div>
cannam@0 36 <div class="dynsection">
cannam@0 37 <p><center><img src="classVamp_1_1PluginBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginBase__inherit__map" alt="Inheritance graph"></center>
cannam@0 38 <map name="Vamp_1_1PluginBase__inherit__map">
cannam@35 39 <area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="177,173,271,197"><area shape="rect" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function." alt="" coords="355,5,477,29"><area shape="rect" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed&#45;tempo sample." alt="" coords="347,53,485,77"><area shape="rect" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events." alt="" coords="336,101,496,125"><area shape="rect" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency..." alt="" coords="363,149,469,173"><area shape="rect" href="classSpectralCentroid.html" title="Example plugin that calculates the centre of gravity of the frequency domain representation..." alt="" coords="360,197,472,221"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="321,245,511,269"><area shape="rect" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C&#45;language..." alt="" coords="335,293,497,317"><area shape="rect" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero&#45;crossing points..." alt="" coords="369,341,463,365"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by..." alt="" coords="573,173,808,197"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management..." alt="" coords="575,221,807,245"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input..." alt="" coords="561,269,820,293"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods..." alt="" coords="561,317,820,341"></map>
cannam@0 40 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 41
cannam@0 42 <p>
cannam@35 43 <a href="classVamp_1_1PluginBase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 44 <tr><td></td></tr>
cannam@35 45 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
cannam@35 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a></td></tr>
cannam@35 47
cannam@0 48 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@35 49 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br class="typebreak">
cannam@0 50 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
cannam@0 51
cannam@0 52 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
cannam@0 53
cannam@0 54 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@0 55 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a> ()</td></tr>
cannam@0 56
cannam@0 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr>
cannam@0 58
cannam@21 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#8fd2c48291c64b790f0efb8948508dcf"></a><br></td></tr>
cannam@0 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr>
cannam@0 61
cannam@0 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#d1c6dfc77aa03d937a885b7f08258f4a"></a><br></td></tr>
cannam@0 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr>
cannam@0 64
cannam@0 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#18619d5097e444ecefee0c359da53232"></a><br></td></tr>
cannam@0 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr>
cannam@0 67
cannam@0 68 <tr><td class="mdescLeft">&nbsp;</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="#59153a02364f75fff46973b2072e9e5a"></a><br></td></tr>
cannam@0 69 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr>
cannam@0 70
cannam@0 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#53d9918bf9ef4d12feedf66b2b26c637"></a><br></td></tr>
cannam@0 72 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr>
cannam@0 73
cannam@0 74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#b7e9dedbe965f5ab9018b72920fe7661"></a><br></td></tr>
cannam@0 75 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr>
cannam@0 76
cannam@0 77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#63f686d77bc3d6b807e7944cdde83151"></a><br></td></tr>
cannam@0 78 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr>
cannam@0 79
cannam@0 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ac3e49b3b66cacfbb768dfdf07444f21"></a><br></td></tr>
cannam@0 81 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr>
cannam@0 82
cannam@0 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#97ababcd45348ceec998d0f8e0f38bf7"></a><br></td></tr>
cannam@0 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
cannam@0 85
cannam@0 86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#6c718ce822f7b73b98940d59dcaa9366"></a><br></td></tr>
cannam@0 87 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr>
cannam@0 88
cannam@0 89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#bb307c60bdb981d5f5af50c3c4ae84af"></a><br></td></tr>
cannam@0 90 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr>
cannam@0 91
cannam@0 92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#24e77eccf1bdfbbca3c79bb25e8799b3"></a><br></td></tr>
cannam@0 93 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
cannam@0 94
cannam@0 95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#add3a547ef140bae200473a9518e3353"></a><br></td></tr>
cannam@0 96 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">getType</a> () const =0</td></tr>
cannam@0 97
cannam@0 98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the type of plugin. <a href="#2da03e9ced8dc7e4382205e6dc05dbff"></a><br></td></tr>
cannam@0 99 </table>
cannam@35 100 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 101 A base class for plugins with optional configurable parameters, programs, etc.
cannam@35 102 <p>
cannam@35 103 The <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> is derived from this, and individual <a class="el" href="namespaceVamp.html">Vamp</a> plugins should derive from that.<p>
cannam@35 104 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.
cannam@35 105 <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>
cannam@0 106 <hr><h2>Member Typedef Documentation</h2>
cannam@0 107 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 108 <div class="memitem">
cannam@0 109 <div class="memproto">
cannam@0 110 <table class="memname">
cannam@0 111 <tr>
cannam@0 112 <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#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a> </td>
cannam@0 113 </tr>
cannam@0 114 </table>
cannam@0 115 </div>
cannam@0 116 <div class="memdoc">
cannam@0 117
cannam@0 118 <p>
cannam@0 119
cannam@21 120 <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>
cannam@0 121
cannam@0 122 </div>
cannam@0 123 </div><p>
cannam@0 124 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginBase::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 125 <div class="memitem">
cannam@0 126 <div class="memproto">
cannam@0 127 <table class="memname">
cannam@0 128 <tr>
cannam@0 129 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a> </td>
cannam@0 130 </tr>
cannam@0 131 </table>
cannam@0 132 </div>
cannam@0 133 <div class="memdoc">
cannam@0 134
cannam@0 135 <p>
cannam@0 136
cannam@21 137 <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>
cannam@0 138
cannam@0 139 </div>
cannam@0 140 </div><p>
cannam@0 141 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 142 <a class="anchor" name="3773b37c658cf22d7f135c575a28f5c5"></a><!-- doxytag: member="Vamp::PluginBase::~PluginBase" ref="3773b37c658cf22d7f135c575a28f5c5" args="()" -->
cannam@0 143 <div class="memitem">
cannam@0 144 <div class="memproto">
cannam@0 145 <table class="memname">
cannam@0 146 <tr>
cannam@0 147 <td class="memname">virtual Vamp::PluginBase::~PluginBase </td>
cannam@0 148 <td>(</td>
cannam@0 149 <td class="paramname"> </td>
cannam@0 150 <td>&nbsp;)&nbsp;</td>
cannam@21 151 <td><code> [inline, virtual]</code></td>
cannam@0 152 </tr>
cannam@0 153 </table>
cannam@0 154 </div>
cannam@0 155 <div class="memdoc">
cannam@0 156
cannam@0 157 <p>
cannam@0 158
cannam@21 159 <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>
cannam@0 160
cannam@0 161 </div>
cannam@0 162 </div><p>
cannam@0 163 <hr><h2>Member Function Documentation</h2>
cannam@0 164 <a class="anchor" name="8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="Vamp::PluginBase::getVampApiVersion" ref="8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
cannam@0 165 <div class="memitem">
cannam@0 166 <div class="memproto">
cannam@0 167 <table class="memname">
cannam@0 168 <tr>
cannam@0 169 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
cannam@0 170 <td>(</td>
cannam@0 171 <td class="paramname"> </td>
cannam@0 172 <td>&nbsp;)&nbsp;</td>
cannam@21 173 <td> const<code> [inline, virtual]</code></td>
cannam@0 174 </tr>
cannam@0 175 </table>
cannam@0 176 </div>
cannam@0 177 <div class="memdoc">
cannam@0 178
cannam@0 179 <p>
cannam@21 180 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
cannam@0 181 <p>
cannam@0 182
cannam@0 183 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 184
cannam@21 185 <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>
cannam@0 186
cannam@21 187 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 188
cannam@0 189 </div>
cannam@0 190 </div><p>
cannam@0 191 <a class="anchor" name="d1c6dfc77aa03d937a885b7f08258f4a"></a><!-- doxytag: member="Vamp::PluginBase::getIdentifier" ref="d1c6dfc77aa03d937a885b7f08258f4a" args="() const =0" -->
cannam@0 192 <div class="memitem">
cannam@0 193 <div class="memproto">
cannam@0 194 <table class="memname">
cannam@0 195 <tr>
cannam@0 196 <td class="memname">virtual std::string Vamp::PluginBase::getIdentifier </td>
cannam@0 197 <td>(</td>
cannam@0 198 <td class="paramname"> </td>
cannam@0 199 <td>&nbsp;)&nbsp;</td>
cannam@21 200 <td> const<code> [pure virtual]</code></td>
cannam@0 201 </tr>
cannam@0 202 </table>
cannam@0 203 </div>
cannam@0 204 <div class="memdoc">
cannam@0 205
cannam@0 206 <p>
cannam@0 207 Get the computer-usable name of the plugin.
cannam@0 208 <p>
cannam@0 209 This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.<p>
cannam@0 210 This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).<p>
cannam@0 211 Example: "zero_crossings"
cannam@21 212 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#b27423a656f878d97d2ad2eba4e76c7a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#fe7576af95c8fcc7f5bad42eec9f9f29">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#b818edcf1555177d10260e197e3a5e7a">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#267c83a7533146c127e2c3be310e0154">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#9e9d8349461cbb88d7565a5e8c51b64e">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#1b2c4c8440c024c4c635fcef5697949f">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#f2baf9e19fcdd11cfe97ace56d4f5c1a">ZeroCrossing</a>.</p>
cannam@0 213
cannam@21 214 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
cannam@0 215
cannam@0 216 </div>
cannam@0 217 </div><p>
cannam@0 218 <a class="anchor" name="18619d5097e444ecefee0c359da53232"></a><!-- doxytag: member="Vamp::PluginBase::getName" ref="18619d5097e444ecefee0c359da53232" args="() const =0" -->
cannam@0 219 <div class="memitem">
cannam@0 220 <div class="memproto">
cannam@0 221 <table class="memname">
cannam@0 222 <tr>
cannam@0 223 <td class="memname">virtual std::string Vamp::PluginBase::getName </td>
cannam@0 224 <td>(</td>
cannam@0 225 <td class="paramname"> </td>
cannam@0 226 <td>&nbsp;)&nbsp;</td>
cannam@21 227 <td> const<code> [pure virtual]</code></td>
cannam@0 228 </tr>
cannam@0 229 </table>
cannam@0 230 </div>
cannam@0 231 <div class="memdoc">
cannam@0 232
cannam@0 233 <p>
cannam@0 234 Get a human-readable name or title of the plugin.
cannam@0 235 <p>
cannam@0 236 This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").<p>
cannam@0 237 Example: "Zero Crossings"
cannam@21 238 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#45f1d0377e233eeddd1b7cefb48be62a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#7cfed00bc9d96ba6c709b69ab6a40594">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#f9eb6fa8a98aa66b55e64e1795f9405f">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#a98f1ad061a11af98c054011a8844e6f">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#c9214f9cafeeed3fca549c90aef57623">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#b7e6a620fea568af431be3cfd9dd5a41">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#fa96f7ce6e7d9f03768f48c6a9d88498">ZeroCrossing</a>.</p>
cannam@0 239
cannam@21 240 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p>
cannam@0 241
cannam@0 242 </div>
cannam@0 243 </div><p>
cannam@0 244 <a class="anchor" name="59153a02364f75fff46973b2072e9e5a"></a><!-- doxytag: member="Vamp::PluginBase::getDescription" ref="59153a02364f75fff46973b2072e9e5a" args="() const =0" -->
cannam@0 245 <div class="memitem">
cannam@0 246 <div class="memproto">
cannam@0 247 <table class="memname">
cannam@0 248 <tr>
cannam@0 249 <td class="memname">virtual std::string Vamp::PluginBase::getDescription </td>
cannam@0 250 <td>(</td>
cannam@0 251 <td class="paramname"> </td>
cannam@0 252 <td>&nbsp;)&nbsp;</td>
cannam@21 253 <td> const<code> [pure virtual]</code></td>
cannam@0 254 </tr>
cannam@0 255 </table>
cannam@0 256 </div>
cannam@0 257 <div class="memdoc">
cannam@0 258
cannam@0 259 <p>
cannam@0 260 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".
cannam@0 261 <p>
cannam@0 262 May be empty if the name has said it all already.<p>
cannam@0 263 Example: "Detect and count zero crossing points"
cannam@21 264 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#5eaafcef030e81b90a3e77cf16cf8ae1">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#6f0f2fea1fdb4b51e688edfe859d5062">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#06b00853f00c2e78d490697fcd7d1920">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#9061d189705802a48973a7ccab6360db">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#7b48d56dc954f3af344f7e4dcd8993e5">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#8fbb74a46283057d9a0b0e4718ee943c">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#710bb0b013157adaeef2a9e6867b4478">ZeroCrossing</a>.</p>
cannam@0 265
cannam@21 266 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p>
cannam@0 267
cannam@0 268 </div>
cannam@0 269 </div><p>
cannam@0 270 <a class="anchor" name="53d9918bf9ef4d12feedf66b2b26c637"></a><!-- doxytag: member="Vamp::PluginBase::getMaker" ref="53d9918bf9ef4d12feedf66b2b26c637" args="() const =0" -->
cannam@0 271 <div class="memitem">
cannam@0 272 <div class="memproto">
cannam@0 273 <table class="memname">
cannam@0 274 <tr>
cannam@0 275 <td class="memname">virtual std::string Vamp::PluginBase::getMaker </td>
cannam@0 276 <td>(</td>
cannam@0 277 <td class="paramname"> </td>
cannam@0 278 <td>&nbsp;)&nbsp;</td>
cannam@21 279 <td> const<code> [pure virtual]</code></td>
cannam@0 280 </tr>
cannam@0 281 </table>
cannam@0 282 </div>
cannam@0 283 <div class="memdoc">
cannam@0 284
cannam@0 285 <p>
cannam@0 286 Get the name of the author or vendor of the plugin in human-readable form.
cannam@0 287 <p>
cannam@0 288 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
cannam@21 289 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#f572be0b175f5661559006a380a0f3db">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#44fc43838f203f58bc2ce6e3cb2b03dd">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#e910d1b9250b11097fd6b51cd8285b68">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#63d63f2cb7ea8d8b09d58cc13b541375">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#9f3e3f759e2b67c771a41f1c276984b2">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#c01ff858bf67e2e93ad5d24a6ba8c8c8">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#c68561634a3c329a029c2fd3deaeae2a">ZeroCrossing</a>.</p>
cannam@0 290
cannam@21 291 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00778">printPluginCategoryList()</a>.</p>
cannam@0 292
cannam@0 293 </div>
cannam@0 294 </div><p>
cannam@0 295 <a class="anchor" name="b7e9dedbe965f5ab9018b72920fe7661"></a><!-- doxytag: member="Vamp::PluginBase::getCopyright" ref="b7e9dedbe965f5ab9018b72920fe7661" args="() const =0" -->
cannam@0 296 <div class="memitem">
cannam@0 297 <div class="memproto">
cannam@0 298 <table class="memname">
cannam@0 299 <tr>
cannam@0 300 <td class="memname">virtual std::string Vamp::PluginBase::getCopyright </td>
cannam@0 301 <td>(</td>
cannam@0 302 <td class="paramname"> </td>
cannam@0 303 <td>&nbsp;)&nbsp;</td>
cannam@21 304 <td> const<code> [pure virtual]</code></td>
cannam@0 305 </tr>
cannam@0 306 </table>
cannam@0 307 </div>
cannam@0 308 <div class="memdoc">
cannam@0 309
cannam@0 310 <p>
cannam@0 311 Get the copyright statement or licensing summary for the plugin.
cannam@0 312 <p>
cannam@0 313 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
cannam@21 314 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#c73c9d6baad04369beee695e99584815">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#0c197fc90f30d91cb4403115c83c9134">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#50c6b64530c84c0707ba3936c5022a48">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#1a22ece271330c94cc08798a77416351">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#708b4d335c57643d5ef2b2e1caf43bd9">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#925747d513d598e0fa21ed0ed6520980">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#f9c41b92aa8ff8bddaebf75569ff789c">ZeroCrossing</a>.</p>
cannam@0 315
cannam@21 316 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 317
cannam@0 318 </div>
cannam@0 319 </div><p>
cannam@0 320 <a class="anchor" name="63f686d77bc3d6b807e7944cdde83151"></a><!-- doxytag: member="Vamp::PluginBase::getPluginVersion" ref="63f686d77bc3d6b807e7944cdde83151" args="() const =0" -->
cannam@0 321 <div class="memitem">
cannam@0 322 <div class="memproto">
cannam@0 323 <table class="memname">
cannam@0 324 <tr>
cannam@0 325 <td class="memname">virtual int Vamp::PluginBase::getPluginVersion </td>
cannam@0 326 <td>(</td>
cannam@0 327 <td class="paramname"> </td>
cannam@0 328 <td>&nbsp;)&nbsp;</td>
cannam@21 329 <td> const<code> [pure virtual]</code></td>
cannam@0 330 </tr>
cannam@0 331 </table>
cannam@0 332 </div>
cannam@0 333 <div class="memdoc">
cannam@0 334
cannam@0 335 <p>
cannam@0 336 Get the version number of the plugin.
cannam@0 337 <p>
cannam@0 338
cannam@21 339 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#6fbd94781867ca46a20368c2a3593c77">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#8a5d7a834eb996d517c51f84b2a72250">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#d002fddb3735c2dd7e31e6a9def9949f">FixedTempoEstimator</a>, <a class="el" href="classPercussionOnsetDetector.html#d6b818dbd81867ce7be71c99cae861be">PercussionOnsetDetector</a>, <a class="el" href="classPowerSpectrum.html#d23d27e4e82f10404a37b933f6a72c33">PowerSpectrum</a>, <a class="el" href="classSpectralCentroid.html#f64622e66bf678ac2b0b58aa832ca2b3">SpectralCentroid</a>, and <a class="el" href="classZeroCrossing.html#d685f6c2f443f07a1634550c335571eb">ZeroCrossing</a>.</p>
cannam@0 340
cannam@21 341 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 342
cannam@0 343 </div>
cannam@0 344 </div><p>
cannam@0 345 <a class="anchor" name="ac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="Vamp::PluginBase::getParameterDescriptors" ref="ac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
cannam@0 346 <div class="memitem">
cannam@0 347 <div class="memproto">
cannam@0 348 <table class="memname">
cannam@0 349 <tr>
cannam@0 350 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
cannam@0 351 <td>(</td>
cannam@0 352 <td class="paramname"> </td>
cannam@0 353 <td>&nbsp;)&nbsp;</td>
cannam@21 354 <td> const<code> [inline, virtual]</code></td>
cannam@0 355 </tr>
cannam@0 356 </table>
cannam@0 357 </div>
cannam@0 358 <div class="memdoc">
cannam@0 359
cannam@0 360 <p>
cannam@0 361 Get the controllable parameters of this plugin.
cannam@0 362 <p>
cannam@0 363
cannam@21 364 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#e157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#bceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p>
cannam@0 365
cannam@21 366 <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>
cannam@0 367
cannam@21 368 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00559">enumeratePlugins()</a>.</p>
cannam@0 369
cannam@0 370 </div>
cannam@0 371 </div><p>
cannam@0 372 <a class="anchor" name="97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="Vamp::PluginBase::getParameter" ref="97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
cannam@0 373 <div class="memitem">
cannam@0 374 <div class="memproto">
cannam@0 375 <table class="memname">
cannam@0 376 <tr>
cannam@0 377 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
cannam@0 378 <td>(</td>
cannam@0 379 <td class="paramtype">std::string&nbsp;</td>
cannam@0 380 <td class="paramname"> </td>
cannam@0 381 <td>&nbsp;)&nbsp;</td>
cannam@21 382 <td> const<code> [inline, virtual]</code></td>
cannam@0 383 </tr>
cannam@0 384 </table>
cannam@0 385 </div>
cannam@0 386 <div class="memdoc">
cannam@0 387
cannam@0 388 <p>
cannam@0 389 Get the value of a named parameter.
cannam@0 390 <p>
cannam@0 391 The argument is the identifier field from that parameter's descriptor.
cannam@21 392 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#f0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#b278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p>
cannam@0 393
cannam@21 394 <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>
cannam@0 395
cannam@0 396 </div>
cannam@0 397 </div><p>
cannam@0 398 <a class="anchor" name="6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="Vamp::PluginBase::setParameter" ref="6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
cannam@0 399 <div class="memitem">
cannam@0 400 <div class="memproto">
cannam@0 401 <table class="memname">
cannam@0 402 <tr>
cannam@0 403 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
cannam@0 404 <td>(</td>
cannam@0 405 <td class="paramtype">std::string&nbsp;</td>
cannam@0 406 <td class="paramname">, </td>
cannam@0 407 </tr>
cannam@0 408 <tr>
cannam@0 409 <td class="paramkey"></td>
cannam@0 410 <td></td>
cannam@0 411 <td class="paramtype">float&nbsp;</td>
cannam@0 412 <td class="paramname"></td><td>&nbsp;</td>
cannam@0 413 </tr>
cannam@0 414 <tr>
cannam@0 415 <td></td>
cannam@0 416 <td>)</td>
cannam@21 417 <td></td><td></td><td><code> [inline, virtual]</code></td>
cannam@0 418 </tr>
cannam@0 419 </table>
cannam@0 420 </div>
cannam@0 421 <div class="memdoc">
cannam@0 422
cannam@0 423 <p>
cannam@0 424 Set a named parameter.
cannam@0 425 <p>
cannam@0 426 The first argument is the identifier field from that parameter's descriptor.
cannam@21 427 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#e1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
cannam@0 428
cannam@21 429 <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>
cannam@0 430
cannam@0 431 </div>
cannam@0 432 </div><p>
cannam@0 433 <a class="anchor" name="bb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="Vamp::PluginBase::getPrograms" ref="bb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
cannam@0 434 <div class="memitem">
cannam@0 435 <div class="memproto">
cannam@0 436 <table class="memname">
cannam@0 437 <tr>
cannam@0 438 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
cannam@0 439 <td>(</td>
cannam@0 440 <td class="paramname"> </td>
cannam@0 441 <td>&nbsp;)&nbsp;</td>
cannam@21 442 <td> const<code> [inline, virtual]</code></td>
cannam@0 443 </tr>
cannam@0 444 </table>
cannam@0 445 </div>
cannam@0 446 <div class="memdoc">
cannam@0 447
cannam@0 448 <p>
cannam@0 449 Get the program settings available in this plugin.
cannam@0 450 <p>
cannam@0 451 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>
cannam@0 452 The programs must have unique names.
cannam@21 453 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#e0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 454
cannam@21 455 <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>
cannam@0 456
cannam@0 457 </div>
cannam@0 458 </div><p>
cannam@0 459 <a class="anchor" name="24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="Vamp::PluginBase::getCurrentProgram" ref="24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
cannam@0 460 <div class="memitem">
cannam@0 461 <div class="memproto">
cannam@0 462 <table class="memname">
cannam@0 463 <tr>
cannam@0 464 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
cannam@0 465 <td>(</td>
cannam@0 466 <td class="paramname"> </td>
cannam@0 467 <td>&nbsp;)&nbsp;</td>
cannam@21 468 <td> const<code> [inline, virtual]</code></td>
cannam@0 469 </tr>
cannam@0 470 </table>
cannam@0 471 </div>
cannam@0 472 <div class="memdoc">
cannam@0 473
cannam@0 474 <p>
cannam@0 475 Get the current program.
cannam@0 476 <p>
cannam@0 477
cannam@0 478 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 479
cannam@21 480 <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>
cannam@0 481
cannam@0 482 </div>
cannam@0 483 </div><p>
cannam@0 484 <a class="anchor" name="add3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="Vamp::PluginBase::selectProgram" ref="add3a547ef140bae200473a9518e3353" args="(std::string)" -->
cannam@0 485 <div class="memitem">
cannam@0 486 <div class="memproto">
cannam@0 487 <table class="memname">
cannam@0 488 <tr>
cannam@0 489 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
cannam@0 490 <td>(</td>
cannam@0 491 <td class="paramtype">std::string&nbsp;</td>
cannam@0 492 <td class="paramname"> </td>
cannam@0 493 <td>&nbsp;)&nbsp;</td>
cannam@21 494 <td><code> [inline, virtual]</code></td>
cannam@0 495 </tr>
cannam@0 496 </table>
cannam@0 497 </div>
cannam@0 498 <div class="memdoc">
cannam@0 499
cannam@0 500 <p>
cannam@0 501 Select a program.
cannam@0 502 <p>
cannam@0 503 (If the given program name is not one of the available programs, do nothing.)
cannam@21 504 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
cannam@0 505
cannam@21 506 <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>
cannam@0 507
cannam@0 508 </div>
cannam@0 509 </div><p>
cannam@0 510 <a class="anchor" name="2da03e9ced8dc7e4382205e6dc05dbff"></a><!-- doxytag: member="Vamp::PluginBase::getType" ref="2da03e9ced8dc7e4382205e6dc05dbff" args="() const =0" -->
cannam@0 511 <div class="memitem">
cannam@0 512 <div class="memproto">
cannam@0 513 <table class="memname">
cannam@0 514 <tr>
cannam@0 515 <td class="memname">virtual std::string Vamp::PluginBase::getType </td>
cannam@0 516 <td>(</td>
cannam@0 517 <td class="paramname"> </td>
cannam@0 518 <td>&nbsp;)&nbsp;</td>
cannam@21 519 <td> const<code> [pure virtual]</code></td>
cannam@0 520 </tr>
cannam@0 521 </table>
cannam@0 522 </div>
cannam@0 523 <div class="memdoc">
cannam@0 524
cannam@0 525 <p>
cannam@0 526 Get the type of plugin.
cannam@0 527 <p>
cannam@0 528 This is to be implemented by the immediate subclass, not by actual plugins. Do not attempt to implement this in plugin code.
cannam@0 529 <p>Implemented in <a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">Vamp::Plugin</a>.</p>
cannam@0 530
cannam@0 531 </div>
cannam@0 532 </div><p>
cannam@0 533 <hr>The documentation for this class was generated from the following file:<ul>
cannam@21 534 <li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul>
cannam@0 535 </div>
cannam@35 536 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 537 <a href="http://www.doxygen.org/index.html">
cannam@35 538 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 539 </body>
cannam@0 540 </html>