Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginWrapper.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::HostExt::PluginWrapper Class Reference</title> 3 <title>VampPluginSDK: Vamp::HostExt::PluginWrapper Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
29 <h1>Vamp::HostExt::PluginWrapper Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginWrapper" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PluginWrapper_8h-source.html">vamp-sdk/hostext/PluginWrapper.h</a>&gt;</code> 29 <h1>Vamp::HostExt::PluginWrapper Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginWrapper" --><!-- doxytag: inherits="Vamp::Plugin" --><code>#include &lt;<a class="el" href="PluginWrapper_8h-source.html">vamp-hostsdk/PluginWrapper.h</a>&gt;</code>
30 <p> 30 <p>
31 <div class="dynheader"> 31 <div class="dynheader">
32 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div> 32 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div>
33 <div class="dynsection"> 33 <div class="dynsection">
34 <p><center><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper__inherit__map" alt="Inheritance graph"></center> 34 <p><center><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper__inherit__map" alt="Inheritance graph"></center>
35 <map name="Vamp_1_1HostExt_1_1PluginWrapper__inherit__map"> 35 <map name="Vamp_1_1HostExt_1_1PluginWrapper__inherit__map">
36 <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="652,6,903,30"><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="655,54,900,78"><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="641,102,913,126"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginLoader_1_1Impl_1_1PluginDeletionNotifyAdapter.html" title="Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter" alt="" coords="580,150,975,174"><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="181,78,280,102"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,78,133,102"></map> 36 <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="592,5,840,32"><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="593,56,839,82"><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="580,106,852,133"><area shape="rect" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods..." alt="" coords="579,157,853,184"><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="181,81,280,108"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="5,81,133,108"></map>
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> 37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
38 38
39 <p> 39 <p>
40 <a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 40 <a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
41 <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins. 41 <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins.
42 <p> 42 <p>
43 It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin on construction, and provides implementations of all the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.<p> 43 It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html">Vamp</a> plugin on construction, and provides implementations of all the <a class="el" href="namespaceVamp.html">Vamp</a> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.<p>
44 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin SDK. </dd></dl> 44 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
45 45
46 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00059">59</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p> 46 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
47 <table border="0" cellpadding="0" cellspacing="0"> 47 <table border="0" cellpadding="0" cellspacing="0">
48 <tr><td></td></tr> 48 <tr><td></td></tr>
49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> 49 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, 50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 51 <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
63 &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> 63 &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>
64 64
65 <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> 65 <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>
66 66
67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 67 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
68 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7449a364d524de75352a4719fec2e1f5">~PluginWrapper</a> ()</td></tr> 68 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c4fb6cfd7c0d3b2c8576a4e9dc61f518">~PluginWrapper</a> ()</td></tr>
69 69
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 70 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
71 71
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a5a1f8290d8e9a315695584dcb3ad137"></a><br></td></tr> 72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#a5a1f8290d8e9a315695584dcb3ad137"></a><br></td></tr>
73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr> 73 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
74 74
75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr> 75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#d19cc0614ba41cdc26ef3394c5146fe6"></a><br></td></tr>
76 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#031aa818fd48fd0f4b5e1bf80c032870">getInputDomain</a> () const </td></tr> 76 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr>
77 77
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#031aa818fd48fd0f4b5e1bf80c032870"></a><br></td></tr> 78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr>
79 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr> 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr>
80 80
81 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr> 81 <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="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr>
82 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> 82 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr>
83 83
84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr> 84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr>
85 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> 85 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr>
86 86
95 95
96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr> 96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr>
97 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr> 97 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr>
98 98
99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr> 99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr>
100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#3b075b8f950b344503f0d27ac0fe332e">getParameterDescriptors</a> () const </td></tr> 100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr>
101 101
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#3b075b8f950b344503f0d27ac0fe332e"></a><br></td></tr> 102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr>
103 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr> 103 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr>
104 104
105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr> 105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr>
106 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr> 106 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
107 107
108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr> 108 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr>
109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#f3abaf717dc4b00cad5770ed6dfa01e1">getPrograms</a> () const </td></tr> 109 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr>
110 110
111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#f3abaf717dc4b00cad5770ed6dfa01e1"></a><br></td></tr> 111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr>
112 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr> 112 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr>
113 113
114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr> 114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr>
115 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr> 115 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
116 116
117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr> 117 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr>
118 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr> 118 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr>
119 119
120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr> 120 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr>
121 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr> 121 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr>
122 122
123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr> 123 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr>
124 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr> 124 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr>
125 125
126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr> 126 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
127 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr> 127 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
128 128
129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr> 129 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#02c8c01972affeea58b091335e791ace">getOutputDescriptors</a> () const </td></tr> 130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
131 131
132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#02c8c01972affeea58b091335e791ace"></a><br></td></tr> 132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
134 134
135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#fca78043c2843c1d45019983515e23f7"></a><br></td></tr> 135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#6bd72d6dfb3047524dbe8ae3294527cf"></a><br></td></tr>
136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#1dce55a75a32b08fc56a52a300d9fcbe">getRemainingFeatures</a> ()</td></tr> 136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
137 137
138 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#1dce55a75a32b08fc56a52a300d9fcbe"></a><br></td></tr> 138 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#2bc8c0992e64f06991fb7cf89f99857e"></a><br></td></tr>
139 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType&gt; </td></tr>
140 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr>
141
142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr>
139 <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_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> 143 <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_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
140 144
141 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr> 145 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
142 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 146 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
143 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 147 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
160 </div> 164 </div>
161 <div class="memdoc"> 165 <div class="memdoc">
162 166
163 <p> 167 <p>
164 168
165 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00309">309</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 169 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
166 170
167 </div> 171 </div>
168 </div><p> 172 </div><p>
169 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> 173 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" -->
170 <div class="memitem"> 174 <div class="memitem">
177 </div> 181 </div>
178 <div class="memdoc"> 182 <div class="memdoc">
179 183
180 <p> 184 <p>
181 185
182 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 186 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00380">380</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
183 187
184 </div> 188 </div>
185 </div><p> 189 </div><p>
186 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> 190 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" -->
187 <div class="memitem"> 191 <div class="memitem">
194 </div> 198 </div>
195 <div class="memdoc"> 199 <div class="memdoc">
196 200
197 <p> 201 <p>
198 202
199 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00348">348</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 203 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
200 204
201 </div> 205 </div>
202 </div><p> 206 </div><p>
203 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> 207 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
204 <div class="memitem"> 208 <div class="memitem">
211 </div> 215 </div>
212 <div class="memdoc"> 216 <div class="memdoc">
213 217
214 <p> 218 <p>
215 219
216 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00195">195</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> 220 <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>
217 221
218 </div> 222 </div>
219 </div><p> 223 </div><p>
220 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> 224 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" -->
221 <div class="memitem"> 225 <div class="memitem">
228 </div> 232 </div>
229 <div class="memdoc"> 233 <div class="memdoc">
230 234
231 <p> 235 <p>
232 236
233 <p>Definition at line <a class="el" href="PluginBase_8h-source.html#l00217">217</a> of file <a class="el" href="PluginBase_8h-source.html">PluginBase.h</a>.</p> 237 <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>
234 238
235 </div> 239 </div>
236 </div><p> 240 </div><p>
237 <hr><h2>Member Enumeration Documentation</h2> 241 <hr><h2>Member Enumeration Documentation</h2>
238 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> 242 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
254 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td> 258 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
255 </td></tr> 259 </td></tr>
256 </table> 260 </table>
257 </dl> 261 </dl>
258 262
259 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00149">149</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 263 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
260 264
261 </div> 265 </div>
262 </div><p> 266 </div><p>
263 <hr><h2>Constructor &amp; Destructor Documentation</h2> 267 <hr><h2>Constructor &amp; Destructor Documentation</h2>
264 <a class="anchor" name="7449a364d524de75352a4719fec2e1f5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::~PluginWrapper" ref="7449a364d524de75352a4719fec2e1f5" args="()" --> 268 <a class="anchor" name="c4fb6cfd7c0d3b2c8576a4e9dc61f518"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::~PluginWrapper" ref="c4fb6cfd7c0d3b2c8576a4e9dc61f518" args="()" -->
265 <div class="memitem"> 269 <div class="memitem">
266 <div class="memproto"> 270 <div class="memproto">
267 <table class="memname"> 271 <table class="memname">
268 <tr> 272 <tr>
269 <td class="memname">Vamp::HostExt::PluginWrapper::~PluginWrapper </td> 273 <td class="memname">virtual Vamp::HostExt::PluginWrapper::~PluginWrapper </td>
270 <td>(</td> 274 <td>(</td>
271 <td class="paramname"> </td> 275 <td class="paramname"> </td>
272 <td>&nbsp;)&nbsp;</td> 276 <td>&nbsp;)&nbsp;</td>
273 <td width="100%"><code> [virtual]</code></td> 277 <td><code> [virtual]</code></td>
274 </tr> 278 </tr>
275 </table> 279 </table>
276 </div> 280 </div>
277 <div class="memdoc"> 281 <div class="memdoc">
278 282
279 <p> 283 <p>
280
281 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00056">56</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
282
283 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
284 284
285 </div> 285 </div>
286 </div><p> 286 </div><p>
287 <a class="anchor" name="35cc2d42f8322f5022e89859a79c97be"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::PluginWrapper" ref="35cc2d42f8322f5022e89859a79c97be" args="(Plugin *plugin)" --> 287 <a class="anchor" name="35cc2d42f8322f5022e89859a79c97be"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::PluginWrapper" ref="35cc2d42f8322f5022e89859a79c97be" args="(Plugin *plugin)" -->
288 <div class="memitem"> 288 <div class="memitem">
292 <td class="memname">Vamp::HostExt::PluginWrapper::PluginWrapper </td> 292 <td class="memname">Vamp::HostExt::PluginWrapper::PluginWrapper </td>
293 <td>(</td> 293 <td>(</td>
294 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td> 294 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td>
295 <td class="paramname"> <em>plugin</em> </td> 295 <td class="paramname"> <em>plugin</em> </td>
296 <td>&nbsp;)&nbsp;</td> 296 <td>&nbsp;)&nbsp;</td>
297 <td width="100%"><code> [protected]</code></td> 297 <td><code> [protected]</code></td>
298 </tr> 298 </tr>
299 </table> 299 </table>
300 </div> 300 </div>
301 <div class="memdoc"> 301 <div class="memdoc">
302 302
303 <p> 303 <p>
304
305 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00050">50</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
306 304
307 </div> 305 </div>
308 </div><p> 306 </div><p>
309 <hr><h2>Member Function Documentation</h2> 307 <hr><h2>Member Function Documentation</h2>
310 <a class="anchor" name="a5a1f8290d8e9a315695584dcb3ad137"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::initialise" ref="a5a1f8290d8e9a315695584dcb3ad137" args="(size_t channels, size_t stepSize, size_t blockSize)" --> 308 <a class="anchor" name="a5a1f8290d8e9a315695584dcb3ad137"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::initialise" ref="a5a1f8290d8e9a315695584dcb3ad137" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
330 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td> 328 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td>
331 </tr> 329 </tr>
332 <tr> 330 <tr>
333 <td></td> 331 <td></td>
334 <td>)</td> 332 <td>)</td>
335 <td></td><td></td><td width="100%"><code> [virtual]</code></td> 333 <td></td><td></td><td><code> [virtual]</code></td>
336 </tr> 334 </tr>
337 </table> 335 </table>
338 </div> 336 </div>
339 <div class="memdoc"> 337 <div class="memdoc">
340 338
343 <p> 341 <p>
344 The input sample rate should have been already specified at construction time.<p> 342 The input sample rate should have been already specified at construction time.<p>
345 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. 343 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported.
346 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> 344 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
347 345
348 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 346 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#de0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#1e994576d43efe103bf8f83b69716745">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
349
350 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
351
352 <p>References <a class="el" href="classVamp_1_1Plugin.html#f26212cf5fc511b603a8b48034247822">Vamp::Plugin::initialise()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
353 347
354 </div> 348 </div>
355 </div><p> 349 </div><p>
356 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" --> 350 <a class="anchor" name="d19cc0614ba41cdc26ef3394c5146fe6"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::reset" ref="d19cc0614ba41cdc26ef3394c5146fe6" args="()" -->
357 <div class="memitem"> 351 <div class="memitem">
360 <tr> 354 <tr>
361 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td> 355 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
362 <td>(</td> 356 <td>(</td>
363 <td class="paramname"> </td> 357 <td class="paramname"> </td>
364 <td>&nbsp;)&nbsp;</td> 358 <td>&nbsp;)&nbsp;</td>
365 <td width="100%"><code> [virtual]</code></td> 359 <td><code> [virtual]</code></td>
366 </tr> 360 </tr>
367 </table> 361 </table>
368 </div> 362 </div>
369 <div class="memdoc"> 363 <div class="memdoc">
370 364
374 Not called for the first initialisation (i.e. initialise must also do a reset). 368 Not called for the first initialisation (i.e. initialise must also do a reset).
375 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> 369 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
376 370
377 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 371 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
378 372
379 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00068">68</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 373 </div>
380 374 </div><p>
381 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#ad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin::reset()</a>.</p> 375 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " -->
382 376 <div class="memitem">
383 </div> 377 <div class="memproto">
384 </div><p> 378 <table class="memname">
385 <a class="anchor" name="031aa818fd48fd0f4b5e1bf80c032870"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getInputDomain" ref="031aa818fd48fd0f4b5e1bf80c032870" args="() const " --> 379 <tr>
386 <div class="memitem"> 380 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
387 <div class="memproto"> 381 <td>(</td>
388 <table class="memname"> 382 <td class="paramname"> </td>
389 <tr> 383 <td>&nbsp;)&nbsp;</td>
390 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Plugin::InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td> 384 <td> const<code> [virtual]</code></td>
391 <td>(</td>
392 <td class="paramname"> </td>
393 <td>&nbsp;)&nbsp;</td>
394 <td width="100%"> const<code> [virtual]</code></td>
395 </tr> 385 </tr>
396 </table> 386 </table>
397 </div> 387 </div>
398 <div class="memdoc"> 388 <div class="memdoc">
399 389
400 <p> 390 <p>
401 Get the plugin's required input domain. 391 Get the plugin's required input domain.
402 <p> 392 <p>
403 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. 393 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin. If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window.
404 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 394 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
405 395
406 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#376fa97a1c721255541fe35d71368976">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 396 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
407
408 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00074">74</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
409
410 <p>References <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin::getInputDomain()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
411 397
412 </div> 398 </div>
413 </div><p> 399 </div><p>
414 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> 400 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
415 <div class="memitem"> 401 <div class="memitem">
418 <tr> 404 <tr>
419 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td> 405 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
420 <td>(</td> 406 <td>(</td>
421 <td class="paramname"> </td> 407 <td class="paramname"> </td>
422 <td>&nbsp;)&nbsp;</td> 408 <td>&nbsp;)&nbsp;</td>
423 <td width="100%"> const<code> [virtual]</code></td> 409 <td> const<code> [virtual]</code></td>
424 </tr> 410 </tr>
425 </table> 411 </table>
426 </div> 412 </div>
427 <div class="memdoc"> 413 <div class="memdoc">
428 414
429 <p> 415 <p>
430 Get the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> API compatibility level of the plugin. 416 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin.
431 <p> 417 <p>
432 418
433 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 419 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
434 420
435 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00080">80</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
436
437 <p>References <a class="el" href="PluginBase_8h-source.html#l00067">Vamp::PluginBase::getVampApiVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
438
439 </div> 421 </div>
440 </div><p> 422 </div><p>
441 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " --> 423 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
442 <div class="memitem"> 424 <div class="memitem">
443 <div class="memproto"> 425 <div class="memproto">
445 <tr> 427 <tr>
446 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td> 428 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
447 <td>(</td> 429 <td>(</td>
448 <td class="paramname"> </td> 430 <td class="paramname"> </td>
449 <td>&nbsp;)&nbsp;</td> 431 <td>&nbsp;)&nbsp;</td>
450 <td width="100%"> const<code> [virtual]</code></td> 432 <td> const<code> [virtual]</code></td>
451 </tr> 433 </tr>
452 </table> 434 </table>
453 </div> 435 </div>
454 <div class="memdoc"> 436 <div class="memdoc">
455 437
459 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> 441 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>
460 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> 442 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>
461 Example: "zero_crossings" 443 Example: "zero_crossings"
462 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 444 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
463 445
464 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00086">86</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
465
466 <p>References <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase::getIdentifier()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
467
468 </div> 446 </div>
469 </div><p> 447 </div><p>
470 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " --> 448 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
471 <div class="memitem"> 449 <div class="memitem">
472 <div class="memproto"> 450 <div class="memproto">
474 <tr> 452 <tr>
475 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td> 453 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
476 <td>(</td> 454 <td>(</td>
477 <td class="paramname"> </td> 455 <td class="paramname"> </td>
478 <td>&nbsp;)&nbsp;</td> 456 <td>&nbsp;)&nbsp;</td>
479 <td width="100%"> const<code> [virtual]</code></td> 457 <td> const<code> [virtual]</code></td>
480 </tr> 458 </tr>
481 </table> 459 </table>
482 </div> 460 </div>
483 <div class="memdoc"> 461 <div class="memdoc">
484 462
487 <p> 465 <p>
488 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> 466 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>
489 Example: "Zero Crossings" 467 Example: "Zero Crossings"
490 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 468 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
491 469
492 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00092">92</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
493
494 <p>References <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase::getName()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
495
496 </div> 470 </div>
497 </div><p> 471 </div><p>
498 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " --> 472 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " -->
499 <div class="memitem"> 473 <div class="memitem">
500 <div class="memproto"> 474 <div class="memproto">
502 <tr> 476 <tr>
503 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td> 477 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
504 <td>(</td> 478 <td>(</td>
505 <td class="paramname"> </td> 479 <td class="paramname"> </td>
506 <td>&nbsp;)&nbsp;</td> 480 <td>&nbsp;)&nbsp;</td>
507 <td width="100%"> const<code> [virtual]</code></td> 481 <td> const<code> [virtual]</code></td>
508 </tr> 482 </tr>
509 </table> 483 </table>
510 </div> 484 </div>
511 <div class="memdoc"> 485 <div class="memdoc">
512 486
515 <p> 489 <p>
516 May be empty if the name has said it all already.<p> 490 May be empty if the name has said it all already.<p>
517 Example: "Detect and count zero crossing points" 491 Example: "Detect and count zero crossing points"
518 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 492 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
519 493
520 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00098">98</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
521
522 <p>References <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase::getDescription()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
523
524 </div> 494 </div>
525 </div><p> 495 </div><p>
526 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " --> 496 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " -->
527 <div class="memitem"> 497 <div class="memitem">
528 <div class="memproto"> 498 <div class="memproto">
530 <tr> 500 <tr>
531 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td> 501 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
532 <td>(</td> 502 <td>(</td>
533 <td class="paramname"> </td> 503 <td class="paramname"> </td>
534 <td>&nbsp;)&nbsp;</td> 504 <td>&nbsp;)&nbsp;</td>
535 <td width="100%"> const<code> [virtual]</code></td> 505 <td> const<code> [virtual]</code></td>
536 </tr> 506 </tr>
537 </table> 507 </table>
538 </div> 508 </div>
539 <div class="memdoc"> 509 <div class="memdoc">
540 510
542 Get the name of the author or vendor of the plugin in human-readable form. 512 Get the name of the author or vendor of the plugin in human-readable form.
543 <p> 513 <p>
544 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. 514 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar.
545 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 515 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
546 516
547 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00104">104</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
548
549 <p>References <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase::getMaker()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
550
551 </div> 517 </div>
552 </div><p> 518 </div><p>
553 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " --> 519 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " -->
554 <div class="memitem"> 520 <div class="memitem">
555 <div class="memproto"> 521 <div class="memproto">
557 <tr> 523 <tr>
558 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td> 524 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
559 <td>(</td> 525 <td>(</td>
560 <td class="paramname"> </td> 526 <td class="paramname"> </td>
561 <td>&nbsp;)&nbsp;</td> 527 <td>&nbsp;)&nbsp;</td>
562 <td width="100%"> const<code> [virtual]</code></td> 528 <td> const<code> [virtual]</code></td>
563 </tr> 529 </tr>
564 </table> 530 </table>
565 </div> 531 </div>
566 <div class="memdoc"> 532 <div class="memdoc">
567 533
569 Get the version number of the plugin. 535 Get the version number of the plugin.
570 <p> 536 <p>
571 537
572 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 538 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
573 539
574 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00110">110</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
575
576 <p>References <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase::getPluginVersion()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
577
578 </div> 540 </div>
579 </div><p> 541 </div><p>
580 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " --> 542 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
581 <div class="memitem"> 543 <div class="memitem">
582 <div class="memproto"> 544 <div class="memproto">
584 <tr> 546 <tr>
585 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td> 547 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
586 <td>(</td> 548 <td>(</td>
587 <td class="paramname"> </td> 549 <td class="paramname"> </td>
588 <td>&nbsp;)&nbsp;</td> 550 <td>&nbsp;)&nbsp;</td>
589 <td width="100%"> const<code> [virtual]</code></td> 551 <td> const<code> [virtual]</code></td>
590 </tr> 552 </tr>
591 </table> 553 </table>
592 </div> 554 </div>
593 <div class="memdoc"> 555 <div class="memdoc">
594 556
596 Get the copyright statement or licensing summary for the plugin. 558 Get the copyright statement or licensing summary for the plugin.
597 <p> 559 <p>
598 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. 560 This can be an informative text, without the same presentation constraints as mentioned for getMaker above.
599 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 561 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
600 562
601 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 563 </div>
602 564 </div><p>
603 <p>References <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase::getCopyright()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p> 565 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
604 566 <div class="memitem">
605 </div> 567 <div class="memproto">
606 </div><p> 568 <table class="memname">
607 <a class="anchor" name="3b075b8f950b344503f0d27ac0fe332e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameterDescriptors" ref="3b075b8f950b344503f0d27ac0fe332e" args="() const " --> 569 <tr>
608 <div class="memitem"> 570 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
609 <div class="memproto"> 571 <td>(</td>
610 <table class="memname"> 572 <td class="paramname"> </td>
611 <tr> 573 <td>&nbsp;)&nbsp;</td>
612 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">PluginBase::ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td> 574 <td> const<code> [virtual]</code></td>
613 <td>(</td>
614 <td class="paramname"> </td>
615 <td>&nbsp;)&nbsp;</td>
616 <td width="100%"> const<code> [virtual]</code></td>
617 </tr> 575 </tr>
618 </table> 576 </table>
619 </div> 577 </div>
620 <div class="memdoc"> 578 <div class="memdoc">
621 579
623 Get the controllable parameters of this plugin. 581 Get the controllable parameters of this plugin.
624 <p> 582 <p>
625 583
626 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 584 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
627 585
628 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00122">122</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
629
630 <p>References <a class="el" href="PluginBase_8h-source.html#l00200">Vamp::PluginBase::getParameterDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
631
632 </div> 586 </div>
633 </div><p> 587 </div><p>
634 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " --> 588 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
635 <div class="memitem"> 589 <div class="memitem">
636 <div class="memproto"> 590 <div class="memproto">
639 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td> 593 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
640 <td>(</td> 594 <td>(</td>
641 <td class="paramtype">std::string&nbsp;</td> 595 <td class="paramtype">std::string&nbsp;</td>
642 <td class="paramname"> </td> 596 <td class="paramname"> </td>
643 <td>&nbsp;)&nbsp;</td> 597 <td>&nbsp;)&nbsp;</td>
644 <td width="100%"> const<code> [virtual]</code></td> 598 <td> const<code> [virtual]</code></td>
645 </tr> 599 </tr>
646 </table> 600 </table>
647 </div> 601 </div>
648 <div class="memdoc"> 602 <div class="memdoc">
649 603
650 <p> 604 <p>
651 Get the value of a named parameter. 605 Get the value of a named parameter.
652 <p> 606 <p>
653 The argument is the identifier field from that parameter's descriptor. 607 The argument is the identifier field from that parameter's descriptor.
654 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 608 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
655
656 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00128">128</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
657
658 <p>References <a class="el" href="PluginBase_8h-source.html#l00208">Vamp::PluginBase::getParameter()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
659 609
660 </div> 610 </div>
661 </div><p> 611 </div><p>
662 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" --> 612 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
663 <div class="memitem"> 613 <div class="memitem">
676 <td class="paramname"></td><td>&nbsp;</td> 626 <td class="paramname"></td><td>&nbsp;</td>
677 </tr> 627 </tr>
678 <tr> 628 <tr>
679 <td></td> 629 <td></td>
680 <td>)</td> 630 <td>)</td>
681 <td></td><td></td><td width="100%"><code> [virtual]</code></td> 631 <td></td><td></td><td><code> [virtual]</code></td>
682 </tr> 632 </tr>
683 </table> 633 </table>
684 </div> 634 </div>
685 <div class="memdoc"> 635 <div class="memdoc">
686 636
688 Set a named parameter. 638 Set a named parameter.
689 <p> 639 <p>
690 The first argument is the identifier field from that parameter's descriptor. 640 The first argument is the identifier field from that parameter's descriptor.
691 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 641 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
692 642
693 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00134">134</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 643 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
694 644
695 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00214">Vamp::PluginBase::setParameter()</a>.</p> 645 </div>
696 646 </div><p>
697 </div> 647 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " -->
698 </div><p> 648 <div class="memitem">
699 <a class="anchor" name="f3abaf717dc4b00cad5770ed6dfa01e1"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPrograms" ref="f3abaf717dc4b00cad5770ed6dfa01e1" args="() const " --> 649 <div class="memproto">
700 <div class="memitem"> 650 <table class="memname">
701 <div class="memproto"> 651 <tr>
702 <table class="memname"> 652 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
703 <tr> 653 <td>(</td>
704 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">PluginBase::ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td> 654 <td class="paramname"> </td>
705 <td>(</td> 655 <td>&nbsp;)&nbsp;</td>
706 <td class="paramname"> </td> 656 <td> const<code> [virtual]</code></td>
707 <td>&nbsp;)&nbsp;</td>
708 <td width="100%"> const<code> [virtual]</code></td>
709 </tr> 657 </tr>
710 </table> 658 </table>
711 </div> 659 </div>
712 <div class="memdoc"> 660 <div class="memdoc">
713 661
716 <p> 664 <p>
717 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> 665 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>
718 The programs must have unique names. 666 The programs must have unique names.
719 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 667 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
720 668
721 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00140">140</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
722
723 <p>References <a class="el" href="PluginBase_8h-source.html#l00229">Vamp::PluginBase::getPrograms()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
724
725 </div> 669 </div>
726 </div><p> 670 </div><p>
727 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " --> 671 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " -->
728 <div class="memitem"> 672 <div class="memitem">
729 <div class="memproto"> 673 <div class="memproto">
731 <tr> 675 <tr>
732 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td> 676 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
733 <td>(</td> 677 <td>(</td>
734 <td class="paramname"> </td> 678 <td class="paramname"> </td>
735 <td>&nbsp;)&nbsp;</td> 679 <td>&nbsp;)&nbsp;</td>
736 <td width="100%"> const<code> [virtual]</code></td> 680 <td> const<code> [virtual]</code></td>
737 </tr> 681 </tr>
738 </table> 682 </table>
739 </div> 683 </div>
740 <div class="memdoc"> 684 <div class="memdoc">
741 685
743 Get the current program. 687 Get the current program.
744 <p> 688 <p>
745 689
746 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 690 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
747 691
748 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00146">146</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
749
750 <p>References <a class="el" href="PluginBase_8h-source.html#l00234">Vamp::PluginBase::getCurrentProgram()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
751
752 </div> 692 </div>
753 </div><p> 693 </div><p>
754 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" --> 694 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
755 <div class="memitem"> 695 <div class="memitem">
756 <div class="memproto"> 696 <div class="memproto">
759 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td> 699 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
760 <td>(</td> 700 <td>(</td>
761 <td class="paramtype">std::string&nbsp;</td> 701 <td class="paramtype">std::string&nbsp;</td>
762 <td class="paramname"> </td> 702 <td class="paramname"> </td>
763 <td>&nbsp;)&nbsp;</td> 703 <td>&nbsp;)&nbsp;</td>
764 <td width="100%"><code> [virtual]</code></td> 704 <td><code> [virtual]</code></td>
765 </tr> 705 </tr>
766 </table> 706 </table>
767 </div> 707 </div>
768 <div class="memdoc"> 708 <div class="memdoc">
769 709
771 Select a program. 711 Select a program.
772 <p> 712 <p>
773 (If the given program name is not one of the available programs, do nothing.) 713 (If the given program name is not one of the available programs, do nothing.)
774 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 714 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
775 715
776 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00152">152</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 716 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
777
778 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="PluginBase_8h-source.html#l00240">Vamp::PluginBase::selectProgram()</a>.</p>
779 717
780 </div> 718 </div>
781 </div><p> 719 </div><p>
782 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " --> 720 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " -->
783 <div class="memitem"> 721 <div class="memitem">
786 <tr> 724 <tr>
787 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td> 725 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
788 <td>(</td> 726 <td>(</td>
789 <td class="paramname"> </td> 727 <td class="paramname"> </td>
790 <td>&nbsp;)&nbsp;</td> 728 <td>&nbsp;)&nbsp;</td>
791 <td width="100%"> const<code> [virtual]</code></td> 729 <td> const<code> [virtual]</code></td>
792 </tr> 730 </tr>
793 </table> 731 </table>
794 </div> 732 </div>
795 <div class="memdoc"> 733 <div class="memdoc">
796 734
797 <p> 735 <p>
798 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function) for the plugin. 736 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin.
799 <p> 737 <p>
800 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 738 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
801 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 739 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
802 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p> 740 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
803 741
804 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 742 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
805 743
806 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00158">158</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
807
808 <p>References <a class="el" href="Plugin_8h-source.html#l00186">Vamp::Plugin::getPreferredStepSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
809
810 </div> 744 </div>
811 </div><p> 745 </div><p>
812 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " --> 746 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " -->
813 <div class="memitem"> 747 <div class="memitem">
814 <div class="memproto"> 748 <div class="memproto">
816 <tr> 750 <tr>
817 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td> 751 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
818 <td>(</td> 752 <td>(</td>
819 <td class="paramname"> </td> 753 <td class="paramname"> </td>
820 <td>&nbsp;)&nbsp;</td> 754 <td>&nbsp;)&nbsp;</td>
821 <td width="100%"> const<code> [virtual]</code></td> 755 <td> const<code> [virtual]</code></td>
822 </tr> 756 </tr>
823 </table> 757 </table>
824 </div> 758 </div>
825 <div class="memdoc"> 759 <div class="memdoc">
826 760
827 <p> 761 <p>
828 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> function). 762 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function).
829 <p> 763 <p>
830 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 764 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p>
831 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 765 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call.
832 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> 766 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
833 767
834 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 768 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
835
836 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00164">164</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
837
838 <p>References <a class="el" href="Plugin_8h-source.html#l00171">Vamp::Plugin::getPreferredBlockSize()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
839
840 <p>Referenced by <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00308">Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize()</a>.</p>
841 769
842 </div> 770 </div>
843 </div><p> 771 </div><p>
844 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " --> 772 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
845 <div class="memitem"> 773 <div class="memitem">
848 <tr> 776 <tr>
849 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td> 777 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
850 <td>(</td> 778 <td>(</td>
851 <td class="paramname"> </td> 779 <td class="paramname"> </td>
852 <td>&nbsp;)&nbsp;</td> 780 <td>&nbsp;)&nbsp;</td>
853 <td width="100%"> const<code> [virtual]</code></td> 781 <td> const<code> [virtual]</code></td>
854 </tr> 782 </tr>
855 </table> 783 </table>
856 </div> 784 </div>
857 <div class="memdoc"> 785 <div class="memdoc">
858 786
860 Get the minimum supported number of input channels. 788 Get the minimum supported number of input channels.
861 <p> 789 <p>
862 790
863 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 791 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
864 792
865 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00170">170</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p>
866
867 <p>References <a class="el" href="Plugin_8h-source.html#l00191">Vamp::Plugin::getMinChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p>
868
869 </div> 793 </div>
870 </div><p> 794 </div><p>
871 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " --> 795 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " -->
872 <div class="memitem"> 796 <div class="memitem">
873 <div class="memproto"> 797 <div class="memproto">
875 <tr> 799 <tr>
876 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td> 800 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
877 <td>(</td> 801 <td>(</td>
878 <td class="paramname"> </td> 802 <td class="paramname"> </td>
879 <td>&nbsp;)&nbsp;</td> 803 <td>&nbsp;)&nbsp;</td>
880 <td width="100%"> const<code> [virtual]</code></td> 804 <td> const<code> [virtual]</code></td>
881 </tr> 805 </tr>
882 </table> 806 </table>
883 </div> 807 </div>
884 <div class="memdoc"> 808 <div class="memdoc">
885 809
887 Get the maximum supported number of input channels. 811 Get the maximum supported number of input channels.
888 <p> 812 <p>
889 813
890 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 814 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
891 815
892 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00175">175</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 816 </div>
893 817 </div><p>
894 <p>References <a class="el" href="Plugin_8h-source.html#l00196">Vamp::Plugin::getMaxChannelCount()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p> 818 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " -->
895 819 <div class="memitem">
896 </div> 820 <div class="memproto">
897 </div><p> 821 <table class="memname">
898 <a class="anchor" name="02c8c01972affeea58b091335e791ace"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getOutputDescriptors" ref="02c8c01972affeea58b091335e791ace" args="() const " --> 822 <tr>
899 <div class="memitem"> 823 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
900 <div class="memproto"> 824 <td>(</td>
901 <table class="memname"> 825 <td class="paramname"> </td>
902 <tr> 826 <td>&nbsp;)&nbsp;</td>
903 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">Plugin::OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td> 827 <td> const<code> [virtual]</code></td>
904 <td>(</td>
905 <td class="paramname"> </td>
906 <td>&nbsp;)&nbsp;</td>
907 <td width="100%"> const<code> [virtual]</code></td>
908 </tr> 828 </tr>
909 </table> 829 </table>
910 </div> 830 </div>
911 <div class="memdoc"> 831 <div class="memdoc">
912 832
913 <p> 833 <p>
914 Get the outputs of this plugin. 834 Get the outputs of this plugin.
915 <p> 835 <p>
916 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#fca78043c2843c1d45019983515e23f7" title="Process a single block of input data.">process()</a> call. 836 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call.
917 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 837 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
918 838
919 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#85a027f5859efb31d315205e234e94c0">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 839 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
920 840
921 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00181">181</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 841 </div>
922 842 </div><p>
923 <p>References <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin::getOutputDescriptors()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p> 843 <a class="anchor" name="6bd72d6dfb3047524dbe8ae3294527cf"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::process" ref="6bd72d6dfb3047524dbe8ae3294527cf" args="(const float *const *inputBuffers, RealTime timestamp)" -->
924 844 <div class="memitem">
925 </div> 845 <div class="memproto">
926 </div><p> 846 <table class="memname">
927 <a class="anchor" name="fca78043c2843c1d45019983515e23f7"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::process" ref="fca78043c2843c1d45019983515e23f7" args="(const float *const *inputBuffers, RealTime timestamp)" --> 847 <tr>
928 <div class="memitem"> 848 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
929 <div class="memproto">
930 <table class="memname">
931 <tr>
932 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
933 <td>(</td> 849 <td>(</td>
934 <td class="paramtype">const float *const *&nbsp;</td> 850 <td class="paramtype">const float *const *&nbsp;</td>
935 <td class="paramname"> <em>inputBuffers</em>, </td> 851 <td class="paramname"> <em>inputBuffers</em>, </td>
936 </tr> 852 </tr>
937 <tr> 853 <tr>
941 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td> 857 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
942 </tr> 858 </tr>
943 <tr> 859 <tr>
944 <td></td> 860 <td></td>
945 <td>)</td> 861 <td>)</td>
946 <td></td><td></td><td width="100%"><code> [virtual]</code></td> 862 <td></td><td></td><td><code> [virtual]</code></td>
947 </tr> 863 </tr>
948 </table> 864 </table>
949 </div> 865 </div>
950 <div class="memdoc"> 866 <div class="memdoc">
951 867
952 <p> 868 <p>
953 Process a single block of input data. 869 Process a single block of input data.
954 <p> 870 <p>
955 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp will be the real time in seconds of the start of the supplied block of samples.<p> 871 If the plugin's inputDomain is TimeDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize consecutive audio samples (the host will zero-pad as necessary). The timestamp in this case will be the real time in seconds of the start of the supplied block of samples.<p>
956 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p> 872 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p>
957 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.) 873 Return any features that have become available after this process call. (These do not necessarily have to fall within the process block, except for OneSamplePerStep outputs.)
958 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 874 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
959 875
960 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#262206b978d9de28ee4bb35f437e915e">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#294e663b4d9ec885791faa1b440571ed">Vamp::HostExt::PluginChannelAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#0867737693c16801d40a6adbde07ec07">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 876 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#6ff37bf754ff8711dbcb2f020fa3902c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#b36a81ac9a0ded8d83c6b855263c0231">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
961 877
962 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00187">187</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 878 </div>
963 879 </div><p>
964 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>, and <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin::process()</a>.</p> 880 <a class="anchor" name="2bc8c0992e64f06991fb7cf89f99857e"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getRemainingFeatures" ref="2bc8c0992e64f06991fb7cf89f99857e" args="()" -->
965 881 <div class="memitem">
966 </div> 882 <div class="memproto">
967 </div><p> 883 <table class="memname">
968 <a class="anchor" name="1dce55a75a32b08fc56a52a300d9fcbe"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getRemainingFeatures" ref="1dce55a75a32b08fc56a52a300d9fcbe" args="()" --> 884 <tr>
969 <div class="memitem"> 885 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
970 <div class="memproto"> 886 <td>(</td>
971 <table class="memname"> 887 <td class="paramname"> </td>
972 <tr> 888 <td>&nbsp;)&nbsp;</td>
973 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Plugin::FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td> 889 <td><code> [virtual]</code></td>
974 <td>(</td>
975 <td class="paramname"> </td>
976 <td>&nbsp;)&nbsp;</td>
977 <td width="100%"><code> [virtual]</code></td>
978 </tr> 890 </tr>
979 </table> 891 </table>
980 </div> 892 </div>
981 <div class="memdoc"> 893 <div class="memdoc">
982 894
984 After all blocks have been processed, calculate and return any remaining features derived from the complete input. 896 After all blocks have been processed, calculate and return any remaining features derived from the complete input.
985 <p> 897 <p>
986 898
987 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 899 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
988 900
989 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#8771cba75552aaa1340b68de9bf1659c">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 901 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter</a>.</p>
990 902
991 <p>Definition at line <a class="el" href="PluginWrapper_8cpp-source.html#l00193">193</a> of file <a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a>.</p> 903 </div>
992 904 </div><p>
993 <p>References <a class="el" href="classVamp_1_1Plugin.html#eca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin::getRemainingFeatures()</a>, and <a class="el" href="PluginWrapper_8h-source.html#l00099">m_plugin</a>.</p> 905 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
906 <div class="memitem">
907 <div class="memproto">
908 <div class="memtemplate">
909 template&lt;typename WrapperType&gt; </div>
910 <table class="memname">
911 <tr>
912 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
913 <td>(</td>
914 <td class="paramname"> </td>
915 <td>&nbsp;)&nbsp;</td>
916 <td><code> [inline]</code></td>
917 </tr>
918 </table>
919 </div>
920 <div class="memdoc">
921
922 <p>
923 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present.
924 <p>
925 This is useful in situations where a plugin is wrapped by multiple different wrappers (one inside another) and the host wants to call some wrapper-specific function on one of the layers without having to care about the order in which they are wrapped. For example, the plugin returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">PluginLoader::loadPlugin</a> may have more than one wrapper; if the host wanted to query or fine-tune some property of one of them, it would be hard to do so without knowing the order of the wrappers. This function therefore gives direct access to the wrapper of a particular type.
926 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00116">116</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
927
928 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">getWrapper()</a>.</p>
929
930 <p>Referenced by <a class="el" href="PluginWrapper_8h-source.html#l00116">getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp-source.html#l00265">runPlugin()</a>.</p>
994 931
995 </div> 932 </div>
996 </div><p> 933 </div><p>
997 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> 934 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " -->
998 <div class="memitem"> 935 <div class="memitem">
1001 <tr> 938 <tr>
1002 <td class="memname">virtual std::string Vamp::Plugin::getType </td> 939 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1003 <td>(</td> 940 <td>(</td>
1004 <td class="paramname"> </td> 941 <td class="paramname"> </td>
1005 <td>&nbsp;)&nbsp;</td> 942 <td>&nbsp;)&nbsp;</td>
1006 <td width="100%"> const<code> [inline, virtual, inherited]</code></td> 943 <td> const<code> [inline, virtual, inherited]</code></td>
1007 </tr> 944 </tr>
1008 </table> 945 </table>
1009 </div> 946 </div>
1010 <div class="memdoc"> 947 <div class="memdoc">
1011 948
1013 Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. 950 Used to distinguish between <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> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>.
1014 <p> 951 <p>
1015 Do not reimplement this function in your subclass. 952 Do not reimplement this function in your subclass.
1016 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 953 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1017 954
1018 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00391">391</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 955 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00425">425</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
1019 956
1020 </div> 957 </div>
1021 </div><p> 958 </div><p>
1022 <hr><h2>Member Data Documentation</h2> 959 <hr><h2>Member Data Documentation</h2>
1023 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> 960 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
1031 </div> 968 </div>
1032 <div class="memdoc"> 969 <div class="memdoc">
1033 970
1034 <p> 971 <p>
1035 972
1036 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00099">99</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p> 973 <p>Definition at line <a class="el" href="PluginWrapper_8h-source.html#l00126">126</a> of file <a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a>.</p>
1037
1038 <p>Referenced by <a class="el" href="PluginWrapper_8cpp-source.html#l00116">getCopyright()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00146">getCurrentProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00098">getDescription()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00086">getIdentifier()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00074">getInputDomain()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00104">getMaker()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00175">getMaxChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00170">getMinChannelCount()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00092">getName()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00181">getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00128">getParameter()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00122">getParameterDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00110">getPluginVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00164">getPreferredBlockSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00158">getPreferredStepSize()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00140">getPrograms()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00193">getRemainingFeatures()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00080">getVampApiVersion()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00062">initialise()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00187">process()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00068">reset()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00152">selectProgram()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00134">setParameter()</a>, <a class="el" href="PluginLoader_8cpp-source.html#l00620">Vamp::HostExt::PluginLoader::Impl::PluginDeletionNotifyAdapter::~PluginDeletionNotifyAdapter()</a>, and <a class="el" href="PluginWrapper_8cpp-source.html#l00056">~PluginWrapper()</a>.</p>
1039 974
1040 </div> 975 </div>
1041 </div><p> 976 </div><p>
1042 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> 977 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginWrapper::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1043 <div class="memitem"> 978 <div class="memitem">
1050 </div> 985 </div>
1051 <div class="memdoc"> 986 <div class="memdoc">
1052 987
1053 <p> 988 <p>
1054 989
1055 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00397">397</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 990 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00431">431</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
1056 991
1057 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="PluginWrapper_8cpp-source.html#l00047">Vamp::HostExt::PluginRateExtractor::getRate()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="PluginBufferingAdapter_8cpp-source.html#l00238">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter()</a>, <a class="el" href="PluginInputDomainAdapter_8cpp-source.html#l00113">Vamp::HostExt::PluginInputDomainAdapter::PluginInputDomainAdapter()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> 992 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
1058 993
1059 </div> 994 </div>
1060 </div><p> 995 </div><p>
1061 <hr>The documentation for this class was generated from the following files:<ul> 996 <hr>The documentation for this class was generated from the following file:<ul>
1062 <li><a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a><li><a class="el" href="PluginWrapper_8cpp-source.html">PluginWrapper.cpp</a></ul> 997 <li><a class="el" href="PluginWrapper_8h-source.html">PluginWrapper.h</a></ul>
1063 </div> 998 </div>
1064 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:11 2008 for VampPluginSDK by&nbsp; 999 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:22 2008 for VampPluginSDK by&nbsp;
1065 <a href="http://www.doxygen.org/index.html"> 1000 <a href="http://www.doxygen.org/index.html">
1066 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 1001 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
1067 </body> 1002 </body>
1068 </html> 1003 </html>