Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginBase.html @ 128:817c3988afc7 website tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a page about the Vamp Plugin Pack, including links to download mirrors
author Chris Cannam
date Tue, 11 Aug 2020 16:41:11 +0100
parents 8260c0f4e05b
children
rev   line source
cannam@50 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@50 2 <html xmlns="http://www.w3.org/1999/xhtml">
cannam@50 3 <head>
cannam@50 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
cannam@0 5 <title>VampPluginSDK: Vamp::PluginBase Class Reference</title>
cannam@50 6
cannam@50 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
cannam@50 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
cannam@50 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
cannam@50 10 <script type="text/javascript" src="jquery.js"></script>
cannam@50 11 <script type="text/javascript" src="resize.js"></script>
cannam@50 12 <script type="text/javascript" src="navtree.js"></script>
cannam@50 13 <script type="text/javascript">
cannam@50 14 $(document).ready(initResizable);
cannam@50 15 </script>
cannam@50 16
cannam@50 17
cannam@50 18 </head>
cannam@50 19 <body>
cannam@50 20 <div id="top"><!-- do not remove this div! -->
cannam@50 21
cannam@50 22
cannam@50 23 <div id="titlearea">
cannam@50 24 <table cellspacing="0" cellpadding="0">
cannam@50 25 <tbody>
cannam@50 26 <tr style="height: 56px;">
cannam@50 27
cannam@50 28
cannam@50 29 <td style="padding-left: 0.5em;">
cannam@50 30 <div id="projectname">VampPluginSDK
cannam@50 31 &#160;<span id="projectnumber">2.1</span>
cannam@50 32 </div>
cannam@50 33
cannam@50 34 </td>
cannam@50 35
cannam@50 36
cannam@50 37
cannam@50 38 </tr>
cannam@50 39 </tbody>
cannam@50 40 </table>
cannam@50 41 </div>
cannam@50 42
cannam@50 43 <!-- Generated by Doxygen 1.7.5.1 -->
cannam@50 44 <div id="navrow1" class="tabs">
cannam@50 45 <ul class="tablist">
cannam@50 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
cannam@0 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 49 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 50 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 51 </ul>
cannam@0 52 </div>
cannam@50 53 <div id="navrow2" class="tabs2">
cannam@50 54 <ul class="tablist">
cannam@50 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
cannam@50 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
cannam@50 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
cannam@0 58 </ul>
cannam@0 59 </div>
cannam@50 60 </div>
cannam@50 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
cannam@50 62 <div id="nav-tree">
cannam@50 63 <div id="nav-tree-contents">
cannam@50 64 </div>
cannam@50 65 </div>
cannam@50 66 <div id="splitbar" style="-moz-user-select:none;"
cannam@50 67 class="ui-resizable-handle">
cannam@0 68 </div>
cannam@0 69 </div>
cannam@50 70 <script type="text/javascript">
cannam@50 71 initNavTree('classVamp_1_1PluginBase.html','');
cannam@50 72 </script>
cannam@50 73 <div id="doc-content">
cannam@50 74 <div class="header">
cannam@50 75 <div class="summary">
cannam@50 76 <a href="#nested-classes">Classes</a> &#124;
cannam@50 77 <a href="#pub-types">Public Types</a> &#124;
cannam@50 78 <a href="#pub-methods">Public Member Functions</a> </div>
cannam@50 79 <div class="headertitle">
cannam@50 80 <div class="title">Vamp::PluginBase Class Reference</div> </div>
cannam@50 81 </div>
cannam@0 82 <div class="contents">
cannam@50 83 <!-- doxytag: class="Vamp::PluginBase" -->
cannam@50 84 <p>A base class for plugins with optional configurable parameters, programs, etc.
cannam@50 85 <a href="classVamp_1_1PluginBase.html#details">More...</a></p>
cannam@50 86
cannam@50 87 <p><code>#include &lt;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&gt;</code></p>
cannam@0 88 <div class="dynheader">
cannam@0 89 Inheritance diagram for Vamp::PluginBase:</div>
cannam@50 90 <div class="dyncontent">
cannam@50 91 <div class="center"><img src="classVamp_1_1PluginBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginBase_inherit__map" alt="Inheritance graph"/></div>
cannam@50 92 <map name="Vamp_1_1PluginBase_inherit__map" id="Vamp_1_1PluginBase_inherit__map">
cannam@50 93 <area shape="rect" id="node3" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="174,178,266,203"/><area shape="rect" id="node5" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function." alt="" coords="345,5,468,30"/><area shape="rect" id="node7" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed&#45;tempo sample." alt="" coords="338,54,475,79"/><area shape="rect" id="node9" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events." alt="" coords="329,103,484,129"/><area shape="rect" id="node11" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe..." alt="" coords="353,153,460,178"/><area shape="rect" id="node13" href="classSpectralCentroid.html" title="Example plugin that calculates the centre of gravity of the frequency domain representation of each b..." alt="" coords="351,202,463,227"/><area shape="rect" id="node15" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="315,251,499,277"/><area shape="rect" id="node25" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C&#45;language VampPluginDescri..." alt="" coords="327,301,486,326"/><area shape="rect" id="node27" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero&#45;crossing points in an audio waveform..." alt="" coords="360,350,453,375"/><area shape="rect" id="node17" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="558,178,789,203"/><area shape="rect" id="node19" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="560,227,787,253"/><area shape="rect" id="node21" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input into frequency&#45;doma..." alt="" coords="547,277,800,302"/><area shape="rect" id="node23" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="547,326,800,351"/></map>
cannam@50 94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
cannam@0 95
cannam@50 96 <p><a href="classVamp_1_1PluginBase-members.html">List of all members.</a></p>
cannam@50 97 <table class="memberdecls">
cannam@50 98 <tr><td colspan="2"><h2><a name="nested-classes"></a>
cannam@50 99 Classes</h2></td></tr>
cannam@50 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>
cannam@50 101 <tr><td colspan="2"><h2><a name="pub-types"></a>
cannam@50 102 Public Types</h2></td></tr>
cannam@50 103 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
cannam@50 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>
cannam@50 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>
cannam@50 106 <tr><td colspan="2"><h2><a name="pub-methods"></a>
cannam@50 107 Public Member Functions</h2></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151"></a><br/></td></tr>
cannam@50 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>
cannam@50 124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr>
cannam@50 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>
cannam@50 126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr>
cannam@50 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>
cannam@50 128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr>
cannam@50 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>
cannam@50 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>
cannam@50 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>
cannam@50 132 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr>
cannam@50 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>
cannam@50 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr>
cannam@50 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>
cannam@50 136 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of plugin. <a href="#a2da03e9ced8dc7e4382205e6dc05dbff"></a><br/></td></tr>
cannam@50 137 </table>
cannam@50 138 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
cannam@50 139 <div class="textblock"><p>A base class for plugins with optional configurable parameters, programs, etc. </p>
cannam@50 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>
cannam@50 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>
cannam@35 142
cannam@50 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>
cannam@50 144 </div><hr/><h2>Member Typedef Documentation</h2>
cannam@50 145 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
cannam@0 146 <div class="memitem">
cannam@0 147 <div class="memproto">
cannam@0 148 <table class="memname">
cannam@0 149 <tr>
cannam@50 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>
cannam@0 151 </tr>
cannam@0 152 </table>
cannam@0 153 </div>
cannam@0 154 <div class="memdoc">
cannam@0 155
cannam@50 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>
cannam@0 157
cannam@0 158 </div>
cannam@50 159 </div>
cannam@50 160 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::PluginBase::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
cannam@0 161 <div class="memitem">
cannam@0 162 <div class="memproto">
cannam@0 163 <table class="memname">
cannam@0 164 <tr>
cannam@50 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>
cannam@0 166 </tr>
cannam@0 167 </table>
cannam@0 168 </div>
cannam@0 169 <div class="memdoc">
cannam@0 170
cannam@50 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>
cannam@0 172
cannam@0 173 </div>
cannam@50 174 </div>
cannam@50 175 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
cannam@50 176 <a class="anchor" id="a3773b37c658cf22d7f135c575a28f5c5"></a><!-- doxytag: member="Vamp::PluginBase::~PluginBase" ref="a3773b37c658cf22d7f135c575a28f5c5" args="()" -->
cannam@0 177 <div class="memitem">
cannam@0 178 <div class="memproto">
cannam@0 179 <table class="memname">
cannam@0 180 <tr>
cannam@50 181 <td class="memname">virtual Vamp::PluginBase::~PluginBase </td>
cannam@0 182 <td>(</td>
cannam@50 183 <td class="paramname"></td><td>)</td>
cannam@21 184 <td><code> [inline, virtual]</code></td>
cannam@0 185 </tr>
cannam@0 186 </table>
cannam@0 187 </div>
cannam@0 188 <div class="memdoc">
cannam@0 189
cannam@50 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>
cannam@0 191
cannam@0 192 </div>
cannam@50 193 </div>
cannam@50 194 <hr/><h2>Member Function Documentation</h2>
cannam@50 195 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a><!-- doxytag: member="Vamp::PluginBase::getVampApiVersion" ref="a8fd2c48291c64b790f0efb8948508dcf" args="() const " -->
cannam@0 196 <div class="memitem">
cannam@0 197 <div class="memproto">
cannam@0 198 <table class="memname">
cannam@0 199 <tr>
cannam@50 200 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
cannam@0 201 <td>(</td>
cannam@50 202 <td class="paramname"></td><td>)</td>
cannam@21 203 <td> const<code> [inline, virtual]</code></td>
cannam@0 204 </tr>
cannam@0 205 </table>
cannam@0 206 </div>
cannam@0 207 <div class="memdoc">
cannam@0 208
cannam@50 209 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
cannam@0 210
cannam@50 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>
cannam@0 212
cannam@50 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>
cannam@0 214
cannam@50 215 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 216
cannam@0 217 </div>
cannam@50 218 </div>
cannam@50 219 <a class="anchor" id="ad1c6dfc77aa03d937a885b7f08258f4a"></a><!-- doxytag: member="Vamp::PluginBase::getIdentifier" ref="ad1c6dfc77aa03d937a885b7f08258f4a" args="() const =0" -->
cannam@0 220 <div class="memitem">
cannam@0 221 <div class="memproto">
cannam@0 222 <table class="memname">
cannam@0 223 <tr>
cannam@50 224 <td class="memname">virtual std::string Vamp::PluginBase::getIdentifier </td>
cannam@0 225 <td>(</td>
cannam@50 226 <td class="paramname"></td><td>)</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@50 233 <p>Get the computer-usable name of the plugin. </p>
cannam@50 234 <p>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@50 235 <p>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@50 236 <p>Example: "zero_crossings" </p>
cannam@0 237
cannam@50 238 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ab27423a656f878d97d2ad2eba4e76c7a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a9e9d8349461cbb88d7565a5e8c51b64e">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a1b2c4c8440c024c4c635fcef5697949f">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#ab818edcf1555177d10260e197e3a5e7a">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a267c83a7533146c127e2c3be310e0154">PercussionOnsetDetector</a>.</p>
cannam@50 239
cannam@50 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>
cannam@0 241
cannam@0 242 </div>
cannam@50 243 </div>
cannam@50 244 <a class="anchor" id="a18619d5097e444ecefee0c359da53232"></a><!-- doxytag: member="Vamp::PluginBase::getName" ref="a18619d5097e444ecefee0c359da53232" 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@50 249 <td class="memname">virtual std::string Vamp::PluginBase::getName </td>
cannam@0 250 <td>(</td>
cannam@50 251 <td class="paramname"></td><td>)</td>
cannam@21 252 <td> const<code> [pure virtual]</code></td>
cannam@0 253 </tr>
cannam@0 254 </table>
cannam@0 255 </div>
cannam@0 256 <div class="memdoc">
cannam@0 257
cannam@50 258 <p>Get a human-readable name or title of the plugin. </p>
cannam@50 259 <p>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@50 260 <p>Example: "Zero Crossings" </p>
cannam@0 261
cannam@50 262 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a45f1d0377e233eeddd1b7cefb48be62a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#ac9214f9cafeeed3fca549c90aef57623">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#ab7e6a620fea568af431be3cfd9dd5a41">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#af9eb6fa8a98aa66b55e64e1795f9405f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa98f1ad061a11af98c054011a8844e6f">PercussionOnsetDetector</a>.</p>
cannam@50 263
cannam@50 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>
cannam@0 265
cannam@0 266 </div>
cannam@50 267 </div>
cannam@50 268 <a class="anchor" id="a59153a02364f75fff46973b2072e9e5a"></a><!-- doxytag: member="Vamp::PluginBase::getDescription" ref="a59153a02364f75fff46973b2072e9e5a" args="() const =0" -->
cannam@0 269 <div class="memitem">
cannam@0 270 <div class="memproto">
cannam@0 271 <table class="memname">
cannam@0 272 <tr>
cannam@50 273 <td class="memname">virtual std::string Vamp::PluginBase::getDescription </td>
cannam@0 274 <td>(</td>
cannam@50 275 <td class="paramname"></td><td>)</td>
cannam@21 276 <td> const<code> [pure virtual]</code></td>
cannam@0 277 </tr>
cannam@0 278 </table>
cannam@0 279 </div>
cannam@0 280 <div class="memdoc">
cannam@0 281
cannam@50 282 <p>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". </p>
cannam@50 283 <p>May be empty if the name has said it all already.</p>
cannam@50 284 <p>Example: "Detect and count zero crossing points" </p>
cannam@0 285
cannam@50 286 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a5eaafcef030e81b90a3e77cf16cf8ae1">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a7b48d56dc954f3af344f7e4dcd8993e5">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a8fbb74a46283057d9a0b0e4718ee943c">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a06b00853f00c2e78d490697fcd7d1920">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9061d189705802a48973a7ccab6360db">PercussionOnsetDetector</a>.</p>
cannam@50 287
cannam@50 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>
cannam@0 289
cannam@0 290 </div>
cannam@50 291 </div>
cannam@50 292 <a class="anchor" id="a53d9918bf9ef4d12feedf66b2b26c637"></a><!-- doxytag: member="Vamp::PluginBase::getMaker" ref="a53d9918bf9ef4d12feedf66b2b26c637" args="() const =0" -->
cannam@0 293 <div class="memitem">
cannam@0 294 <div class="memproto">
cannam@0 295 <table class="memname">
cannam@0 296 <tr>
cannam@50 297 <td class="memname">virtual std::string Vamp::PluginBase::getMaker </td>
cannam@0 298 <td>(</td>
cannam@50 299 <td class="paramname"></td><td>)</td>
cannam@21 300 <td> const<code> [pure virtual]</code></td>
cannam@0 301 </tr>
cannam@0 302 </table>
cannam@0 303 </div>
cannam@0 304 <div class="memdoc">
cannam@0 305
cannam@50 306 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
cannam@50 307 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
cannam@0 308
cannam@50 309 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af572be0b175f5661559006a380a0f3db">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a9f3e3f759e2b67c771a41f1c276984b2">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#ac01ff858bf67e2e93ad5d24a6ba8c8c8">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#ae910d1b9250b11097fd6b51cd8285b68">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a63d63f2cb7ea8d8b09d58cc13b541375">PercussionOnsetDetector</a>.</p>
cannam@50 310
cannam@50 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>
cannam@0 312
cannam@0 313 </div>
cannam@50 314 </div>
cannam@50 315 <a class="anchor" id="ab7e9dedbe965f5ab9018b72920fe7661"></a><!-- doxytag: member="Vamp::PluginBase::getCopyright" ref="ab7e9dedbe965f5ab9018b72920fe7661" args="() const =0" -->
cannam@0 316 <div class="memitem">
cannam@0 317 <div class="memproto">
cannam@0 318 <table class="memname">
cannam@0 319 <tr>
cannam@50 320 <td class="memname">virtual std::string Vamp::PluginBase::getCopyright </td>
cannam@0 321 <td>(</td>
cannam@50 322 <td class="paramname"></td><td>)</td>
cannam@21 323 <td> const<code> [pure virtual]</code></td>
cannam@0 324 </tr>
cannam@0 325 </table>
cannam@0 326 </div>
cannam@0 327 <div class="memdoc">
cannam@0 328
cannam@50 329 <p>Get the copyright statement or licensing summary for the plugin. </p>
cannam@50 330 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
cannam@0 331
cannam@50 332 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ac73c9d6baad04369beee695e99584815">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a708b4d335c57643d5ef2b2e1caf43bd9">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a925747d513d598e0fa21ed0ed6520980">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a50c6b64530c84c0707ba3936c5022a48">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a1a22ece271330c94cc08798a77416351">PercussionOnsetDetector</a>.</p>
cannam@50 333
cannam@50 334 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 335
cannam@0 336 </div>
cannam@50 337 </div>
cannam@50 338 <a class="anchor" id="a63f686d77bc3d6b807e7944cdde83151"></a><!-- doxytag: member="Vamp::PluginBase::getPluginVersion" ref="a63f686d77bc3d6b807e7944cdde83151" args="() const =0" -->
cannam@0 339 <div class="memitem">
cannam@0 340 <div class="memproto">
cannam@0 341 <table class="memname">
cannam@0 342 <tr>
cannam@50 343 <td class="memname">virtual int Vamp::PluginBase::getPluginVersion </td>
cannam@0 344 <td>(</td>
cannam@50 345 <td class="paramname"></td><td>)</td>
cannam@21 346 <td> const<code> [pure virtual]</code></td>
cannam@0 347 </tr>
cannam@0 348 </table>
cannam@0 349 </div>
cannam@0 350 <div class="memdoc">
cannam@0 351
cannam@50 352 <p>Get the version number of the plugin. </p>
cannam@0 353
cannam@50 354 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a6fbd94781867ca46a20368c2a3593c77">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#ad23d27e4e82f10404a37b933f6a72c33">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#af64622e66bf678ac2b0b58aa832ca2b3">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#ad002fddb3735c2dd7e31e6a9def9949f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ad6b818dbd81867ce7be71c99cae861be">PercussionOnsetDetector</a>.</p>
cannam@0 355
cannam@50 356 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 357
cannam@0 358 </div>
cannam@50 359 </div>
cannam@50 360 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a><!-- doxytag: member="Vamp::PluginBase::getParameterDescriptors" ref="aac3e49b3b66cacfbb768dfdf07444f21" args="() const " -->
cannam@0 361 <div class="memitem">
cannam@0 362 <div class="memproto">
cannam@0 363 <table class="memname">
cannam@0 364 <tr>
cannam@50 365 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
cannam@0 366 <td>(</td>
cannam@50 367 <td class="paramname"></td><td>)</td>
cannam@21 368 <td> const<code> [inline, virtual]</code></td>
cannam@0 369 </tr>
cannam@0 370 </table>
cannam@0 371 </div>
cannam@0 372 <div class="memdoc">
cannam@0 373
cannam@50 374 <p>Get the controllable parameters of this plugin. </p>
cannam@0 375
cannam@50 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>
cannam@0 377
cannam@50 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>
cannam@0 379
cannam@50 380 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p>
cannam@0 381
cannam@0 382 </div>
cannam@50 383 </div>
cannam@50 384 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a><!-- doxytag: member="Vamp::PluginBase::getParameter" ref="a97ababcd45348ceec998d0f8e0f38bf7" args="(std::string) const " -->
cannam@0 385 <div class="memitem">
cannam@0 386 <div class="memproto">
cannam@0 387 <table class="memname">
cannam@0 388 <tr>
cannam@50 389 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
cannam@0 390 <td>(</td>
cannam@50 391 <td class="paramtype">std::string&#160;</td>
cannam@50 392 <td class="paramname"></td><td>)</td>
cannam@21 393 <td> const<code> [inline, virtual]</code></td>
cannam@0 394 </tr>
cannam@0 395 </table>
cannam@0 396 </div>
cannam@0 397 <div class="memdoc">
cannam@0 398
cannam@50 399 <p>Get the value of a named parameter. </p>
cannam@50 400 <p>The argument is the identifier field from that parameter's descriptor. </p>
cannam@0 401
cannam@50 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>
cannam@50 403
cannam@50 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>
cannam@0 405
cannam@0 406 </div>
cannam@50 407 </div>
cannam@50 408 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a><!-- doxytag: member="Vamp::PluginBase::setParameter" ref="a6c718ce822f7b73b98940d59dcaa9366" args="(std::string, float)" -->
cannam@0 409 <div class="memitem">
cannam@0 410 <div class="memproto">
cannam@0 411 <table class="memname">
cannam@0 412 <tr>
cannam@50 413 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
cannam@0 414 <td>(</td>
cannam@50 415 <td class="paramtype">std::string&#160;</td>
cannam@0 416 <td class="paramname">, </td>
cannam@0 417 </tr>
cannam@0 418 <tr>
cannam@0 419 <td class="paramkey"></td>
cannam@0 420 <td></td>
cannam@50 421 <td class="paramtype">float&#160;</td>
cannam@50 422 <td class="paramname">&#160;</td>
cannam@0 423 </tr>
cannam@0 424 <tr>
cannam@0 425 <td></td>
cannam@0 426 <td>)</td>
cannam@50 427 <td></td><td><code> [inline, virtual]</code></td>
cannam@0 428 </tr>
cannam@0 429 </table>
cannam@0 430 </div>
cannam@0 431 <div class="memdoc">
cannam@0 432
cannam@50 433 <p>Set a named parameter. </p>
cannam@50 434 <p>The first argument is the identifier field from that parameter's descriptor. </p>
cannam@0 435
cannam@50 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>
cannam@50 437
cannam@50 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>
cannam@0 439
cannam@0 440 </div>
cannam@50 441 </div>
cannam@50 442 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a><!-- doxytag: member="Vamp::PluginBase::getPrograms" ref="abb307c60bdb981d5f5af50c3c4ae84af" args="() const " -->
cannam@0 443 <div class="memitem">
cannam@0 444 <div class="memproto">
cannam@0 445 <table class="memname">
cannam@0 446 <tr>
cannam@50 447 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
cannam@0 448 <td>(</td>
cannam@50 449 <td class="paramname"></td><td>)</td>
cannam@21 450 <td> const<code> [inline, virtual]</code></td>
cannam@0 451 </tr>
cannam@0 452 </table>
cannam@0 453 </div>
cannam@0 454 <div class="memdoc">
cannam@0 455
cannam@50 456 <p>Get the program settings available in this plugin. </p>
cannam@50 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>
cannam@50 458 <p>The programs must have unique names. </p>
cannam@0 459
cannam@50 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>
cannam@50 461
cannam@50 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>
cannam@0 463
cannam@0 464 </div>
cannam@50 465 </div>
cannam@50 466 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a><!-- doxytag: member="Vamp::PluginBase::getCurrentProgram" ref="a24e77eccf1bdfbbca3c79bb25e8799b3" args="() const " -->
cannam@0 467 <div class="memitem">
cannam@0 468 <div class="memproto">
cannam@0 469 <table class="memname">
cannam@0 470 <tr>
cannam@50 471 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
cannam@0 472 <td>(</td>
cannam@50 473 <td class="paramname"></td><td>)</td>
cannam@21 474 <td> const<code> [inline, virtual]</code></td>
cannam@0 475 </tr>
cannam@0 476 </table>
cannam@0 477 </div>
cannam@0 478 <div class="memdoc">
cannam@0 479
cannam@50 480 <p>Get the current program. </p>
cannam@0 481
cannam@50 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>
cannam@0 483
cannam@50 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>
cannam@0 485
cannam@0 486 </div>
cannam@50 487 </div>
cannam@50 488 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a><!-- doxytag: member="Vamp::PluginBase::selectProgram" ref="aadd3a547ef140bae200473a9518e3353" args="(std::string)" -->
cannam@0 489 <div class="memitem">
cannam@0 490 <div class="memproto">
cannam@0 491 <table class="memname">
cannam@0 492 <tr>
cannam@50 493 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
cannam@0 494 <td>(</td>
cannam@50 495 <td class="paramtype">std::string&#160;</td>
cannam@50 496 <td class="paramname"></td><td>)</td>
cannam@21 497 <td><code> [inline, virtual]</code></td>
cannam@0 498 </tr>
cannam@0 499 </table>
cannam@0 500 </div>
cannam@0 501 <div class="memdoc">
cannam@0 502
cannam@50 503 <p>Select a program. </p>
cannam@50 504 <p>(If the given program name is not one of the available programs, do nothing.) </p>
cannam@0 505
cannam@50 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>
cannam@50 507
cannam@50 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>
cannam@0 509
cannam@0 510 </div>
cannam@50 511 </div>
cannam@50 512 <a class="anchor" id="a2da03e9ced8dc7e4382205e6dc05dbff"></a><!-- doxytag: member="Vamp::PluginBase::getType" ref="a2da03e9ced8dc7e4382205e6dc05dbff" args="() const =0" -->
cannam@0 513 <div class="memitem">
cannam@0 514 <div class="memproto">
cannam@0 515 <table class="memname">
cannam@0 516 <tr>
cannam@50 517 <td class="memname">virtual std::string Vamp::PluginBase::getType </td>
cannam@0 518 <td>(</td>
cannam@50 519 <td class="paramname"></td><td>)</td>
cannam@21 520 <td> const<code> [pure virtual]</code></td>
cannam@0 521 </tr>
cannam@0 522 </table>
cannam@0 523 </div>
cannam@0 524 <div class="memdoc">
cannam@0 525
cannam@50 526 <p>Get the type of plugin. </p>
cannam@50 527 <p>This is to be implemented by the immediate subclass, not by actual plugins. Do not attempt to implement this in plugin code. </p>
cannam@50 528
cannam@50 529 <p>Implemented in <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin</a>.</p>
cannam@0 530
cannam@0 531 </div>
cannam@0 532 </div>
cannam@50 533 <hr/>The documentation for this class was generated from the following file:<ul>
cannam@50 534 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
cannam@50 535 </ul>
cannam@50 536 </div>
cannam@50 537 </div>
cannam@50 538 <div id="nav-path" class="navpath">
cannam@50 539 <ul>
cannam@50 540 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
cannam@50 541 <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li>
cannam@50 542
cannam@50 543 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
cannam@50 544 <a href="http://www.doxygen.org/index.html">
cannam@50 545 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
cannam@50 546 </ul>
cannam@50 547 </div>
cannam@50 548
cannam@50 549
cannam@0 550 </body>
cannam@0 551 </html>