comparison code-docs/classVamp_1_1HostExt_1_1PluginBufferingAdapter.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title> 8 <title>VampPluginSDK: Vamp::HostExt::PluginBufferingAdapter Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34 31 </td>
35 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
59 </ul>
60 </div>
61 </div>
62 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
63 <div id="nav-tree"> 48 <div id="nav-tree">
64 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
65 </div> 51 </div>
66 </div> 52 </div>
67 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
69 </div> 55 </div>
70 </div> 56 </div>
71 <script type="text/javascript"> 57 <script type="text/javascript">
72 initNavTree('classVamp_1_1HostExt_1_1PluginBufferingAdapter.html',''); 58 $(document).ready(function(){initNavTree('classVamp_1_1HostExt_1_1PluginBufferingAdapter.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-types">Public Types</a> &#124; 63 <a href="#pub-types">Public Types</a> &#124;
78 <a href="#pub-methods">Public Member Functions</a> &#124; 64 <a href="#pub-methods">Public Member Functions</a> &#124;
79 <a href="#pro-attribs">Protected Attributes</a> </div> 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
66 <a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members</a> </div>
80 <div class="headertitle"> 67 <div class="headertitle">
81 <div class="title">Vamp::HostExt::PluginBufferingAdapter Class Reference</div> </div> 68 <div class="title">Vamp::HostExt::PluginBufferingAdapter Class Reference</div> </div>
82 </div><!--header--> 69 </div><!--header-->
83 <div class="contents"> 70 <div class="contents">
84 71
89 <div class="dynheader"> 76 <div class="dynheader">
90 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div> 77 Inheritance diagram for Vamp::HostExt::PluginBufferingAdapter:</div>
91 <div class="dyncontent"> 78 <div class="dyncontent">
92 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" alt="Inheritance graph"/></div> 79 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginBufferingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" alt="Inheritance graph"/></div>
93 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map"> 80 <map name="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginBufferingAdapter_inherit__map">
94 <area shape="rect" id="node2" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="28,155,212,181"/><area shape="rect" id="node4" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="74,81,165,106"/><area shape="rect" id="node6" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="61,6,179,31"/></map> 81 <area shape="rect" id="node2" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. " alt="" coords="7,152,198,177"/>
82 <area shape="rect" id="node3" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="55,79,150,104"/>
83 <area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="41,5,164,31"/>
84 </map>
95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> 85 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
96
97 <p><a href="classVamp_1_1HostExt_1_1PluginBufferingAdapter-members.html">List of all members.</a></p>
98 <table class="memberdecls"> 86 <table class="memberdecls">
99 <tr><td colspan="2"><h2><a name="pub-types"></a> 87 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
100 Public Types</h2></td></tr> 88 Public Types</h2></td></tr>
101 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, 89 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
102 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 90 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
103 }</td></tr> 91 }</td></tr>
104 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 92 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr> 93 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
94 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> 95 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
107 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/> 96 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr> 97 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
109 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 98 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> 99 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
100 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> 101 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
112 <tr><td colspan="2"><h2><a name="pub-methods"></a> 102 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 </table><table class="memberdecls">
104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113 Public Member Functions</h2></td></tr> 105 Public Member Functions</h2></td></tr>
114 <tr class="memitem:a1276bcfcbe1414b33eeefbd7b2b702fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 106 <tr class="memitem:a1276bcfcbe1414b33eeefbd7b2b702fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a1276bcfcbe1414b33eeefbd7b2b702fe">PluginBufferingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
115 <tr class="memdesc:a1276bcfcbe1414b33eeefbd7b2b702fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. <a href="#a1276bcfcbe1414b33eeefbd7b2b702fe"></a><br/></td></tr> 107 <tr class="memdesc:a1276bcfcbe1414b33eeefbd7b2b702fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. <a href="#a1276bcfcbe1414b33eeefbd7b2b702fe">More...</a><br /></td></tr>
108 <tr class="separator:a1276bcfcbe1414b33eeefbd7b2b702fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
116 <tr class="memitem:a96263f7b0910a10eeae86f20db007e55"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a96263f7b0910a10eeae86f20db007e55">~PluginBufferingAdapter</a> ()</td></tr> 109 <tr class="memitem:a96263f7b0910a10eeae86f20db007e55"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a96263f7b0910a10eeae86f20db007e55">~PluginBufferingAdapter</a> ()</td></tr>
117 <tr class="memitem:a2e66d009df69c951001e5d2786973d60"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">getPreferredStepSize</a> () const </td></tr> 110 <tr class="separator:a96263f7b0910a10eeae86f20db007e55"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memdesc:a2e66d009df69c951001e5d2786973d60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred step size for this adapter. <a href="#a2e66d009df69c951001e5d2786973d60"></a><br/></td></tr> 111 <tr class="memitem:acb6b82c61ebac4610a8b92f94cd50682"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#acb6b82c61ebac4610a8b92f94cd50682">getPreferredStepSize</a> () const</td></tr>
119 <tr class="memitem:a21e45180b19873f9ab69fe7a4e184a03"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">getPreferredBlockSize</a> () const </td></tr> 112 <tr class="memdesc:acb6b82c61ebac4610a8b92f94cd50682"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred step size for this adapter. <a href="#acb6b82c61ebac4610a8b92f94cd50682">More...</a><br /></td></tr>
120 <tr class="memdesc:a21e45180b19873f9ab69fe7a4e184a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred block size for this adapter. <a href="#a21e45180b19873f9ab69fe7a4e184a03"></a><br/></td></tr> 113 <tr class="separator:acb6b82c61ebac4610a8b92f94cd50682"><td class="memSeparator" colspan="2">&#160;</td></tr>
114 <tr class="memitem:a39dd1770dd0a737ff295d70082d86fd3"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a39dd1770dd0a737ff295d70082d86fd3">getPreferredBlockSize</a> () const</td></tr>
115 <tr class="memdesc:a39dd1770dd0a737ff295d70082d86fd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred block size for this adapter. <a href="#a39dd1770dd0a737ff295d70082d86fd3">More...</a><br /></td></tr>
116 <tr class="separator:a39dd1770dd0a737ff295d70082d86fd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <tr class="memitem:a9e7798ba4d7870db46502ab541ab37a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 117 <tr class="memitem:a9e7798ba4d7870db46502ab541ab37a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
122 <tr class="memdesc:a9e7798ba4d7870db46502ab541ab37a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the adapter (and therefore the plugin) for the given number of channels. <a href="#a9e7798ba4d7870db46502ab541ab37a8"></a><br/></td></tr> 118 <tr class="memdesc:a9e7798ba4d7870db46502ab541ab37a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the adapter (and therefore the plugin) for the given number of channels. <a href="#a9e7798ba4d7870db46502ab541ab37a8">More...</a><br /></td></tr>
123 <tr class="memitem:ad7fad500331808b5cdf90f5a45019b02"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02">getPluginPreferredStepSize</a> () const </td></tr> 119 <tr class="separator:a9e7798ba4d7870db46502ab541ab37a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
124 <tr class="memdesc:ad7fad500331808b5cdf90f5a45019b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred step size of the plugin wrapped by this adapter. <a href="#ad7fad500331808b5cdf90f5a45019b02"></a><br/></td></tr> 120 <tr class="memitem:aa9a614ee2900ce22039af9ca43c11b81"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa9a614ee2900ce22039af9ca43c11b81">getPluginPreferredStepSize</a> () const</td></tr>
125 <tr class="memitem:a7045be875de9dd226d2e2a222e957de0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0">getPluginPreferredBlockSize</a> () const </td></tr> 121 <tr class="memdesc:aa9a614ee2900ce22039af9ca43c11b81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred step size of the plugin wrapped by this adapter. <a href="#aa9a614ee2900ce22039af9ca43c11b81">More...</a><br /></td></tr>
126 <tr class="memdesc:a7045be875de9dd226d2e2a222e957de0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred block size of the plugin wrapped by this adapter. <a href="#a7045be875de9dd226d2e2a222e957de0"></a><br/></td></tr> 122 <tr class="separator:aa9a614ee2900ce22039af9ca43c11b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="memitem:ad8506e594c7aeb275ccfbbf21c4c3c40"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad8506e594c7aeb275ccfbbf21c4c3c40">getPluginPreferredBlockSize</a> () const</td></tr>
124 <tr class="memdesc:ad8506e594c7aeb275ccfbbf21c4c3c40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the preferred block size of the plugin wrapped by this adapter. <a href="#ad8506e594c7aeb275ccfbbf21c4c3c40">More...</a><br /></td></tr>
125 <tr class="separator:ad8506e594c7aeb275ccfbbf21c4c3c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
127 <tr class="memitem:ac99898d78a01a7fad4def4d6c5fd3a7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac99898d78a01a7fad4def4d6c5fd3a7e">setPluginStepSize</a> (size_t stepSize)</td></tr> 126 <tr class="memitem:ac99898d78a01a7fad4def4d6c5fd3a7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac99898d78a01a7fad4def4d6c5fd3a7e">setPluginStepSize</a> (size_t stepSize)</td></tr>
128 <tr class="memdesc:ac99898d78a01a7fad4def4d6c5fd3a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. <a href="#ac99898d78a01a7fad4def4d6c5fd3a7e"></a><br/></td></tr> 127 <tr class="memdesc:ac99898d78a01a7fad4def4d6c5fd3a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a> is called. <a href="#ac99898d78a01a7fad4def4d6c5fd3a7e">More...</a><br /></td></tr>
128 <tr class="separator:ac99898d78a01a7fad4def4d6c5fd3a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:aa80ae1bff6f95e805811df2c3770a98c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa80ae1bff6f95e805811df2c3770a98c">setPluginBlockSize</a> (size_t blockSize)</td></tr> 129 <tr class="memitem:aa80ae1bff6f95e805811df2c3770a98c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa80ae1bff6f95e805811df2c3770a98c">setPluginBlockSize</a> (size_t blockSize)</td></tr>
130 <tr class="memdesc:aa80ae1bff6f95e805811df2c3770a98c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. <a href="#aa80ae1bff6f95e805811df2c3770a98c"></a><br/></td></tr> 130 <tr class="memdesc:aa80ae1bff6f95e805811df2c3770a98c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a> is called. <a href="#aa80ae1bff6f95e805811df2c3770a98c">More...</a><br /></td></tr>
131 <tr class="separator:aa80ae1bff6f95e805811df2c3770a98c"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:aa065985fd864f6869d1bc7fea6fa2ece"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa065985fd864f6869d1bc7fea6fa2ece">getActualStepAndBlockSizes</a> (size_t &amp;stepSize, size_t &amp;blockSize)</td></tr> 132 <tr class="memitem:aa065985fd864f6869d1bc7fea6fa2ece"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa065985fd864f6869d1bc7fea6fa2ece">getActualStepAndBlockSizes</a> (size_t &amp;stepSize, size_t &amp;blockSize)</td></tr>
132 <tr class="memdesc:aa065985fd864f6869d1bc7fea6fa2ece"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the step and block sizes that were actually used when initialising the underlying plugin. <a href="#aa065985fd864f6869d1bc7fea6fa2ece"></a><br/></td></tr> 133 <tr class="memdesc:aa065985fd864f6869d1bc7fea6fa2ece"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the step and block sizes that were actually used when initialising the underlying plugin. <a href="#aa065985fd864f6869d1bc7fea6fa2ece">More...</a><br /></td></tr>
134 <tr class="separator:aa065985fd864f6869d1bc7fea6fa2ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:a7a979b20c169d37adbd7b7d8b8a077b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">setParameter</a> (std::string, float)</td></tr> 135 <tr class="memitem:a7a979b20c169d37adbd7b7d8b8a077b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">setParameter</a> (std::string, float)</td></tr>
134 <tr class="memdesc:a7a979b20c169d37adbd7b7d8b8a077b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a7a979b20c169d37adbd7b7d8b8a077b3"></a><br/></td></tr> 136 <tr class="memdesc:a7a979b20c169d37adbd7b7d8b8a077b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a7a979b20c169d37adbd7b7d8b8a077b3">More...</a><br /></td></tr>
137 <tr class="separator:a7a979b20c169d37adbd7b7d8b8a077b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:a3cc7000e0aff525950e0a286b87f8927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">selectProgram</a> (std::string)</td></tr> 138 <tr class="memitem:a3cc7000e0aff525950e0a286b87f8927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">selectProgram</a> (std::string)</td></tr>
136 <tr class="memdesc:a3cc7000e0aff525950e0a286b87f8927"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a3cc7000e0aff525950e0a286b87f8927"></a><br/></td></tr> 139 <tr class="memdesc:a3cc7000e0aff525950e0a286b87f8927"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a3cc7000e0aff525950e0a286b87f8927">More...</a><br /></td></tr>
137 <tr class="memitem:af8cc914897a284433de220f1153f3845"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">getOutputDescriptors</a> () const </td></tr> 140 <tr class="separator:a3cc7000e0aff525950e0a286b87f8927"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memdesc:af8cc914897a284433de220f1153f3845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#af8cc914897a284433de220f1153f3845"></a><br/></td></tr> 141 <tr class="memitem:ac17520cdd29a57d320ca65066ec2636c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac17520cdd29a57d320ca65066ec2636c">getOutputDescriptors</a> () const</td></tr>
142 <tr class="memdesc:ac17520cdd29a57d320ca65066ec2636c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ac17520cdd29a57d320ca65066ec2636c">More...</a><br /></td></tr>
143 <tr class="separator:ac17520cdd29a57d320ca65066ec2636c"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <tr class="memitem:a131fd9fe8a1795d7370d8a721176868a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr> 144 <tr class="memitem:a131fd9fe8a1795d7370d8a721176868a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">reset</a> ()</td></tr>
140 <tr class="memdesc:a131fd9fe8a1795d7370d8a721176868a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a131fd9fe8a1795d7370d8a721176868a"></a><br/></td></tr> 145 <tr class="memdesc:a131fd9fe8a1795d7370d8a721176868a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a131fd9fe8a1795d7370d8a721176868a">More...</a><br /></td></tr>
146 <tr class="separator:a131fd9fe8a1795d7370d8a721176868a"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a55058a20c1f8bffc0dc927350df778a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 147 <tr class="memitem:a55058a20c1f8bffc0dc927350df778a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
142 <tr class="memdesc:a55058a20c1f8bffc0dc927350df778a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a55058a20c1f8bffc0dc927350df778a0"></a><br/></td></tr> 148 <tr class="memdesc:a55058a20c1f8bffc0dc927350df778a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a55058a20c1f8bffc0dc927350df778a0">More...</a><br /></td></tr>
149 <tr class="separator:a55058a20c1f8bffc0dc927350df778a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a28423951b2eda1a1fc371485434f417b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">getRemainingFeatures</a> ()</td></tr> 150 <tr class="memitem:a28423951b2eda1a1fc371485434f417b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">getRemainingFeatures</a> ()</td></tr>
144 <tr class="memdesc:a28423951b2eda1a1fc371485434f417b"><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#a28423951b2eda1a1fc371485434f417b"></a><br/></td></tr> 151 <tr class="memdesc:a28423951b2eda1a1fc371485434f417b"><td class="mdescLeft">&#160;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#a28423951b2eda1a1fc371485434f417b">More...</a><br /></td></tr>
145 <tr class="memitem:ae203faf8384c9e1fddc381409aa8a214"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr> 152 <tr class="separator:a28423951b2eda1a1fc371485434f417b"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memdesc:ae203faf8384c9e1fddc381409aa8a214"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae203faf8384c9e1fddc381409aa8a214"></a><br/></td></tr> 153 <tr class="memitem:a8838facfe9d88cf36b13c1b42165fc6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a8838facfe9d88cf36b13c1b42165fc6d">getInputDomain</a> () const</td></tr>
147 <tr class="memitem:a74147fda6b44ff2169bd4a1eea0d46ff"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr> 154 <tr class="memdesc:a8838facfe9d88cf36b13c1b42165fc6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a8838facfe9d88cf36b13c1b42165fc6d">More...</a><br /></td></tr>
148 <tr class="memdesc:a74147fda6b44ff2169bd4a1eea0d46ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a74147fda6b44ff2169bd4a1eea0d46ff"></a><br/></td></tr> 155 <tr class="separator:a8838facfe9d88cf36b13c1b42165fc6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a4baa9e48f717c2b3e7f92496aa39d904"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> 156 <tr class="memitem:afa79272f991fb720ddd09784be1b3cb8"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#afa79272f991fb720ddd09784be1b3cb8">getVampApiVersion</a> () const</td></tr>
150 <tr class="memdesc:a4baa9e48f717c2b3e7f92496aa39d904"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4baa9e48f717c2b3e7f92496aa39d904"></a><br/></td></tr> 157 <tr class="memdesc:afa79272f991fb720ddd09784be1b3cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#afa79272f991fb720ddd09784be1b3cb8">More...</a><br /></td></tr>
151 <tr class="memitem:ac70a3265bb25aeb03f6dd8f8a0442088"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> 158 <tr class="separator:afa79272f991fb720ddd09784be1b3cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memdesc:ac70a3265bb25aeb03f6dd8f8a0442088"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#ac70a3265bb25aeb03f6dd8f8a0442088"></a><br/></td></tr> 159 <tr class="memitem:ad9312a38c199004c7bad0c42f590393f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad9312a38c199004c7bad0c42f590393f">getIdentifier</a> () const</td></tr>
153 <tr class="memitem:ac334f699c0996055942785410d8a065c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr> 160 <tr class="memdesc:ad9312a38c199004c7bad0c42f590393f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad9312a38c199004c7bad0c42f590393f">More...</a><br /></td></tr>
154 <tr class="memdesc:ac334f699c0996055942785410d8a065c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#ac334f699c0996055942785410d8a065c"></a><br/></td></tr> 161 <tr class="separator:ad9312a38c199004c7bad0c42f590393f"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a59d5a2298951b317995675e664b1c7bb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr> 162 <tr class="memitem:aa2b40de6e240d872997a63dd4a301ff3"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa2b40de6e240d872997a63dd4a301ff3">getName</a> () const</td></tr>
156 <tr class="memdesc:a59d5a2298951b317995675e664b1c7bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a59d5a2298951b317995675e664b1c7bb"></a><br/></td></tr> 163 <tr class="memdesc:aa2b40de6e240d872997a63dd4a301ff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#aa2b40de6e240d872997a63dd4a301ff3">More...</a><br /></td></tr>
157 <tr class="memitem:a47e1acf1696813008324a915c9ba59c5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr> 164 <tr class="separator:aa2b40de6e240d872997a63dd4a301ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memdesc:a47e1acf1696813008324a915c9ba59c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a47e1acf1696813008324a915c9ba59c5"></a><br/></td></tr> 165 <tr class="memitem:ad6e453c30b265a2daf243f953b35c815"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad6e453c30b265a2daf243f953b35c815">getDescription</a> () const</td></tr>
159 <tr class="memitem:ae14f6ecb78be909c4cd5f0cdaed3c566"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr> 166 <tr class="memdesc:ad6e453c30b265a2daf243f953b35c815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#ad6e453c30b265a2daf243f953b35c815">More...</a><br /></td></tr>
160 <tr class="memdesc:ae14f6ecb78be909c4cd5f0cdaed3c566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ae14f6ecb78be909c4cd5f0cdaed3c566"></a><br/></td></tr> 167 <tr class="separator:ad6e453c30b265a2daf243f953b35c815"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:a9be71561265c2e6e43b7feaddaa91f36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr> 168 <tr class="memitem:af9b2f01063828ef0745dc2623fc8dd42"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#af9b2f01063828ef0745dc2623fc8dd42">getMaker</a> () const</td></tr>
162 <tr class="memdesc:a9be71561265c2e6e43b7feaddaa91f36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9be71561265c2e6e43b7feaddaa91f36"></a><br/></td></tr> 169 <tr class="memdesc:af9b2f01063828ef0745dc2623fc8dd42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#af9b2f01063828ef0745dc2623fc8dd42">More...</a><br /></td></tr>
163 <tr class="memitem:a034920f56c8d7609a85447c42556048c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr> 170 <tr class="separator:af9b2f01063828ef0745dc2623fc8dd42"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <tr class="memdesc:a034920f56c8d7609a85447c42556048c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a034920f56c8d7609a85447c42556048c"></a><br/></td></tr> 171 <tr class="memitem:a9537de27c826a1441b2d3643df4880bb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9537de27c826a1441b2d3643df4880bb">getPluginVersion</a> () const</td></tr>
165 <tr class="memitem:a131fbe1df81215020b9aa8cecef4c802"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr> 172 <tr class="memdesc:a9537de27c826a1441b2d3643df4880bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a9537de27c826a1441b2d3643df4880bb">More...</a><br /></td></tr>
166 <tr class="memdesc:a131fbe1df81215020b9aa8cecef4c802"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a131fbe1df81215020b9aa8cecef4c802"></a><br/></td></tr> 173 <tr class="separator:a9537de27c826a1441b2d3643df4880bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:a7a312dd42d161064b70afd7ff24c0651"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr> 174 <tr class="memitem:aea9c238f86de65d3380fa887bb9e47e6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aea9c238f86de65d3380fa887bb9e47e6">getCopyright</a> () const</td></tr>
168 <tr class="memdesc:a7a312dd42d161064b70afd7ff24c0651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr> 175 <tr class="memdesc:aea9c238f86de65d3380fa887bb9e47e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#aea9c238f86de65d3380fa887bb9e47e6">More...</a><br /></td></tr>
169 <tr class="memitem:a2b28f1cf37d46a514f1e1411a6037bf8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr> 176 <tr class="separator:aea9c238f86de65d3380fa887bb9e47e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memdesc:a2b28f1cf37d46a514f1e1411a6037bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a2b28f1cf37d46a514f1e1411a6037bf8"></a><br/></td></tr> 177 <tr class="memitem:ab2b67205d86e921cb0a9bd1f819d2cf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab2b67205d86e921cb0a9bd1f819d2cf9">getParameterDescriptors</a> () const</td></tr>
171 <tr class="memitem:a985eb21f1827bfbc3950d6871b107a58"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr> 178 <tr class="memdesc:ab2b67205d86e921cb0a9bd1f819d2cf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#ab2b67205d86e921cb0a9bd1f819d2cf9">More...</a><br /></td></tr>
172 <tr class="memdesc:a985eb21f1827bfbc3950d6871b107a58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a985eb21f1827bfbc3950d6871b107a58"></a><br/></td></tr> 179 <tr class="separator:ab2b67205d86e921cb0a9bd1f819d2cf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:a5c0a4d72a25fded51829de21771de521"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5c0a4d72a25fded51829de21771de521">getParameter</a> (std::string) const</td></tr>
181 <tr class="memdesc:a5c0a4d72a25fded51829de21771de521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a5c0a4d72a25fded51829de21771de521">More...</a><br /></td></tr>
182 <tr class="separator:a5c0a4d72a25fded51829de21771de521"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <tr class="memitem:aa0b72ea17766266d20539f293ccae7c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa0b72ea17766266d20539f293ccae7c8">getPrograms</a> () const</td></tr>
184 <tr class="memdesc:aa0b72ea17766266d20539f293ccae7c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#aa0b72ea17766266d20539f293ccae7c8">More...</a><br /></td></tr>
185 <tr class="separator:aa0b72ea17766266d20539f293ccae7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 <tr class="memitem:a3936fe2c4b3c960dd244849a7c3320ad"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a3936fe2c4b3c960dd244849a7c3320ad">getCurrentProgram</a> () const</td></tr>
187 <tr class="memdesc:a3936fe2c4b3c960dd244849a7c3320ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a3936fe2c4b3c960dd244849a7c3320ad">More...</a><br /></td></tr>
188 <tr class="separator:a3936fe2c4b3c960dd244849a7c3320ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
189 <tr class="memitem:abc0a4e6ce0ae9de39c40725de1f30d2f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#abc0a4e6ce0ae9de39c40725de1f30d2f">getMinChannelCount</a> () const</td></tr>
190 <tr class="memdesc:abc0a4e6ce0ae9de39c40725de1f30d2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#abc0a4e6ce0ae9de39c40725de1f30d2f">More...</a><br /></td></tr>
191 <tr class="separator:abc0a4e6ce0ae9de39c40725de1f30d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
192 <tr class="memitem:acfed040cd91e797ee89d077db22b4a97"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#acfed040cd91e797ee89d077db22b4a97">getMaxChannelCount</a> () const</td></tr>
193 <tr class="memdesc:acfed040cd91e797ee89d077db22b4a97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#acfed040cd91e797ee89d077db22b4a97">More...</a><br /></td></tr>
194 <tr class="separator:acfed040cd91e797ee89d077db22b4a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr> 195 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
174 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplItemLeft" align="right" valign="top">WrapperType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a> ()</td></tr> 196 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplItemLeft" align="right" valign="top">WrapperType *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">getWrapper</a> ()</td></tr>
175 <tr class="memdesc:a653d0308e8e34881a8749b7631d00f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#a653d0308e8e34881a8749b7631d00f05"></a><br/></td></tr> 197 <tr class="memdesc:a653d0308e8e34881a8749b7631d00f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#a653d0308e8e34881a8749b7631d00f05">More...</a><br /></td></tr>
176 <tr class="memitem:abe13b3997a69fbcc09e2213faa352f91"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> 198 <tr class="separator:a653d0308e8e34881a8749b7631d00f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memdesc:abe13b3997a69fbcc09e2213faa352f91"><td class="mdescLeft">&#160;</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 from audio o...">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="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr> 199 <tr class="memitem:a530123068767a8728c568ffccfe3e4e5"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">getType</a> () const</td></tr>
178 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 200 <tr class="memdesc:a530123068767a8728c568ffccfe3e4e5"><td class="mdescLeft">&#160;</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 from audio o...">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="#a530123068767a8728c568ffccfe3e4e5">More...</a><br /></td></tr>
201 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
202 </table><table class="memberdecls">
203 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
179 Protected Attributes</h2></td></tr> 204 Protected Attributes</h2></td></tr>
180 <tr class="memitem:a51e10c9c63c0349fd74c6d604de5554e"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr> 205 <tr class="memitem:a51e10c9c63c0349fd74c6d604de5554e"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">m_impl</a></td></tr>
206 <tr class="separator:a51e10c9c63c0349fd74c6d604de5554e"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 <tr class="memitem:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr> 207 <tr class="memitem:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
208 <tr class="separator:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> 209 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
183 </table> 210 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 211 </table>
212 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
185 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. </p> 213 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size. </p>
186 <p>A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.</p> 214 <p>A host using <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> may ignore the preferred step and block size reported by the plugin, and still expect the plugin to run. The value of blockSize and stepSize passed to initialise should be the size of the buffer which the host will supply; the stepSize should be equal to the blockSize.</p>
187 <p>If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.</p> 215 <p>If the internal step size used for the plugin differs from that supplied by the host, the adapter will modify the sample type and rate specifications for the plugin outputs appropriately, and set timestamps on the output features for outputs that formerly used a different sample rate specification. This is necessary in order to obtain correct time stamping.</p>
188 <p>In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted. </p> 216 <p>In other respects, the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> behaves identically to the plugin that it wraps. The wrapped plugin will be deleted when the wrapper is deleted. </p>
189 217
190 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00075">75</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p> 218 <p class="definition">Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00075">75</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p>
191 </div><hr/><h2>Member Typedef Documentation</h2> 219 </div><h2 class="groupheader">Member Typedef Documentation</h2>
192 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 220 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
193 <div class="memitem"> 221 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
194 <div class="memproto"> 222
195 <table class="memname"> 223 <div class="memitem">
196 <tr> 224 <div class="memproto">
197 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code></td> 225 <table class="mlabels">
198 </tr> 226 <tr>
199 </table> 227 <td class="mlabels-left">
200 </div> 228 <table class="memname">
201 <div class="memdoc"> 229 <tr>
202 230 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a></td>
203 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00327">327</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 231 </tr>
204 232 </table>
205 </div> 233 </td>
206 </div> 234 <td class="mlabels-right">
207 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 235 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
208 <div class="memitem"> 236 </tr>
209 <div class="memproto"> 237 </table>
210 <table class="memname"> 238 </div><div class="memdoc">
211 <tr> 239
212 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code></td> 240 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00335">335</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
213 </tr> 241
214 </table> 242 </div>
215 </div> 243 </div>
216 <div class="memdoc"> 244 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
217 245 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
218 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00385">385</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 246
219 247 <div class="memitem">
220 </div> 248 <div class="memproto">
221 </div> 249 <table class="mlabels">
222 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 250 <tr>
223 <div class="memitem"> 251 <td class="mlabels-left">
224 <div class="memproto"> 252 <table class="memname">
225 <table class="memname"> 253 <tr>
226 <tr> 254 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a></td>
227 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code></td> 255 </tr>
228 </tr> 256 </table>
229 </table> 257 </td>
230 </div> 258 <td class="mlabels-right">
231 <div class="memdoc"> 259 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
232 260 </tr>
233 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 261 </table>
234 262 </div><div class="memdoc">
235 </div> 263
236 </div> 264 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00393">393</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
237 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 265
238 <div class="memitem"> 266 </div>
239 <div class="memproto"> 267 </div>
240 <table class="memname"> 268 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
241 <tr> 269 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
242 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code></td> 270
243 </tr> 271 <div class="memitem">
244 </table> 272 <div class="memproto">
245 </div> 273 <table class="mlabels">
246 <div class="memdoc"> 274 <tr>
247 275 <td class="mlabels-left">
248 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 276 <table class="memname">
249 277 <tr>
250 </div> 278 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></td>
251 </div> 279 </tr>
252 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 280 </table>
253 <div class="memitem"> 281 </td>
254 <div class="memproto"> 282 <td class="mlabels-right">
255 <table class="memname"> 283 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
256 <tr> 284 </tr>
257 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code></td> 285 </table>
258 </tr> 286 </div><div class="memdoc">
259 </table> 287
260 </div> 288 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00395">395</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
261 <div class="memdoc"> 289
262 290 </div>
263 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 291 </div>
264 292 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
265 </div> 293 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
266 </div> 294
267 <hr/><h2>Member Enumeration Documentation</h2> 295 <div class="memitem">
268 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 296 <div class="memproto">
269 <div class="memitem"> 297 <table class="mlabels">
270 <div class="memproto"> 298 <tr>
271 <table class="memname"> 299 <td class="mlabels-left">
272 <tr> 300 <table class="memname">
273 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 301 <tr>
274 </tr> 302 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td>
275 </table> 303 </tr>
276 </div> 304 </table>
277 <div class="memdoc"> 305 </td>
278 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 306 <td class="mlabels-right">
279 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 307 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
280 </td></tr> 308 </tr>
281 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 309 </table>
282 </td></tr> 310 </div><div class="memdoc">
283 </table> 311
284 </dd> 312 <p class="definition">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>
285 </dl> 313
286 314 </div>
287 <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> 315 </div>
288 316 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
289 </div> 317 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
290 </div> 318
291 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 319 <div class="memitem">
292 <a class="anchor" id="a1276bcfcbe1414b33eeefbd7b2b702fe"></a> 320 <div class="memproto">
293 <div class="memitem"> 321 <table class="mlabels">
294 <div class="memproto"> 322 <tr>
295 <table class="memname"> 323 <td class="mlabels-left">
296 <tr> 324 <table class="memname">
297 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a1276bcfcbe1414b33eeefbd7b2b702fe">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter</a> </td> 325 <tr>
326 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
327 </tr>
328 </table>
329 </td>
330 <td class="mlabels-right">
331 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
332 </tr>
333 </table>
334 </div><div class="memdoc">
335
336 <p class="definition">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>
337
338 </div>
339 </div>
340 <h2 class="groupheader">Member Enumeration Documentation</h2>
341 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
342 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
343
344 <div class="memitem">
345 <div class="memproto">
346 <table class="mlabels">
347 <tr>
348 <td class="mlabels-left">
349 <table class="memname">
350 <tr>
351 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
352 </tr>
353 </table>
354 </td>
355 <td class="mlabels-right">
356 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
357 </tr>
358 </table>
359 </div><div class="memdoc">
360 <table class="fieldtable">
361 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
362 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
363 </table>
364
365 <p class="definition">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>
366
367 </div>
368 </div>
369 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
370 <a id="a1276bcfcbe1414b33eeefbd7b2b702fe"></a>
371 <h2 class="memtitle"><span class="permalink"><a href="#a1276bcfcbe1414b33eeefbd7b2b702fe">&#9670;&nbsp;</a></span>PluginBufferingAdapter()</h2>
372
373 <div class="memitem">
374 <div class="memproto">
375 <table class="memname">
376 <tr>
377 <td class="memname">Vamp::HostExt::PluginBufferingAdapter::PluginBufferingAdapter </td>
298 <td>(</td> 378 <td>(</td>
299 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td> 379 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
300 <td class="paramname"><em>plugin</em></td><td>)</td> 380 <td class="paramname"><em>plugin</em></td><td>)</td>
301 <td></td> 381 <td></td>
302 </tr> 382 </tr>
303 </table> 383 </table>
304 </div> 384 </div><div class="memdoc">
305 <div class="memdoc">
306 385
307 <p>Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. </p> 386 <p>Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an...">PluginBufferingAdapter</a> wrapping the given plugin. </p>
308 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p> 387 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p>
309 388
310 </div> 389 </div>
311 </div> 390 </div>
312 <a class="anchor" id="a96263f7b0910a10eeae86f20db007e55"></a> 391 <a id="a96263f7b0910a10eeae86f20db007e55"></a>
313 <div class="memitem"> 392 <h2 class="memtitle"><span class="permalink"><a href="#a96263f7b0910a10eeae86f20db007e55">&#9670;&nbsp;</a></span>~PluginBufferingAdapter()</h2>
314 <div class="memproto"> 393
315 <table class="memname"> 394 <div class="memitem">
316 <tr> 395 <div class="memproto">
317 <td class="memname">virtual <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a96263f7b0910a10eeae86f20db007e55">Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter</a> </td> 396 <table class="mlabels">
318 <td>(</td> 397 <tr>
319 <td class="paramname"></td><td>)</td> 398 <td class="mlabels-left">
320 <td><code> [virtual]</code></td> 399 <table class="memname">
321 </tr> 400 <tr>
322 </table> 401 <td class="memname">virtual Vamp::HostExt::PluginBufferingAdapter::~PluginBufferingAdapter </td>
323 </div> 402 <td>(</td>
324 <div class="memdoc"> 403 <td class="paramname"></td><td>)</td>
325 404 <td></td>
326 </div> 405 </tr>
327 </div> 406 </table>
328 <hr/><h2>Member Function Documentation</h2> 407 </td>
329 <a class="anchor" id="a2e66d009df69c951001e5d2786973d60"></a> 408 <td class="mlabels-right">
330 <div class="memitem"> 409 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
331 <div class="memproto"> 410 </tr>
332 <table class="memname"> 411 </table>
333 <tr> 412 </div><div class="memdoc">
334 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize</a> </td> 413
335 <td>(</td> 414 </div>
336 <td class="paramname"></td><td>)</td> 415 </div>
337 <td> const<code> [virtual]</code></td> 416 <h2 class="groupheader">Member Function Documentation</h2>
338 </tr> 417 <a id="acb6b82c61ebac4610a8b92f94cd50682"></a>
339 </table> 418 <h2 class="memtitle"><span class="permalink"><a href="#acb6b82c61ebac4610a8b92f94cd50682">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
340 </div> 419
341 <div class="memdoc"> 420 <div class="memitem">
421 <div class="memproto">
422 <table class="mlabels">
423 <tr>
424 <td class="mlabels-left">
425 <table class="memname">
426 <tr>
427 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredStepSize </td>
428 <td>(</td>
429 <td class="paramname"></td><td>)</td>
430 <td> const</td>
431 </tr>
432 </table>
433 </td>
434 <td class="mlabels-right">
435 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
436 </tr>
437 </table>
438 </div><div class="memdoc">
342 439
343 <p>Return the preferred step size for this adapter. </p> 440 <p>Return the preferred step size for this adapter. </p>
344 <p>Because of the way this adapter works, its preferred step size will always be the same as its preferred block size. This may or may not be the same as the preferred step size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02" title="Return the preferred step size of the plugin wrapped by this adapter.">getPluginPreferredStepSize()</a>. </p> 441 <p>Because of the way this adapter works, its preferred step size will always be the same as its preferred block size. This may or may not be the same as the preferred step size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa9a614ee2900ce22039af9ca43c11b81" title="Return the preferred step size of the plugin wrapped by this adapter. ">getPluginPreferredStepSize()</a>. </p>
345 442
346 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>.</p> 443 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin</a>.</p>
347 444
348 </div> 445 </div>
349 </div> 446 </div>
350 <a class="anchor" id="a21e45180b19873f9ab69fe7a4e184a03"></a> 447 <a id="a39dd1770dd0a737ff295d70082d86fd3"></a>
351 <div class="memitem"> 448 <h2 class="memtitle"><span class="permalink"><a href="#a39dd1770dd0a737ff295d70082d86fd3">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
352 <div class="memproto"> 449
353 <table class="memname"> 450 <div class="memitem">
354 <tr> 451 <div class="memproto">
355 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize</a> </td> 452 <table class="mlabels">
356 <td>(</td> 453 <tr>
357 <td class="paramname"></td><td>)</td> 454 <td class="mlabels-left">
358 <td> const<code> [virtual]</code></td> 455 <table class="memname">
359 </tr> 456 <tr>
360 </table> 457 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPreferredBlockSize </td>
361 </div> 458 <td>(</td>
362 <div class="memdoc"> 459 <td class="paramname"></td><td>)</td>
460 <td> const</td>
461 </tr>
462 </table>
463 </td>
464 <td class="mlabels-right">
465 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
466 </tr>
467 </table>
468 </div><div class="memdoc">
363 469
364 <p>Return the preferred block size for this adapter. </p> 470 <p>Return the preferred block size for this adapter. </p>
365 <p>This may or may not be the same as the preferred block size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0" title="Return the preferred block size of the plugin wrapped by this adapter.">getPluginPreferredBlockSize()</a>.</p> 471 <p>This may or may not be the same as the preferred block size of the underlying plugin, which may be obtained by calling <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad8506e594c7aeb275ccfbbf21c4c3c40" title="Return the preferred block size of the plugin wrapped by this adapter. ">getPluginPreferredBlockSize()</a>.</p>
366 <p>Note that this adapter may be initialised with any block size, not just its supposedly preferred one. </p> 472 <p>Note that this adapter may be initialised with any block size, not just its supposedly preferred one. </p>
367 473
368 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>.</p> 474 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin</a>.</p>
369 475
370 </div> 476 </div>
371 </div> 477 </div>
372 <a class="anchor" id="a9e7798ba4d7870db46502ab541ab37a8"></a> 478 <a id="a9e7798ba4d7870db46502ab541ab37a8"></a>
373 <div class="memitem"> 479 <h2 class="memtitle"><span class="permalink"><a href="#a9e7798ba4d7870db46502ab541ab37a8">&#9670;&nbsp;</a></span>initialise()</h2>
374 <div class="memproto"> 480
375 <table class="memname"> 481 <div class="memitem">
376 <tr> 482 <div class="memproto">
377 <td class="memname">bool <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter::initialise</a> </td> 483 <table class="mlabels">
484 <tr>
485 <td class="mlabels-left">
486 <table class="memname">
487 <tr>
488 <td class="memname">bool Vamp::HostExt::PluginBufferingAdapter::initialise </td>
378 <td>(</td> 489 <td>(</td>
379 <td class="paramtype">size_t&#160;</td> 490 <td class="paramtype">size_t&#160;</td>
380 <td class="paramname"><em>channels</em>, </td> 491 <td class="paramname"><em>channels</em>, </td>
381 </tr> 492 </tr>
382 <tr> 493 <tr>
392 <td class="paramname"><em>blockSize</em>&#160;</td> 503 <td class="paramname"><em>blockSize</em>&#160;</td>
393 </tr> 504 </tr>
394 <tr> 505 <tr>
395 <td></td> 506 <td></td>
396 <td>)</td> 507 <td>)</td>
397 <td></td><td><code> [virtual]</code></td> 508 <td></td><td></td>
398 </tr> 509 </tr>
399 </table> 510 </table>
400 </div> 511 </td>
401 <div class="memdoc"> 512 <td class="mlabels-right">
513 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
514 </tr>
515 </table>
516 </div><div class="memdoc">
402 517
403 <p>Initialise the adapter (and therefore the plugin) for the given number of channels. </p> 518 <p>Initialise the adapter (and therefore the plugin) for the given number of channels. </p>
404 <p>Initialise the adapter for the given step and block size, which must be equal.</p> 519 <p>Initialise the adapter for the given step and block size, which must be equal.</p>
405 <p>The step and block size used for the underlying plugin will depend on its preferences, or any values previously passed to setPluginStepSize and setPluginBlockSize. </p> 520 <p>The step and block size used for the underlying plugin will depend on its preferences, or any values previously passed to setPluginStepSize and setPluginBlockSize. </p>
406 521
407 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> 522 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
408 523
409 </div> 524 </div>
410 </div> 525 </div>
411 <a class="anchor" id="ad7fad500331808b5cdf90f5a45019b02"></a> 526 <a id="aa9a614ee2900ce22039af9ca43c11b81"></a>
412 <div class="memitem"> 527 <h2 class="memtitle"><span class="permalink"><a href="#aa9a614ee2900ce22039af9ca43c11b81">&#9670;&nbsp;</a></span>getPluginPreferredStepSize()</h2>
413 <div class="memproto"> 528
414 <table class="memname"> 529 <div class="memitem">
415 <tr> 530 <div class="memproto">
416 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ad7fad500331808b5cdf90f5a45019b02">Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize</a> </td> 531 <table class="memname">
417 <td>(</td> 532 <tr>
418 <td class="paramname"></td><td>)</td> 533 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredStepSize </td>
419 <td> const</td> 534 <td>(</td>
420 </tr> 535 <td class="paramname"></td><td>)</td>
421 </table> 536 <td> const</td>
422 </div> 537 </tr>
423 <div class="memdoc"> 538 </table>
539 </div><div class="memdoc">
424 540
425 <p>Return the preferred step size of the plugin wrapped by this adapter. </p> 541 <p>Return the preferred step size of the plugin wrapped by this adapter. </p>
426 <p>This is included mainly for informational purposes. This value is not likely to be a valid step size for the adapter itself, and it is not usually of any use in interpreting the results (because the adapter re-writes OneSamplePerStep outputs to FixedSampleRate so that the hop size no longer needs to be known beforehand in order to interpret them). </p> 542 <p>This is included mainly for informational purposes. This value is not likely to be a valid step size for the adapter itself, and it is not usually of any use in interpreting the results (because the adapter re-writes OneSamplePerStep outputs to FixedSampleRate so that the hop size no longer needs to be known beforehand in order to interpret them). </p>
427 543
428 </div> 544 </div>
429 </div> 545 </div>
430 <a class="anchor" id="a7045be875de9dd226d2e2a222e957de0"></a> 546 <a id="ad8506e594c7aeb275ccfbbf21c4c3c40"></a>
431 <div class="memitem"> 547 <h2 class="memtitle"><span class="permalink"><a href="#ad8506e594c7aeb275ccfbbf21c4c3c40">&#9670;&nbsp;</a></span>getPluginPreferredBlockSize()</h2>
432 <div class="memproto"> 548
433 <table class="memname"> 549 <div class="memitem">
434 <tr> 550 <div class="memproto">
435 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7045be875de9dd226d2e2a222e957de0">Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize</a> </td> 551 <table class="memname">
436 <td>(</td> 552 <tr>
437 <td class="paramname"></td><td>)</td> 553 <td class="memname">size_t Vamp::HostExt::PluginBufferingAdapter::getPluginPreferredBlockSize </td>
438 <td> const</td> 554 <td>(</td>
439 </tr> 555 <td class="paramname"></td><td>)</td>
440 </table> 556 <td> const</td>
441 </div> 557 </tr>
442 <div class="memdoc"> 558 </table>
559 </div><div class="memdoc">
443 560
444 <p>Return the preferred block size of the plugin wrapped by this adapter. </p> 561 <p>Return the preferred block size of the plugin wrapped by this adapter. </p>
445 <p>This is included mainly for informational purposes. </p> 562 <p>This is included mainly for informational purposes. </p>
446 563
447 </div> 564 </div>
448 </div> 565 </div>
449 <a class="anchor" id="ac99898d78a01a7fad4def4d6c5fd3a7e"></a> 566 <a id="ac99898d78a01a7fad4def4d6c5fd3a7e"></a>
450 <div class="memitem"> 567 <h2 class="memtitle"><span class="permalink"><a href="#ac99898d78a01a7fad4def4d6c5fd3a7e">&#9670;&nbsp;</a></span>setPluginStepSize()</h2>
451 <div class="memproto"> 568
452 <table class="memname"> 569 <div class="memitem">
453 <tr> 570 <div class="memproto">
454 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#ac99898d78a01a7fad4def4d6c5fd3a7e">Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize</a> </td> 571 <table class="memname">
572 <tr>
573 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginStepSize </td>
455 <td>(</td> 574 <td>(</td>
456 <td class="paramtype">size_t&#160;</td> 575 <td class="paramtype">size_t&#160;</td>
457 <td class="paramname"><em>stepSize</em></td><td>)</td> 576 <td class="paramname"><em>stepSize</em></td><td>)</td>
458 <td></td> 577 <td></td>
459 </tr> 578 </tr>
460 </table> 579 </table>
461 </div> 580 </div><div class="memdoc">
462 <div class="memdoc"> 581
463 582 <p>Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a> is called. </p>
464 <p>Set the step size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. </p> 583 <p>If this is not set, the plugin's own preferred step size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a>. </p>
465 <p>If this is not set, the plugin's own preferred step size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>. </p> 584
466 585 </div>
467 </div> 586 </div>
468 </div> 587 <a id="aa80ae1bff6f95e805811df2c3770a98c"></a>
469 <a class="anchor" id="aa80ae1bff6f95e805811df2c3770a98c"></a> 588 <h2 class="memtitle"><span class="permalink"><a href="#aa80ae1bff6f95e805811df2c3770a98c">&#9670;&nbsp;</a></span>setPluginBlockSize()</h2>
470 <div class="memitem"> 589
471 <div class="memproto"> 590 <div class="memitem">
472 <table class="memname"> 591 <div class="memproto">
473 <tr> 592 <table class="memname">
474 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa80ae1bff6f95e805811df2c3770a98c">Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize</a> </td> 593 <tr>
594 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setPluginBlockSize </td>
475 <td>(</td> 595 <td>(</td>
476 <td class="paramtype">size_t&#160;</td> 596 <td class="paramtype">size_t&#160;</td>
477 <td class="paramname"><em>blockSize</em></td><td>)</td> 597 <td class="paramname"><em>blockSize</em></td><td>)</td>
478 <td></td> 598 <td></td>
479 </tr> 599 </tr>
480 </table> 600 </table>
481 </div> 601 </div><div class="memdoc">
482 <div class="memdoc"> 602
483 603 <p>Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a> is called. </p>
484 <p>Set the block size that will be used for the underlying plugin when <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> is called. </p> 604 <p>If this is not set, the plugin's own preferred block size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a>. </p>
485 <p>If this is not set, the plugin's own preferred block size will be used. You will not usually need to call this function. If you do call it, it must be before the first call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>. </p> 605
486 606 </div>
487 </div> 607 </div>
488 </div> 608 <a id="aa065985fd864f6869d1bc7fea6fa2ece"></a>
489 <a class="anchor" id="aa065985fd864f6869d1bc7fea6fa2ece"></a> 609 <h2 class="memtitle"><span class="permalink"><a href="#aa065985fd864f6869d1bc7fea6fa2ece">&#9670;&nbsp;</a></span>getActualStepAndBlockSizes()</h2>
490 <div class="memitem"> 610
491 <div class="memproto"> 611 <div class="memitem">
492 <table class="memname"> 612 <div class="memproto">
493 <tr> 613 <table class="memname">
494 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#aa065985fd864f6869d1bc7fea6fa2ece">Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes</a> </td> 614 <tr>
615 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::getActualStepAndBlockSizes </td>
495 <td>(</td> 616 <td>(</td>
496 <td class="paramtype">size_t &amp;&#160;</td> 617 <td class="paramtype">size_t &amp;&#160;</td>
497 <td class="paramname"><em>stepSize</em>, </td> 618 <td class="paramname"><em>stepSize</em>, </td>
498 </tr> 619 </tr>
499 <tr> 620 <tr>
506 <td></td> 627 <td></td>
507 <td>)</td> 628 <td>)</td>
508 <td></td><td></td> 629 <td></td><td></td>
509 </tr> 630 </tr>
510 </table> 631 </table>
511 </div> 632 </div><div class="memdoc">
512 <div class="memdoc">
513 633
514 <p>Return the step and block sizes that were actually used when initialising the underlying plugin. </p> 634 <p>Return the step and block sizes that were actually used when initialising the underlying plugin. </p>
515 <p>This is included mainly for informational purposes. You will not usually need to call this function. If this is called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>, it will return 0 for both values. If it is called after a failed call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a>, it will return the values that were used in the failed call to the plugin's <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels.">initialise()</a> function. </p> 635 <p>This is included mainly for informational purposes. You will not usually need to call this function. If this is called before <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a>, it will return 0 for both values. If it is called after a failed call to <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a>, it will return the values that were used in the failed call to the plugin's <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8" title="Initialise the adapter (and therefore the plugin) for the given number of channels. ">initialise()</a> function. </p>
516 636
517 </div> 637 </div>
518 </div> 638 </div>
519 <a class="anchor" id="a7a979b20c169d37adbd7b7d8b8a077b3"></a> 639 <a id="a7a979b20c169d37adbd7b7d8b8a077b3"></a>
520 <div class="memitem"> 640 <h2 class="memtitle"><span class="permalink"><a href="#a7a979b20c169d37adbd7b7d8b8a077b3">&#9670;&nbsp;</a></span>setParameter()</h2>
521 <div class="memproto"> 641
522 <table class="memname"> 642 <div class="memitem">
523 <tr> 643 <div class="memproto">
524 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter::setParameter</a> </td> 644 <table class="mlabels">
645 <tr>
646 <td class="mlabels-left">
647 <table class="memname">
648 <tr>
649 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::setParameter </td>
525 <td>(</td> 650 <td>(</td>
526 <td class="paramtype">std::string&#160;</td> 651 <td class="paramtype">std::string&#160;</td>
527 <td class="paramname">, </td> 652 <td class="paramname">, </td>
528 </tr> 653 </tr>
529 <tr> 654 <tr>
533 <td class="paramname">&#160;</td> 658 <td class="paramname">&#160;</td>
534 </tr> 659 </tr>
535 <tr> 660 <tr>
536 <td></td> 661 <td></td>
537 <td>)</td> 662 <td>)</td>
538 <td></td><td><code> [virtual]</code></td> 663 <td></td><td></td>
539 </tr> 664 </tr>
540 </table> 665 </table>
541 </div> 666 </td>
542 <div class="memdoc"> 667 <td class="mlabels-right">
668 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
669 </tr>
670 </table>
671 </div><div class="memdoc">
543 672
544 <p>Set a named parameter. </p> 673 <p>Set a named parameter. </p>
545 <p>The first argument is the identifier field from that parameter's descriptor. </p> 674 <p>The first argument is the identifier field from that parameter's descriptor. </p>
546 675
547 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>.</p> 676 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
548 677
549 </div> 678 </div>
550 </div> 679 </div>
551 <a class="anchor" id="a3cc7000e0aff525950e0a286b87f8927"></a> 680 <a id="a3cc7000e0aff525950e0a286b87f8927"></a>
552 <div class="memitem"> 681 <h2 class="memtitle"><span class="permalink"><a href="#a3cc7000e0aff525950e0a286b87f8927">&#9670;&nbsp;</a></span>selectProgram()</h2>
553 <div class="memproto"> 682
554 <table class="memname"> 683 <div class="memitem">
555 <tr> 684 <div class="memproto">
556 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter::selectProgram</a> </td> 685 <table class="mlabels">
686 <tr>
687 <td class="mlabels-left">
688 <table class="memname">
689 <tr>
690 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::selectProgram </td>
557 <td>(</td> 691 <td>(</td>
558 <td class="paramtype">std::string&#160;</td> 692 <td class="paramtype">std::string&#160;</td>
559 <td class="paramname"></td><td>)</td> 693 <td class="paramname"></td><td>)</td>
560 <td><code> [virtual]</code></td> 694 <td></td>
561 </tr> 695 </tr>
562 </table> 696 </table>
563 </div> 697 </td>
564 <div class="memdoc"> 698 <td class="mlabels-right">
699 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
700 </tr>
701 </table>
702 </div><div class="memdoc">
565 703
566 <p>Select a program. </p> 704 <p>Select a program. </p>
567 <p>(If the given program name is not one of the available programs, do nothing.) </p> 705 <p>(If the given program name is not one of the available programs, do nothing.) </p>
568 706
569 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> 707 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
570 708
571 </div> 709 </div>
572 </div> 710 </div>
573 <a class="anchor" id="af8cc914897a284433de220f1153f3845"></a> 711 <a id="ac17520cdd29a57d320ca65066ec2636c"></a>
574 <div class="memitem"> 712 <h2 class="memtitle"><span class="permalink"><a href="#ac17520cdd29a57d320ca65066ec2636c">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
575 <div class="memproto"> 713
576 <table class="memname"> 714 <div class="memitem">
577 <tr> 715 <div class="memproto">
578 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors</a> </td> 716 <table class="mlabels">
579 <td>(</td> 717 <tr>
580 <td class="paramname"></td><td>)</td> 718 <td class="mlabels-left">
581 <td> const<code> [virtual]</code></td> 719 <table class="memname">
582 </tr> 720 <tr>
583 </table> 721 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginBufferingAdapter::getOutputDescriptors </td>
584 </div> 722 <td>(</td>
585 <div class="memdoc"> 723 <td class="paramname"></td><td>)</td>
724 <td> const</td>
725 </tr>
726 </table>
727 </td>
728 <td class="mlabels-right">
729 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
730 </tr>
731 </table>
732 </div><div class="memdoc">
586 733
587 <p>Get the outputs of this plugin. </p> 734 <p>Get the outputs of this plugin. </p>
588 <p>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_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0" title="Process a single block of input data.">process()</a> call. </p> 735 <p>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_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0" title="Process a single block of input data. ">process()</a> call. </p>
589 736
590 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper</a>.</p> 737 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
591 738
592 </div> 739 </div>
593 </div> 740 </div>
594 <a class="anchor" id="a131fd9fe8a1795d7370d8a721176868a"></a> 741 <a id="a131fd9fe8a1795d7370d8a721176868a"></a>
595 <div class="memitem"> 742 <h2 class="memtitle"><span class="permalink"><a href="#a131fd9fe8a1795d7370d8a721176868a">&#9670;&nbsp;</a></span>reset()</h2>
596 <div class="memproto"> 743
597 <table class="memname"> 744 <div class="memitem">
598 <tr> 745 <div class="memproto">
599 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter::reset</a> </td> 746 <table class="mlabels">
600 <td>(</td> 747 <tr>
601 <td class="paramname"></td><td>)</td> 748 <td class="mlabels-left">
602 <td><code> [virtual]</code></td> 749 <table class="memname">
603 </tr> 750 <tr>
604 </table> 751 <td class="memname">void Vamp::HostExt::PluginBufferingAdapter::reset </td>
605 </div> 752 <td>(</td>
606 <div class="memdoc"> 753 <td class="paramname"></td><td>)</td>
754 <td></td>
755 </tr>
756 </table>
757 </td>
758 <td class="mlabels-right">
759 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
760 </tr>
761 </table>
762 </div><div class="memdoc">
607 763
608 <p>Reset the plugin after use, to prepare it for another clean run. </p> 764 <p>Reset the plugin after use, to prepare it for another clean run. </p>
609 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 765 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
610 766
611 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> 767 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
612 768
613 </div> 769 </div>
614 </div> 770 </div>
615 <a class="anchor" id="a55058a20c1f8bffc0dc927350df778a0"></a> 771 <a id="a55058a20c1f8bffc0dc927350df778a0"></a>
616 <div class="memitem"> 772 <h2 class="memtitle"><span class="permalink"><a href="#a55058a20c1f8bffc0dc927350df778a0">&#9670;&nbsp;</a></span>process()</h2>
617 <div class="memproto"> 773
618 <table class="memname"> 774 <div class="memitem">
619 <tr> 775 <div class="memproto">
620 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter::process</a> </td> 776 <table class="mlabels">
777 <tr>
778 <td class="mlabels-left">
779 <table class="memname">
780 <tr>
781 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::process </td>
621 <td>(</td> 782 <td>(</td>
622 <td class="paramtype">const float *const *&#160;</td> 783 <td class="paramtype">const float *const *&#160;</td>
623 <td class="paramname"><em>inputBuffers</em>, </td> 784 <td class="paramname"><em>inputBuffers</em>, </td>
624 </tr> 785 </tr>
625 <tr> 786 <tr>
629 <td class="paramname"><em>timestamp</em>&#160;</td> 790 <td class="paramname"><em>timestamp</em>&#160;</td>
630 </tr> 791 </tr>
631 <tr> 792 <tr>
632 <td></td> 793 <td></td>
633 <td>)</td> 794 <td>)</td>
634 <td></td><td><code> [virtual]</code></td> 795 <td></td><td></td>
635 </tr> 796 </tr>
636 </table> 797 </table>
637 </div> 798 </td>
638 <div class="memdoc"> 799 <td class="mlabels-right">
800 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
801 </tr>
802 </table>
803 </div><div class="memdoc">
639 804
640 <p>Process a single block of input data. </p> 805 <p>Process a single block of input data. </p>
641 <p>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> 806 <p>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>
642 <p>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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p> 807 <p>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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> 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 <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
643 <p>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.) </p> 808 <p>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.) </p>
644 809
645 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p> 810 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
646 811
647 </div> 812 </div>
648 </div> 813 </div>
649 <a class="anchor" id="a28423951b2eda1a1fc371485434f417b"></a> 814 <a id="a28423951b2eda1a1fc371485434f417b"></a>
650 <div class="memitem"> 815 <h2 class="memtitle"><span class="permalink"><a href="#a28423951b2eda1a1fc371485434f417b">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
651 <div class="memproto"> 816
652 <table class="memname"> 817 <div class="memitem">
653 <tr> 818 <div class="memproto">
654 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures</a> </td> 819 <table class="mlabels">
655 <td>(</td> 820 <tr>
656 <td class="paramname"></td><td>)</td> 821 <td class="mlabels-left">
657 <td><code> [virtual]</code></td> 822 <table class="memname">
658 </tr> 823 <tr>
659 </table> 824 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginBufferingAdapter::getRemainingFeatures </td>
660 </div> 825 <td>(</td>
661 <div class="memdoc"> 826 <td class="paramname"></td><td>)</td>
827 <td></td>
828 </tr>
829 </table>
830 </td>
831 <td class="mlabels-right">
832 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
833 </tr>
834 </table>
835 </div><div class="memdoc">
662 836
663 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 837 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
664 838
665 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p> 839 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
666 840
667 </div> 841 </div>
668 </div> 842 </div>
669 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a> 843 <a id="a8838facfe9d88cf36b13c1b42165fc6d"></a>
670 <div class="memitem"> 844 <h2 class="memtitle"><span class="permalink"><a href="#a8838facfe9d88cf36b13c1b42165fc6d">&#9670;&nbsp;</a></span>getInputDomain()</h2>
671 <div class="memproto"> 845
672 <table class="memname"> 846 <div class="memitem">
673 <tr> 847 <div class="memproto">
674 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae203faf8384c9e1fddc381409aa8a214">Vamp::HostExt::PluginWrapper::getInputDomain</a> </td> 848 <table class="mlabels">
675 <td>(</td> 849 <tr>
676 <td class="paramname"></td><td>)</td> 850 <td class="mlabels-left">
677 <td> const<code> [virtual, inherited]</code></td> 851 <table class="memname">
678 </tr> 852 <tr>
679 </table> 853 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
680 </div> 854 <td>(</td>
681 <div class="memdoc"> 855 <td class="paramname"></td><td>)</td>
856 <td> const</td>
857 </tr>
858 </table>
859 </td>
860 <td class="mlabels-right">
861 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
862 </tr>
863 </table>
864 </div><div class="memdoc">
682 865
683 <p>Get the plugin's required input domain. </p> 866 <p>Get the plugin's required input domain. </p>
684 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" 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.</p> 867 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0" 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.</p>
685 <p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> 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#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> will be rotated so as to place the origin in the centre of the block. 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. </p> 868 <p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> 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_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0" title="Process a single block of input data. ">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type &ndash; the host will either let the user do so, or will use a Hanning window. </p>
686 869
687 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 870 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
688 871
689 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 872 </div>
690 873 </div>
691 </div> 874 <a id="afa79272f991fb720ddd09784be1b3cb8"></a>
692 </div> 875 <h2 class="memtitle"><span class="permalink"><a href="#afa79272f991fb720ddd09784be1b3cb8">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
693 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a> 876
694 <div class="memitem"> 877 <div class="memitem">
695 <div class="memproto"> 878 <div class="memproto">
696 <table class="memname"> 879 <table class="mlabels">
697 <tr> 880 <tr>
698 <td class="memname">unsigned int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper::getVampApiVersion</a> </td> 881 <td class="mlabels-left">
699 <td>(</td> 882 <table class="memname">
700 <td class="paramname"></td><td>)</td> 883 <tr>
701 <td> const<code> [virtual, inherited]</code></td> 884 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
702 </tr> 885 <td>(</td>
703 </table> 886 <td class="paramname"></td><td>)</td>
704 </div> 887 <td> const</td>
705 <div class="memdoc"> 888 </tr>
889 </table>
890 </td>
891 <td class="mlabels-right">
892 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
893 </tr>
894 </table>
895 </div><div class="memdoc">
706 896
707 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 897 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
708 898
709 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 899 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">Vamp::PluginBase</a>.</p>
710 900
711 </div> 901 </div>
712 </div> 902 </div>
713 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a> 903 <a id="ad9312a38c199004c7bad0c42f590393f"></a>
714 <div class="memitem"> 904 <h2 class="memtitle"><span class="permalink"><a href="#ad9312a38c199004c7bad0c42f590393f">&#9670;&nbsp;</a></span>getIdentifier()</h2>
715 <div class="memproto"> 905
716 <table class="memname"> 906 <div class="memitem">
717 <tr> 907 <div class="memproto">
718 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper::getIdentifier</a> </td> 908 <table class="mlabels">
719 <td>(</td> 909 <tr>
720 <td class="paramname"></td><td>)</td> 910 <td class="mlabels-left">
721 <td> const<code> [virtual, inherited]</code></td> 911 <table class="memname">
722 </tr> 912 <tr>
723 </table> 913 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
724 </div> 914 <td>(</td>
725 <div class="memdoc"> 915 <td class="paramname"></td><td>)</td>
916 <td> const</td>
917 </tr>
918 </table>
919 </td>
920 <td class="mlabels-right">
921 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
922 </tr>
923 </table>
924 </div><div class="memdoc">
726 925
727 <p>Get the computer-usable name of the plugin. </p> 926 <p>Get the computer-usable name of the plugin. </p>
728 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p> 927 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
729 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p> 928 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
730 <p>Example: "zero_crossings" </p> 929 <p>Example: "zero_crossings" </p>
731 930
732 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 931 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
733 932
734 </div> 933 </div>
735 </div> 934 </div>
736 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a> 935 <a id="aa2b40de6e240d872997a63dd4a301ff3"></a>
737 <div class="memitem"> 936 <h2 class="memtitle"><span class="permalink"><a href="#aa2b40de6e240d872997a63dd4a301ff3">&#9670;&nbsp;</a></span>getName()</h2>
738 <div class="memproto"> 937
739 <table class="memname"> 938 <div class="memitem">
740 <tr> 939 <div class="memproto">
741 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper::getName</a> </td> 940 <table class="mlabels">
742 <td>(</td> 941 <tr>
743 <td class="paramname"></td><td>)</td> 942 <td class="mlabels-left">
744 <td> const<code> [virtual, inherited]</code></td> 943 <table class="memname">
745 </tr> 944 <tr>
746 </table> 945 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
747 </div> 946 <td>(</td>
748 <div class="memdoc"> 947 <td class="paramname"></td><td>)</td>
948 <td> const</td>
949 </tr>
950 </table>
951 </td>
952 <td class="mlabels-right">
953 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
954 </tr>
955 </table>
956 </div><div class="memdoc">
749 957
750 <p>Get a human-readable name or title of the plugin. </p> 958 <p>Get a human-readable name or title of the plugin. </p>
751 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p> 959 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
752 <p>Example: "Zero Crossings" </p> 960 <p>Example: "Zero Crossings" </p>
753 961
754 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 962 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
755 963
756 </div> 964 </div>
757 </div> 965 </div>
758 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a> 966 <a id="ad6e453c30b265a2daf243f953b35c815"></a>
759 <div class="memitem"> 967 <h2 class="memtitle"><span class="permalink"><a href="#ad6e453c30b265a2daf243f953b35c815">&#9670;&nbsp;</a></span>getDescription()</h2>
760 <div class="memproto"> 968
761 <table class="memname"> 969 <div class="memitem">
762 <tr> 970 <div class="memproto">
763 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper::getDescription</a> </td> 971 <table class="mlabels">
764 <td>(</td> 972 <tr>
765 <td class="paramname"></td><td>)</td> 973 <td class="mlabels-left">
766 <td> const<code> [virtual, inherited]</code></td> 974 <table class="memname">
767 </tr> 975 <tr>
768 </table> 976 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
769 </div> 977 <td>(</td>
770 <div class="memdoc"> 978 <td class="paramname"></td><td>)</td>
979 <td> const</td>
980 </tr>
981 </table>
982 </td>
983 <td class="mlabels-right">
984 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
985 </tr>
986 </table>
987 </div><div class="memdoc">
771 988
772 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p> 989 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
773 <p>May be empty if the name has said it all already.</p> 990 <p>May be empty if the name has said it all already.</p>
774 <p>Example: "Detect and count zero crossing points" </p> 991 <p>Example: "Detect and count zero crossing points" </p>
775 992
776 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 993 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
777 994
778 </div> 995 </div>
779 </div> 996 </div>
780 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a> 997 <a id="af9b2f01063828ef0745dc2623fc8dd42"></a>
781 <div class="memitem"> 998 <h2 class="memtitle"><span class="permalink"><a href="#af9b2f01063828ef0745dc2623fc8dd42">&#9670;&nbsp;</a></span>getMaker()</h2>
782 <div class="memproto"> 999
783 <table class="memname"> 1000 <div class="memitem">
784 <tr> 1001 <div class="memproto">
785 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper::getMaker</a> </td> 1002 <table class="mlabels">
786 <td>(</td> 1003 <tr>
787 <td class="paramname"></td><td>)</td> 1004 <td class="mlabels-left">
788 <td> const<code> [virtual, inherited]</code></td> 1005 <table class="memname">
789 </tr> 1006 <tr>
790 </table> 1007 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
791 </div> 1008 <td>(</td>
792 <div class="memdoc"> 1009 <td class="paramname"></td><td>)</td>
1010 <td> const</td>
1011 </tr>
1012 </table>
1013 </td>
1014 <td class="mlabels-right">
1015 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1016 </tr>
1017 </table>
1018 </div><div class="memdoc">
793 1019
794 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 1020 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
795 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p> 1021 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
796 1022
797 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 1023 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
798 1024
799 </div> 1025 </div>
800 </div> 1026 </div>
801 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a> 1027 <a id="a9537de27c826a1441b2d3643df4880bb"></a>
802 <div class="memitem"> 1028 <h2 class="memtitle"><span class="permalink"><a href="#a9537de27c826a1441b2d3643df4880bb">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
803 <div class="memproto"> 1029
804 <table class="memname"> 1030 <div class="memitem">
805 <tr> 1031 <div class="memproto">
806 <td class="memname">int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper::getPluginVersion</a> </td> 1032 <table class="mlabels">
807 <td>(</td> 1033 <tr>
808 <td class="paramname"></td><td>)</td> 1034 <td class="mlabels-left">
809 <td> const<code> [virtual, inherited]</code></td> 1035 <table class="memname">
810 </tr> 1036 <tr>
811 </table> 1037 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
812 </div> 1038 <td>(</td>
813 <div class="memdoc"> 1039 <td class="paramname"></td><td>)</td>
1040 <td> const</td>
1041 </tr>
1042 </table>
1043 </td>
1044 <td class="mlabels-right">
1045 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1046 </tr>
1047 </table>
1048 </div><div class="memdoc">
814 1049
815 <p>Get the version number of the plugin. </p> 1050 <p>Get the version number of the plugin. </p>
816 1051
817 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 1052 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
818 1053
819 </div> 1054 </div>
820 </div> 1055 </div>
821 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a> 1056 <a id="aea9c238f86de65d3380fa887bb9e47e6"></a>
822 <div class="memitem"> 1057 <h2 class="memtitle"><span class="permalink"><a href="#aea9c238f86de65d3380fa887bb9e47e6">&#9670;&nbsp;</a></span>getCopyright()</h2>
823 <div class="memproto"> 1058
824 <table class="memname"> 1059 <div class="memitem">
825 <tr> 1060 <div class="memproto">
826 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper::getCopyright</a> </td> 1061 <table class="mlabels">
827 <td>(</td> 1062 <tr>
828 <td class="paramname"></td><td>)</td> 1063 <td class="mlabels-left">
829 <td> const<code> [virtual, inherited]</code></td> 1064 <table class="memname">
830 </tr> 1065 <tr>
831 </table> 1066 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
832 </div> 1067 <td>(</td>
833 <div class="memdoc"> 1068 <td class="paramname"></td><td>)</td>
1069 <td> const</td>
1070 </tr>
1071 </table>
1072 </td>
1073 <td class="mlabels-right">
1074 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1075 </tr>
1076 </table>
1077 </div><div class="memdoc">
834 1078
835 <p>Get the copyright statement or licensing summary for the plugin. </p> 1079 <p>Get the copyright statement or licensing summary for the plugin. </p>
836 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 1080 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
837 1081
838 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 1082 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
839 1083
840 </div> 1084 </div>
841 </div> 1085 </div>
842 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a> 1086 <a id="ab2b67205d86e921cb0a9bd1f819d2cf9"></a>
843 <div class="memitem"> 1087 <h2 class="memtitle"><span class="permalink"><a href="#ab2b67205d86e921cb0a9bd1f819d2cf9">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
844 <div class="memproto"> 1088
845 <table class="memname"> 1089 <div class="memitem">
846 <tr> 1090 <div class="memproto">
847 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper::getParameterDescriptors</a> </td> 1091 <table class="mlabels">
848 <td>(</td> 1092 <tr>
849 <td class="paramname"></td><td>)</td> 1093 <td class="mlabels-left">
850 <td> const<code> [virtual, inherited]</code></td> 1094 <table class="memname">
851 </tr> 1095 <tr>
852 </table> 1096 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
853 </div> 1097 <td>(</td>
854 <div class="memdoc"> 1098 <td class="paramname"></td><td>)</td>
1099 <td> const</td>
1100 </tr>
1101 </table>
1102 </td>
1103 <td class="mlabels-right">
1104 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1105 </tr>
1106 </table>
1107 </div><div class="memdoc">
855 1108
856 <p>Get the controllable parameters of this plugin. </p> 1109 <p>Get the controllable parameters of this plugin. </p>
857 1110
858 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 1111 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
859 1112
860 </div> 1113 </div>
861 </div> 1114 </div>
862 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a> 1115 <a id="a5c0a4d72a25fded51829de21771de521"></a>
863 <div class="memitem"> 1116 <h2 class="memtitle"><span class="permalink"><a href="#a5c0a4d72a25fded51829de21771de521">&#9670;&nbsp;</a></span>getParameter()</h2>
864 <div class="memproto"> 1117
865 <table class="memname"> 1118 <div class="memitem">
866 <tr> 1119 <div class="memproto">
867 <td class="memname">float <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper::getParameter</a> </td> 1120 <table class="mlabels">
1121 <tr>
1122 <td class="mlabels-left">
1123 <table class="memname">
1124 <tr>
1125 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
868 <td>(</td> 1126 <td>(</td>
869 <td class="paramtype">std::string&#160;</td> 1127 <td class="paramtype">std::string&#160;</td>
870 <td class="paramname"></td><td>)</td> 1128 <td class="paramname"></td><td>)</td>
871 <td> const<code> [virtual, inherited]</code></td> 1129 <td> const</td>
872 </tr> 1130 </tr>
873 </table> 1131 </table>
874 </div> 1132 </td>
875 <div class="memdoc"> 1133 <td class="mlabels-right">
1134 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1135 </tr>
1136 </table>
1137 </div><div class="memdoc">
876 1138
877 <p>Get the value of a named parameter. </p> 1139 <p>Get the value of a named parameter. </p>
878 <p>The argument is the identifier field from that parameter's descriptor. </p> 1140 <p>The argument is the identifier field from that parameter's descriptor. </p>
879 1141
880 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 1142 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
881 1143
882 </div> 1144 </div>
883 </div> 1145 </div>
884 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a> 1146 <a id="aa0b72ea17766266d20539f293ccae7c8"></a>
885 <div class="memitem"> 1147 <h2 class="memtitle"><span class="permalink"><a href="#aa0b72ea17766266d20539f293ccae7c8">&#9670;&nbsp;</a></span>getPrograms()</h2>
886 <div class="memproto"> 1148
887 <table class="memname"> 1149 <div class="memitem">
888 <tr> 1150 <div class="memproto">
889 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper::getPrograms</a> </td> 1151 <table class="mlabels">
890 <td>(</td> 1152 <tr>
891 <td class="paramname"></td><td>)</td> 1153 <td class="mlabels-left">
892 <td> const<code> [virtual, inherited]</code></td> 1154 <table class="memname">
893 </tr> 1155 <tr>
894 </table> 1156 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
895 </div> 1157 <td>(</td>
896 <div class="memdoc"> 1158 <td class="paramname"></td><td>)</td>
1159 <td> const</td>
1160 </tr>
1161 </table>
1162 </td>
1163 <td class="mlabels-right">
1164 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1165 </tr>
1166 </table>
1167 </div><div class="memdoc">
897 1168
898 <p>Get the program settings available in this plugin. </p> 1169 <p>Get the program settings available in this plugin. </p>
899 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p> 1170 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
900 <p>The programs must have unique names. </p> 1171 <p>The programs must have unique names. </p>
901 1172
902 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 1173 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">Vamp::PluginBase</a>.</p>
903 1174
904 </div> 1175 </div>
905 </div> 1176 </div>
906 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a> 1177 <a id="a3936fe2c4b3c960dd244849a7c3320ad"></a>
907 <div class="memitem"> 1178 <h2 class="memtitle"><span class="permalink"><a href="#a3936fe2c4b3c960dd244849a7c3320ad">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
908 <div class="memproto"> 1179
909 <table class="memname"> 1180 <div class="memitem">
910 <tr> 1181 <div class="memproto">
911 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper::getCurrentProgram</a> </td> 1182 <table class="mlabels">
912 <td>(</td> 1183 <tr>
913 <td class="paramname"></td><td>)</td> 1184 <td class="mlabels-left">
914 <td> const<code> [virtual, inherited]</code></td> 1185 <table class="memname">
915 </tr> 1186 <tr>
916 </table> 1187 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
917 </div> 1188 <td>(</td>
918 <div class="memdoc"> 1189 <td class="paramname"></td><td>)</td>
1190 <td> const</td>
1191 </tr>
1192 </table>
1193 </td>
1194 <td class="mlabels-right">
1195 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1196 </tr>
1197 </table>
1198 </div><div class="memdoc">
919 1199
920 <p>Get the current program. </p> 1200 <p>Get the current program. </p>
921 1201
922 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 1202 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">Vamp::PluginBase</a>.</p>
923 1203
924 </div> 1204 </div>
925 </div> 1205 </div>
926 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a> 1206 <a id="abc0a4e6ce0ae9de39c40725de1f30d2f"></a>
927 <div class="memitem"> 1207 <h2 class="memtitle"><span class="permalink"><a href="#abc0a4e6ce0ae9de39c40725de1f30d2f">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
928 <div class="memproto"> 1208
929 <table class="memname"> 1209 <div class="memitem">
930 <tr> 1210 <div class="memproto">
931 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper::getMinChannelCount</a> </td> 1211 <table class="mlabels">
932 <td>(</td> 1212 <tr>
933 <td class="paramname"></td><td>)</td> 1213 <td class="mlabels-left">
934 <td> const<code> [virtual, inherited]</code></td> 1214 <table class="memname">
935 </tr> 1215 <tr>
936 </table> 1216 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
937 </div> 1217 <td>(</td>
938 <div class="memdoc"> 1218 <td class="paramname"></td><td>)</td>
1219 <td> const</td>
1220 </tr>
1221 </table>
1222 </td>
1223 <td class="mlabels-right">
1224 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1225 </tr>
1226 </table>
1227 </div><div class="memdoc">
939 1228
940 <p>Get the minimum supported number of input channels. </p> 1229 <p>Get the minimum supported number of input channels. </p>
941 1230
942 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1231 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">Vamp::Plugin</a>.</p>
943 1232
944 </div> 1233 </div>
945 </div> 1234 </div>
946 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a> 1235 <a id="acfed040cd91e797ee89d077db22b4a97"></a>
947 <div class="memitem"> 1236 <h2 class="memtitle"><span class="permalink"><a href="#acfed040cd91e797ee89d077db22b4a97">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
948 <div class="memproto"> 1237
949 <table class="memname"> 1238 <div class="memitem">
950 <tr> 1239 <div class="memproto">
951 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper::getMaxChannelCount</a> </td> 1240 <table class="mlabels">
952 <td>(</td> 1241 <tr>
953 <td class="paramname"></td><td>)</td> 1242 <td class="mlabels-left">
954 <td> const<code> [virtual, inherited]</code></td> 1243 <table class="memname">
955 </tr> 1244 <tr>
956 </table> 1245 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
957 </div> 1246 <td>(</td>
958 <div class="memdoc"> 1247 <td class="paramname"></td><td>)</td>
1248 <td> const</td>
1249 </tr>
1250 </table>
1251 </td>
1252 <td class="mlabels-right">
1253 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1254 </tr>
1255 </table>
1256 </div><div class="memdoc">
959 1257
960 <p>Get the maximum supported number of input channels. </p> 1258 <p>Get the maximum supported number of input channels. </p>
961 1259
962 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1260 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">Vamp::Plugin</a>.</p>
963 1261
964 </div> 1262 </div>
965 </div> 1263 </div>
966 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a> 1264 <a id="a653d0308e8e34881a8749b7631d00f05"></a>
1265 <h2 class="memtitle"><span class="permalink"><a href="#a653d0308e8e34881a8749b7631d00f05">&#9670;&nbsp;</a></span>getWrapper()</h2>
1266
967 <div class="memitem"> 1267 <div class="memitem">
968 <div class="memproto"> 1268 <div class="memproto">
969 <div class="memtemplate"> 1269 <div class="memtemplate">
970 template&lt;typename WrapperType &gt; </div> 1270 template&lt;typename WrapperType &gt; </div>
971 <table class="memname"> 1271 <table class="mlabels">
972 <tr> 1272 <tr>
973 <td class="memname">WrapperType* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">Vamp::HostExt::PluginWrapper::getWrapper</a> </td> 1273 <td class="mlabels-left">
974 <td>(</td> 1274 <table class="memname">
975 <td class="paramname"></td><td>)</td> 1275 <tr>
976 <td><code> [inline, inherited]</code></td> 1276 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
977 </tr> 1277 <td>(</td>
978 </table> 1278 <td class="paramname"></td><td>)</td>
979 </div> 1279 <td></td>
980 <div class="memdoc"> 1280 </tr>
1281 </table>
1282 </td>
1283 <td class="mlabels-right">
1284 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
1285 </tr>
1286 </table>
1287 </div><div class="memdoc">
981 1288
982 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p> 1289 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
983 <p>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#a964689eb9688cd7e58e8c82ebb0d305f" 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. </p> 1290 <p>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#a964689eb9688cd7e58e8c82ebb0d305f" 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. </p>
984 1291
985 <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> 1292 <p class="definition">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>
986 1293
987 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p> 1294 <p class="reference">References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
988 1295
989 <p>Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1296 <p class="reference">Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
990 1297
991 </div> 1298 </div>
992 </div> 1299 </div>
993 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 1300 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
994 <div class="memitem"> 1301 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
995 <div class="memproto"> 1302
996 <table class="memname"> 1303 <div class="memitem">
997 <tr> 1304 <div class="memproto">
998 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 1305 <table class="mlabels">
999 <td>(</td> 1306 <tr>
1000 <td class="paramname"></td><td>)</td> 1307 <td class="mlabels-left">
1001 <td> const<code> [inline, virtual, inherited]</code></td> 1308 <table class="memname">
1002 </tr> 1309 <tr>
1003 </table> 1310 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1004 </div> 1311 <td>(</td>
1005 <div class="memdoc"> 1312 <td class="paramname"></td><td>)</td>
1006 1313 <td> const</td>
1007 <p>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 from audio o...">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>. </p> 1314 </tr>
1315 </table>
1316 </td>
1317 <td class="mlabels-right">
1318 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1319 </tr>
1320 </table>
1321 </div><div class="memdoc">
1322
1323 <p>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 from audio o...">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>. </p>
1008 <p>Do not reimplement this function in your subclass. </p> 1324 <p>Do not reimplement this function in your subclass. </p>
1009 1325
1010 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1326 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1011 1327
1012 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00430">430</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 1328 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00438">438</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
1013 1329
1014 </div> 1330 </div>
1015 </div> 1331 </div>
1016 <hr/><h2>Member Data Documentation</h2> 1332 <h2 class="groupheader">Member Data Documentation</h2>
1017 <a class="anchor" id="a51e10c9c63c0349fd74c6d604de5554e"></a> 1333 <a id="a51e10c9c63c0349fd74c6d604de5554e"></a>
1018 <div class="memitem"> 1334 <h2 class="memtitle"><span class="permalink"><a href="#a51e10c9c63c0349fd74c6d604de5554e">&#9670;&nbsp;</a></span>m_impl</h2>
1019 <div class="memproto"> 1335
1020 <table class="memname"> 1336 <div class="memitem">
1021 <tr> 1337 <div class="memproto">
1022 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a51e10c9c63c0349fd74c6d604de5554e">Vamp::HostExt::PluginBufferingAdapter::m_impl</a><code> [protected]</code></td> 1338 <table class="mlabels">
1023 </tr> 1339 <tr>
1024 </table> 1340 <td class="mlabels-left">
1025 </div> 1341 <table class="memname">
1026 <div class="memdoc"> 1342 <tr>
1027 1343 <td class="memname">Impl* Vamp::HostExt::PluginBufferingAdapter::m_impl</td>
1028 <p>Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00184">184</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p> 1344 </tr>
1029 1345 </table>
1030 </div> 1346 </td>
1031 </div> 1347 <td class="mlabels-right">
1032 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a> 1348 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
1033 <div class="memitem"> 1349 </tr>
1034 <div class="memproto"> 1350 </table>
1035 <table class="memname"> 1351 </div><div class="memdoc">
1036 <tr> 1352
1037 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code></td> 1353 <p class="definition">Definition at line <a class="el" href="PluginBufferingAdapter_8h_source.html#l00184">184</a> of file <a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a>.</p>
1038 </tr> 1354
1039 </table> 1355 </div>
1040 </div> 1356 </div>
1041 <div class="memdoc"> 1357 <a id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a>
1042 1358 <h2 class="memtitle"><span class="permalink"><a href="#ab4e40ecd98b445e1a2aa9e7baa280ea2">&#9670;&nbsp;</a></span>m_plugin</h2>
1043 <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> 1359
1044 1360 <div class="memitem">
1045 </div> 1361 <div class="memproto">
1046 </div> 1362 <table class="mlabels">
1047 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1363 <tr>
1048 <div class="memitem"> 1364 <td class="mlabels-left">
1049 <div class="memproto"> 1365 <table class="memname">
1050 <table class="memname"> 1366 <tr>
1051 <tr> 1367 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginWrapper::m_plugin</td>
1052 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1368 </tr>
1053 </tr> 1369 </table>
1054 </table> 1370 </td>
1055 </div> 1371 <td class="mlabels-right">
1056 <div class="memdoc"> 1372 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1057 1373 </tr>
1058 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">436</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 1374 </table>
1059 1375 </div><div class="memdoc">
1060 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <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="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p> 1376
1377 <p class="definition">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>
1378
1379 </div>
1380 </div>
1381 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1382 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1383
1384 <div class="memitem">
1385 <div class="memproto">
1386 <table class="mlabels">
1387 <tr>
1388 <td class="mlabels-left">
1389 <table class="memname">
1390 <tr>
1391 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1392 </tr>
1393 </table>
1394 </td>
1395 <td class="mlabels-right">
1396 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1397 </tr>
1398 </table>
1399 </div><div class="memdoc">
1400
1401 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">444</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
1402
1403 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
1061 1404
1062 </div> 1405 </div>
1063 </div> 1406 </div>
1064 <hr/>The documentation for this class was generated from the following file:<ul> 1407 <hr/>The documentation for this class was generated from the following file:<ul>
1065 <li><a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a></li> 1408 <li><a class="el" href="PluginBufferingAdapter_8h_source.html">PluginBufferingAdapter.h</a></li>
1066 </ul> 1409 </ul>
1067 </div><!-- contents --> 1410 </div><!-- contents -->
1068 </div> 1411 </div><!-- doc-content -->
1069 <div id="nav-path" class="navpath"> 1412 <!-- start footer part -->
1070 <ul> 1413 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1071 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 1414 <ul>
1072 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li> 1415 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></li><li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a></li>
1073 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">PluginBufferingAdapter</a> </li> 1416 <li class="footer">Generated by
1074
1075 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
1076 <a href="http://www.doxygen.org/index.html"> 1417 <a href="http://www.doxygen.org/index.html">
1077 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1418 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
1078 </ul> 1419 </ul>
1079 </div> 1420 </div>
1080
1081
1082 </body> 1421 </body>
1083 </html> 1422 </html>