Mercurial > hg > vamp-docs

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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::PluginWrapper Class Reference</title> 8 <title>VampPluginSDK: Vamp::HostExt::PluginWrapper 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_1PluginWrapper.html',''); 58 $(document).ready(function(){initNavTree('classVamp_1_1HostExt_1_1PluginWrapper.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-methods">Protected Member Functions</a> &#124; 65 <a href="#pro-methods">Protected Member Functions</a> &#124;
80 <a href="#pro-attribs">Protected Attributes</a> </div> 66 <a href="#pro-attribs">Protected Attributes</a> &#124;
67 <a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members</a> </div>
81 <div class="headertitle"> 68 <div class="headertitle">
82 <div class="title">Vamp::HostExt::PluginWrapper Class Reference</div> </div> 69 <div class="title">Vamp::HostExt::PluginWrapper Class Reference</div> </div>
83 </div><!--header--> 70 </div><!--header-->
84 <div class="contents"> 71 <div class="contents">
85 72
86 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins. 73 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. ">PluginWrapper</a> is a simple base class for adapter plugins.
87 <a href="classVamp_1_1HostExt_1_1PluginWrapper.html#details">More...</a></p> 74 <a href="classVamp_1_1HostExt_1_1PluginWrapper.html#details">More...</a></p>
88 75
89 <p><code>#include &lt;<a class="el" href="PluginWrapper_8h_source.html">vamp-hostsdk/PluginWrapper.h</a>&gt;</code></p> 76 <p><code>#include &lt;<a class="el" href="PluginWrapper_8h_source.html">vamp-hostsdk/PluginWrapper.h</a>&gt;</code></p>
90 <div class="dynheader"> 77 <div class="dynheader">
91 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div> 78 Inheritance diagram for Vamp::HostExt::PluginWrapper:</div>
92 <div class="dyncontent"> 79 <div class="dyncontent">
93 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" alt="Inheritance graph"/></div> 80 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginWrapper__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" alt="Inheritance graph"/></div>
94 <map name="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" id="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map"> 81 <map name="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map" id="Vamp_1_1HostExt_1_1PluginWrapper_inherit__map">
95 <area shape="rect" id="node7" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="558,5,789,30"/><area shape="rect" id="node9" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="560,54,787,79"/><area shape="rect" id="node11" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input into frequency&#45;doma..." alt="" coords="547,103,800,129"/><area shape="rect" id="node13" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="547,153,800,178"/><area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="174,79,266,105"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="6,79,125,105"/></map> 82 <area shape="rect" id="node4" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="569,5,764,44"/>
83 <area shape="rect" id="node5" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="571,68,762,107"/>
84 <area shape="rect" id="node6" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time&#45;domain input into frequency&#45;doma..." alt="" coords="580,131,753,169"/>
85 <area shape="rect" id="node7" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="557,193,776,232"/>
86 <area shape="rect" id="node2" 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="176,107,271,132"/>
87 <area shape="rect" id="node3" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="5,107,128,132"/>
88 </map>
96 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> 89 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
97
98 <p><a href="classVamp_1_1HostExt_1_1PluginWrapper-members.html">List of all members.</a></p>
99 <table class="memberdecls"> 90 <table class="memberdecls">
100 <tr><td colspan="2"><h2><a name="pub-types"></a> 91 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
101 Public Types</h2></td></tr> 92 Public Types</h2></td></tr>
102 <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>, 93 <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>,
103 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 94 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
104 }</td></tr> 95 }</td></tr>
105 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 96 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 &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> 97 <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>
98 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <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> 99 <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>
108 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/> 100 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <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> 101 <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>
110 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 102 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 &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> 103 <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>
104 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
112 <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> 105 <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>
113 <tr><td colspan="2"><h2><a name="pub-methods"></a> 106 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 </table><table class="memberdecls">
108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
114 Public Member Functions</h2></td></tr> 109 Public Member Functions</h2></td></tr>
115 <tr class="memitem:ac4fb6cfd7c0d3b2c8576a4e9dc61f518"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">~PluginWrapper</a> ()</td></tr> 110 <tr class="memitem:ac4fb6cfd7c0d3b2c8576a4e9dc61f518"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">~PluginWrapper</a> ()</td></tr>
111 <tr class="separator:ac4fb6cfd7c0d3b2c8576a4e9dc61f518"><td class="memSeparator" colspan="2">&#160;</td></tr>
116 <tr class="memitem:aa5a1f8290d8e9a315695584dcb3ad137"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 112 <tr class="memitem:aa5a1f8290d8e9a315695584dcb3ad137"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
117 <tr class="memdesc:aa5a1f8290d8e9a315695584dcb3ad137"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#aa5a1f8290d8e9a315695584dcb3ad137"></a><br/></td></tr> 113 <tr class="memdesc:aa5a1f8290d8e9a315695584dcb3ad137"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#aa5a1f8290d8e9a315695584dcb3ad137">More...</a><br /></td></tr>
114 <tr class="separator:aa5a1f8290d8e9a315695584dcb3ad137"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memitem:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr> 115 <tr class="memitem:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">reset</a> ()</td></tr>
119 <tr class="memdesc:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#ad19cc0614ba41cdc26ef3394c5146fe6"></a><br/></td></tr> 116 <tr class="memdesc:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#ad19cc0614ba41cdc26ef3394c5146fe6">More...</a><br /></td></tr>
120 <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> 117 <tr class="separator:ad19cc0614ba41cdc26ef3394c5146fe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <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> 118 <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>
122 <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> 119 <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>
123 <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> 120 <tr class="separator:a8838facfe9d88cf36b13c1b42165fc6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
124 <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> 121 <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>
125 <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> 122 <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>
126 <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> 123 <tr class="separator:afa79272f991fb720ddd09784be1b3cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
127 <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> 124 <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>
128 <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> 125 <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>
129 <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> 126 <tr class="separator:ad9312a38c199004c7bad0c42f590393f"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <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> 127 <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>
131 <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> 128 <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>
132 <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> 129 <tr class="separator:aa2b40de6e240d872997a63dd4a301ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <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> 130 <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>
134 <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> 131 <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>
135 <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> 132 <tr class="separator:ad6e453c30b265a2daf243f953b35c815"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <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> 133 <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>
137 <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> 134 <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>
138 <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> 135 <tr class="separator:af9b2f01063828ef0745dc2623fc8dd42"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <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> 136 <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>
137 <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>
138 <tr class="separator:a9537de27c826a1441b2d3643df4880bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <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>
140 <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>
141 <tr class="separator:aea9c238f86de65d3380fa887bb9e47e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <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>
143 <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>
144 <tr class="separator:ab2b67205d86e921cb0a9bd1f819d2cf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <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>
146 <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>
147 <tr class="separator:a5c0a4d72a25fded51829de21771de521"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr> 148 <tr class="memitem:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr>
141 <tr class="memdesc:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5"></a><br/></td></tr> 149 <tr class="memdesc:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5">More...</a><br /></td></tr>
142 <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> 150 <tr class="separator:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <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> 151 <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>
144 <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> 152 <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>
145 <tr class="memdesc:a7a312dd42d161064b70afd7ff24c0651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr> 153 <tr class="separator:aa0b72ea17766266d20539f293ccae7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <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>
155 <tr class="memdesc:a3936fe2c4b3c960dd244849a7c3320ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a3936fe2c4b3c960dd244849a7c3320ad">More...</a><br /></td></tr>
156 <tr class="separator:a3936fe2c4b3c960dd244849a7c3320ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a074978333a74fdcf336a8a1d8ea20abf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr> 157 <tr class="memitem:a074978333a74fdcf336a8a1d8ea20abf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr>
147 <tr class="memdesc:a074978333a74fdcf336a8a1d8ea20abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf"></a><br/></td></tr> 158 <tr class="memdesc:a074978333a74fdcf336a8a1d8ea20abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf">More...</a><br /></td></tr>
148 <tr class="memitem:a0137d93d7019bacc31104836fb4d352e"><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#a0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr> 159 <tr class="separator:a074978333a74fdcf336a8a1d8ea20abf"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memdesc:a0137d93d7019bacc31104836fb4d352e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a0137d93d7019bacc31104836fb4d352e"></a><br/></td></tr> 160 <tr class="memitem:adf2ea98d6eeb0435c0c8d7cdc29fed7c"><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#adf2ea98d6eeb0435c0c8d7cdc29fed7c">getPreferredStepSize</a> () const</td></tr>
150 <tr class="memitem:a2c62a656313a819650656643a867ad01"><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#a2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr> 161 <tr class="memdesc:adf2ea98d6eeb0435c0c8d7cdc29fed7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data. ">process()</a> function) for the plugin. <a href="#adf2ea98d6eeb0435c0c8d7cdc29fed7c">More...</a><br /></td></tr>
151 <tr class="memdesc:a2c62a656313a819650656643a867ad01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#a2c62a656313a819650656643a867ad01"></a><br/></td></tr> 162 <tr class="separator:adf2ea98d6eeb0435c0c8d7cdc29fed7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <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> 163 <tr class="memitem:a94f855a2cf674ccc2e7315484f706d68"><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#a94f855a2cf674ccc2e7315484f706d68">getPreferredBlockSize</a> () const</td></tr>
153 <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> 164 <tr class="memdesc:a94f855a2cf674ccc2e7315484f706d68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data. ">process()</a> function). <a href="#a94f855a2cf674ccc2e7315484f706d68">More...</a><br /></td></tr>
154 <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> 165 <tr class="separator:a94f855a2cf674ccc2e7315484f706d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <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> 166 <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>
156 <tr class="memitem:a5a9411305f713b4c9827844b89acd270"><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_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr> 167 <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>
157 <tr class="memdesc:a5a9411305f713b4c9827844b89acd270"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a5a9411305f713b4c9827844b89acd270"></a><br/></td></tr> 168 <tr class="separator:abc0a4e6ce0ae9de39c40725de1f30d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <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>
170 <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>
171 <tr class="separator:acfed040cd91e797ee89d077db22b4a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:af67a6cd3afa18895393ec8d4bdec3b4c"><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_1PluginWrapper.html#af67a6cd3afa18895393ec8d4bdec3b4c">getOutputDescriptors</a> () const</td></tr>
173 <tr class="memdesc:af67a6cd3afa18895393ec8d4bdec3b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#af67a6cd3afa18895393ec8d4bdec3b4c">More...</a><br /></td></tr>
174 <tr class="separator:af67a6cd3afa18895393ec8d4bdec3b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:a6bd72d6dfb3047524dbe8ae3294527cf"><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_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 175 <tr class="memitem:a6bd72d6dfb3047524dbe8ae3294527cf"><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_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
159 <tr class="memdesc:a6bd72d6dfb3047524dbe8ae3294527cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a6bd72d6dfb3047524dbe8ae3294527cf"></a><br/></td></tr> 176 <tr class="memdesc:a6bd72d6dfb3047524dbe8ae3294527cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a6bd72d6dfb3047524dbe8ae3294527cf">More...</a><br /></td></tr>
177 <tr class="separator:a6bd72d6dfb3047524dbe8ae3294527cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memitem:a2bc8c0992e64f06991fb7cf89f99857e"><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_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr> 178 <tr class="memitem:a2bc8c0992e64f06991fb7cf89f99857e"><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_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">getRemainingFeatures</a> ()</td></tr>
161 <tr class="memdesc:a2bc8c0992e64f06991fb7cf89f99857e"><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="#a2bc8c0992e64f06991fb7cf89f99857e"></a><br/></td></tr> 179 <tr class="memdesc:a2bc8c0992e64f06991fb7cf89f99857e"><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="#a2bc8c0992e64f06991fb7cf89f99857e">More...</a><br /></td></tr>
180 <tr class="separator:a2bc8c0992e64f06991fb7cf89f99857e"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr> 181 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
163 <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> 182 <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>
164 <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> 183 <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>
165 <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> 184 <tr class="separator:a653d0308e8e34881a8749b7631d00f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <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> 185 <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>
167 <tr><td colspan="2"><h2><a name="pro-methods"></a> 186 <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>
187 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
188 </table><table class="memberdecls">
189 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
168 Protected Member Functions</h2></td></tr> 190 Protected Member Functions</h2></td></tr>
169 <tr class="memitem:a35cc2d42f8322f5022e89859a79c97be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 191 <tr class="memitem:a35cc2d42f8322f5022e89859a79c97be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be">PluginWrapper</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
170 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 192 <tr class="separator:a35cc2d42f8322f5022e89859a79c97be"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 </table><table class="memberdecls">
194 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
171 Protected Attributes</h2></td></tr> 195 Protected Attributes</h2></td></tr>
172 <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> 196 <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>
197 <tr class="separator:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <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> 198 <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>
174 </table> 199 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 200 </table>
176 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins.">PluginWrapper</a> is a simple base class for adapter plugins. </p> 201 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
202 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. ">PluginWrapper</a> is a simple base class for adapter plugins. </p>
177 <p>It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html">Vamp</a> plugin on construction, and provides implementations of all the <a class="el" href="namespaceVamp.html">Vamp</a> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.</p> 203 <p>It takes a pointer to a "to be wrapped" <a class="el" href="namespaceVamp.html">Vamp</a> plugin on construction, and provides implementations of all the <a class="el" href="namespaceVamp.html">Vamp</a> plugin methods that simply delegate through to the wrapped plugin. A subclass can therefore override only the methods that are meaningful for the particular adapter.</p>
178 <dl class="section note"><dt>Note:</dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl> 204 <dl class="section note"><dt>Note</dt><dd>This class was introduced in version 1.1 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
179 205
180 <p>Definition at line <a class="el" href="PluginWrapper_8h_source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a>.</p> 206 <p class="definition">Definition at line <a class="el" href="PluginWrapper_8h_source.html#l00062">62</a> of file <a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a>.</p>
181 </div><hr/><h2>Member Typedef Documentation</h2> 207 </div><h2 class="groupheader">Member Typedef Documentation</h2>
182 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 208 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
183 <div class="memitem"> 209 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
184 <div class="memproto"> 210
185 <table class="memname"> 211 <div class="memitem">
186 <tr> 212 <div class="memproto">
187 <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> 213 <table class="mlabels">
188 </tr> 214 <tr>
189 </table> 215 <td class="mlabels-left">
190 </div> 216 <table class="memname">
191 <div class="memdoc"> 217 <tr>
192 218 <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>
193 <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> 219 </tr>
194 220 </table>
195 </div> 221 </td>
196 </div> 222 <td class="mlabels-right">
197 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 223 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
198 <div class="memitem"> 224 </tr>
199 <div class="memproto"> 225 </table>
200 <table class="memname"> 226 </div><div class="memdoc">
201 <tr> 227
202 <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> 228 <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>
203 </tr> 229
204 </table> 230 </div>
205 </div> 231 </div>
206 <div class="memdoc"> 232 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
207 233 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
208 <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> 234
209 235 <div class="memitem">
210 </div> 236 <div class="memproto">
211 </div> 237 <table class="mlabels">
212 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 238 <tr>
213 <div class="memitem"> 239 <td class="mlabels-left">
214 <div class="memproto"> 240 <table class="memname">
215 <table class="memname"> 241 <tr>
216 <tr> 242 <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>
217 <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> 243 </tr>
218 </tr> 244 </table>
219 </table> 245 </td>
220 </div> 246 <td class="mlabels-right">
221 <div class="memdoc"> 247 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
222 248 </tr>
223 <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> 249 </table>
224 250 </div><div class="memdoc">
225 </div> 251
226 </div> 252 <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>
227 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 253
228 <div class="memitem"> 254 </div>
229 <div class="memproto"> 255 </div>
230 <table class="memname"> 256 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
231 <tr> 257 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
232 <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> 258
233 </tr> 259 <div class="memitem">
234 </table> 260 <div class="memproto">
235 </div> 261 <table class="mlabels">
236 <div class="memdoc"> 262 <tr>
237 263 <td class="mlabels-left">
238 <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> 264 <table class="memname">
239 265 <tr>
240 </div> 266 <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>
241 </div> 267 </tr>
242 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 268 </table>
243 <div class="memitem"> 269 </td>
244 <div class="memproto"> 270 <td class="mlabels-right">
245 <table class="memname"> 271 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
246 <tr> 272 </tr>
247 <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> 273 </table>
248 </tr> 274 </div><div class="memdoc">
249 </table> 275
250 </div> 276 <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>
251 <div class="memdoc"> 277
252 278 </div>
253 <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> 279 </div>
254 280 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
255 </div> 281 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
256 </div> 282
257 <hr/><h2>Member Enumeration Documentation</h2> 283 <div class="memitem">
258 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 284 <div class="memproto">
259 <div class="memitem"> 285 <table class="mlabels">
260 <div class="memproto"> 286 <tr>
261 <table class="memname"> 287 <td class="mlabels-left">
262 <tr> 288 <table class="memname">
263 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 289 <tr>
264 </tr> 290 <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>
265 </table> 291 </tr>
266 </div> 292 </table>
267 <div class="memdoc"> 293 </td>
268 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 294 <td class="mlabels-right">
269 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 295 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
270 </td></tr> 296 </tr>
271 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 297 </table>
272 </td></tr> 298 </div><div class="memdoc">
273 </table> 299
274 </dd> 300 <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>
275 </dl> 301
276 302 </div>
277 <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> 303 </div>
278 304 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
279 </div> 305 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
280 </div> 306
281 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 307 <div class="memitem">
282 <a class="anchor" id="ac4fb6cfd7c0d3b2c8576a4e9dc61f518"></a> 308 <div class="memproto">
283 <div class="memitem"> 309 <table class="mlabels">
284 <div class="memproto"> 310 <tr>
285 <table class="memname"> 311 <td class="mlabels-left">
286 <tr> 312 <table class="memname">
287 <td class="memname">virtual <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">Vamp::HostExt::PluginWrapper::~PluginWrapper</a> </td> 313 <tr>
288 <td>(</td> 314 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
289 <td class="paramname"></td><td>)</td> 315 </tr>
290 <td><code> [virtual]</code></td> 316 </table>
291 </tr> 317 </td>
292 </table> 318 <td class="mlabels-right">
293 </div> 319 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
294 <div class="memdoc"> 320 </tr>
295 321 </table>
296 </div> 322 </div><div class="memdoc">
297 </div> 323
298 <a class="anchor" id="a35cc2d42f8322f5022e89859a79c97be"></a> 324 <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>
299 <div class="memitem"> 325
300 <div class="memproto"> 326 </div>
301 <table class="memname"> 327 </div>
302 <tr> 328 <h2 class="groupheader">Member Enumeration Documentation</h2>
303 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a35cc2d42f8322f5022e89859a79c97be">Vamp::HostExt::PluginWrapper::PluginWrapper</a> </td> 329 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
330 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
331
332 <div class="memitem">
333 <div class="memproto">
334 <table class="mlabels">
335 <tr>
336 <td class="mlabels-left">
337 <table class="memname">
338 <tr>
339 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
340 </tr>
341 </table>
342 </td>
343 <td class="mlabels-right">
344 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
345 </tr>
346 </table>
347 </div><div class="memdoc">
348 <table class="fieldtable">
349 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
350 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
351 </table>
352
353 <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>
354
355 </div>
356 </div>
357 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
358 <a id="ac4fb6cfd7c0d3b2c8576a4e9dc61f518"></a>
359 <h2 class="memtitle"><span class="permalink"><a href="#ac4fb6cfd7c0d3b2c8576a4e9dc61f518">&#9670;&nbsp;</a></span>~PluginWrapper()</h2>
360
361 <div class="memitem">
362 <div class="memproto">
363 <table class="mlabels">
364 <tr>
365 <td class="mlabels-left">
366 <table class="memname">
367 <tr>
368 <td class="memname">virtual Vamp::HostExt::PluginWrapper::~PluginWrapper </td>
369 <td>(</td>
370 <td class="paramname"></td><td>)</td>
371 <td></td>
372 </tr>
373 </table>
374 </td>
375 <td class="mlabels-right">
376 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
377 </tr>
378 </table>
379 </div><div class="memdoc">
380
381 </div>
382 </div>
383 <a id="a35cc2d42f8322f5022e89859a79c97be"></a>
384 <h2 class="memtitle"><span class="permalink"><a href="#a35cc2d42f8322f5022e89859a79c97be">&#9670;&nbsp;</a></span>PluginWrapper()</h2>
385
386 <div class="memitem">
387 <div class="memproto">
388 <table class="mlabels">
389 <tr>
390 <td class="mlabels-left">
391 <table class="memname">
392 <tr>
393 <td class="memname">Vamp::HostExt::PluginWrapper::PluginWrapper </td>
304 <td>(</td> 394 <td>(</td>
305 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td> 395 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
306 <td class="paramname"><em>plugin</em></td><td>)</td> 396 <td class="paramname"><em>plugin</em></td><td>)</td>
307 <td><code> [protected]</code></td> 397 <td></td>
308 </tr> 398 </tr>
309 </table> 399 </table>
310 </div> 400 </td>
311 <div class="memdoc"> 401 <td class="mlabels-right">
312 402 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
313 </div> 403 </tr>
314 </div> 404 </table>
315 <hr/><h2>Member Function Documentation</h2> 405 </div><div class="memdoc">
316 <a class="anchor" id="aa5a1f8290d8e9a315695584dcb3ad137"></a> 406
317 <div class="memitem"> 407 </div>
318 <div class="memproto"> 408 </div>
319 <table class="memname"> 409 <h2 class="groupheader">Member Function Documentation</h2>
320 <tr> 410 <a id="aa5a1f8290d8e9a315695584dcb3ad137"></a>
321 <td class="memname">bool <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper::initialise</a> </td> 411 <h2 class="memtitle"><span class="permalink"><a href="#aa5a1f8290d8e9a315695584dcb3ad137">&#9670;&nbsp;</a></span>initialise()</h2>
412
413 <div class="memitem">
414 <div class="memproto">
415 <table class="mlabels">
416 <tr>
417 <td class="mlabels-left">
418 <table class="memname">
419 <tr>
420 <td class="memname">bool Vamp::HostExt::PluginWrapper::initialise </td>
322 <td>(</td> 421 <td>(</td>
323 <td class="paramtype">size_t&#160;</td> 422 <td class="paramtype">size_t&#160;</td>
324 <td class="paramname"><em>inputChannels</em>, </td> 423 <td class="paramname"><em>inputChannels</em>, </td>
325 </tr> 424 </tr>
326 <tr> 425 <tr>
336 <td class="paramname"><em>blockSize</em>&#160;</td> 435 <td class="paramname"><em>blockSize</em>&#160;</td>
337 </tr> 436 </tr>
338 <tr> 437 <tr>
339 <td></td> 438 <td></td>
340 <td>)</td> 439 <td>)</td>
341 <td></td><td><code> [virtual]</code></td> 440 <td></td><td></td>
342 </tr> 441 </tr>
343 </table> 442 </table>
344 </div> 443 </td>
345 <div class="memdoc"> 444 <td class="mlabels-right">
445 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
446 </tr>
447 </table>
448 </div><div class="memdoc">
346 449
347 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p> 450 <p>Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). </p>
348 <p>The input sample rate should have been already specified at construction time.</p> 451 <p>The input sample rate should have been already specified at construction time.</p>
349 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> 452 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
350 453
351 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> 454 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
352 455
353 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#ade0473c8fc54636431967cbf41649c1c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a9e7798ba4d7870db46502ab541ab37a8">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a72d201eca10ec73bf16e07984f58f94c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745">Vamp::HostExt::PluginSummarisingAdapter</a>.</p> 456 </div>
354 457 </div>
355 </div> 458 <a id="ad19cc0614ba41cdc26ef3394c5146fe6"></a>
356 </div> 459 <h2 class="memtitle"><span class="permalink"><a href="#ad19cc0614ba41cdc26ef3394c5146fe6">&#9670;&nbsp;</a></span>reset()</h2>
357 <a class="anchor" id="ad19cc0614ba41cdc26ef3394c5146fe6"></a> 460
358 <div class="memitem"> 461 <div class="memitem">
359 <div class="memproto"> 462 <div class="memproto">
360 <table class="memname"> 463 <table class="mlabels">
361 <tr> 464 <tr>
362 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper::reset</a> </td> 465 <td class="mlabels-left">
363 <td>(</td> 466 <table class="memname">
364 <td class="paramname"></td><td>)</td> 467 <tr>
365 <td><code> [virtual]</code></td> 468 <td class="memname">void Vamp::HostExt::PluginWrapper::reset </td>
366 </tr> 469 <td>(</td>
367 </table> 470 <td class="paramname"></td><td>)</td>
368 </div> 471 <td></td>
369 <div class="memdoc"> 472 </tr>
473 </table>
474 </td>
475 <td class="mlabels-right">
476 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
477 </tr>
478 </table>
479 </div><div class="memdoc">
370 480
371 <p>Reset the plugin after use, to prepare it for another clean run. </p> 481 <p>Reset the plugin after use, to prepare it for another clean run. </p>
372 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 482 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
373 483
374 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> 484 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
375 485
376 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a131fd9fe8a1795d7370d8a721176868a">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a984a12b5b4cb0be1e2f7a0aa84106c4c">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911">Vamp::HostExt::PluginSummarisingAdapter</a>.</p> 486 </div>
377 487 </div>
378 </div> 488 <a id="a8838facfe9d88cf36b13c1b42165fc6d"></a>
379 </div> 489 <h2 class="memtitle"><span class="permalink"><a href="#a8838facfe9d88cf36b13c1b42165fc6d">&#9670;&nbsp;</a></span>getInputDomain()</h2>
380 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a> 490
381 <div class="memitem"> 491 <div class="memitem">
382 <div class="memproto"> 492 <div class="memproto">
383 <table class="memname"> 493 <table class="mlabels">
384 <tr> 494 <tr>
385 <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> 495 <td class="mlabels-left">
386 <td>(</td> 496 <table class="memname">
387 <td class="paramname"></td><td>)</td> 497 <tr>
388 <td> const<code> [virtual]</code></td> 498 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
389 </tr> 499 <td>(</td>
390 </table> 500 <td class="paramname"></td><td>)</td>
391 </div> 501 <td> const</td>
392 <div class="memdoc"> 502 </tr>
503 </table>
504 </td>
505 <td class="mlabels-right">
506 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
507 </tr>
508 </table>
509 </div><div class="memdoc">
393 510
394 <p>Get the plugin's required input domain. </p> 511 <p>Get the plugin's required input domain. </p>
395 <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> 512 <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>
396 <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> 513 <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 &ndash; the host will either let the user do so, or will use a Hanning window. </p>
397 514
398 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 515 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
399 516
400 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 517 </div>
401 518 </div>
402 </div> 519 <a id="afa79272f991fb720ddd09784be1b3cb8"></a>
403 </div> 520 <h2 class="memtitle"><span class="permalink"><a href="#afa79272f991fb720ddd09784be1b3cb8">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
404 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a> 521
405 <div class="memitem"> 522 <div class="memitem">
406 <div class="memproto"> 523 <div class="memproto">
407 <table class="memname"> 524 <table class="mlabels">
408 <tr> 525 <tr>
409 <td class="memname">unsigned int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper::getVampApiVersion</a> </td> 526 <td class="mlabels-left">
410 <td>(</td> 527 <table class="memname">
411 <td class="paramname"></td><td>)</td> 528 <tr>
412 <td> const<code> [virtual]</code></td> 529 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
413 </tr> 530 <td>(</td>
414 </table> 531 <td class="paramname"></td><td>)</td>
415 </div> 532 <td> const</td>
416 <div class="memdoc"> 533 </tr>
534 </table>
535 </td>
536 <td class="mlabels-right">
537 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
538 </tr>
539 </table>
540 </div><div class="memdoc">
417 541
418 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 542 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
419 543
420 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 544 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">Vamp::PluginBase</a>.</p>
421 545
422 </div> 546 </div>
423 </div> 547 </div>
424 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a> 548 <a id="ad9312a38c199004c7bad0c42f590393f"></a>
425 <div class="memitem"> 549 <h2 class="memtitle"><span class="permalink"><a href="#ad9312a38c199004c7bad0c42f590393f">&#9670;&nbsp;</a></span>getIdentifier()</h2>
426 <div class="memproto"> 550
427 <table class="memname"> 551 <div class="memitem">
428 <tr> 552 <div class="memproto">
429 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper::getIdentifier</a> </td> 553 <table class="mlabels">
430 <td>(</td> 554 <tr>
431 <td class="paramname"></td><td>)</td> 555 <td class="mlabels-left">
432 <td> const<code> [virtual]</code></td> 556 <table class="memname">
433 </tr> 557 <tr>
434 </table> 558 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
435 </div> 559 <td>(</td>
436 <div class="memdoc"> 560 <td class="paramname"></td><td>)</td>
561 <td> const</td>
562 </tr>
563 </table>
564 </td>
565 <td class="mlabels-right">
566 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
567 </tr>
568 </table>
569 </div><div class="memdoc">
437 570
438 <p>Get the computer-usable name of the plugin. </p> 571 <p>Get the computer-usable name of the plugin. </p>
439 <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> 572 <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>
440 <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> 573 <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>
441 <p>Example: "zero_crossings" </p> 574 <p>Example: "zero_crossings" </p>
442 575
443 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 576 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
444 577
445 </div> 578 </div>
446 </div> 579 </div>
447 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a> 580 <a id="aa2b40de6e240d872997a63dd4a301ff3"></a>
448 <div class="memitem"> 581 <h2 class="memtitle"><span class="permalink"><a href="#aa2b40de6e240d872997a63dd4a301ff3">&#9670;&nbsp;</a></span>getName()</h2>
449 <div class="memproto"> 582
450 <table class="memname"> 583 <div class="memitem">
451 <tr> 584 <div class="memproto">
452 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper::getName</a> </td> 585 <table class="mlabels">
453 <td>(</td> 586 <tr>
454 <td class="paramname"></td><td>)</td> 587 <td class="mlabels-left">
455 <td> const<code> [virtual]</code></td> 588 <table class="memname">
456 </tr> 589 <tr>
457 </table> 590 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
458 </div> 591 <td>(</td>
459 <div class="memdoc"> 592 <td class="paramname"></td><td>)</td>
593 <td> const</td>
594 </tr>
595 </table>
596 </td>
597 <td class="mlabels-right">
598 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
599 </tr>
600 </table>
601 </div><div class="memdoc">
460 602
461 <p>Get a human-readable name or title of the plugin. </p> 603 <p>Get a human-readable name or title of the plugin. </p>
462 <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> 604 <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>
463 <p>Example: "Zero Crossings" </p> 605 <p>Example: "Zero Crossings" </p>
464 606
465 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 607 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
466 608
467 </div> 609 </div>
468 </div> 610 </div>
469 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a> 611 <a id="ad6e453c30b265a2daf243f953b35c815"></a>
470 <div class="memitem"> 612 <h2 class="memtitle"><span class="permalink"><a href="#ad6e453c30b265a2daf243f953b35c815">&#9670;&nbsp;</a></span>getDescription()</h2>
471 <div class="memproto"> 613
472 <table class="memname"> 614 <div class="memitem">
473 <tr> 615 <div class="memproto">
474 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper::getDescription</a> </td> 616 <table class="mlabels">
475 <td>(</td> 617 <tr>
476 <td class="paramname"></td><td>)</td> 618 <td class="mlabels-left">
477 <td> const<code> [virtual]</code></td> 619 <table class="memname">
478 </tr> 620 <tr>
479 </table> 621 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
480 </div> 622 <td>(</td>
481 <div class="memdoc"> 623 <td class="paramname"></td><td>)</td>
624 <td> const</td>
625 </tr>
626 </table>
627 </td>
628 <td class="mlabels-right">
629 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
630 </tr>
631 </table>
632 </div><div class="memdoc">
482 633
483 <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> 634 <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>
484 <p>May be empty if the name has said it all already.</p> 635 <p>May be empty if the name has said it all already.</p>
485 <p>Example: "Detect and count zero crossing points" </p> 636 <p>Example: "Detect and count zero crossing points" </p>
486 637
487 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 638 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
488 639
489 </div> 640 </div>
490 </div> 641 </div>
491 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a> 642 <a id="af9b2f01063828ef0745dc2623fc8dd42"></a>
492 <div class="memitem"> 643 <h2 class="memtitle"><span class="permalink"><a href="#af9b2f01063828ef0745dc2623fc8dd42">&#9670;&nbsp;</a></span>getMaker()</h2>
493 <div class="memproto"> 644
494 <table class="memname"> 645 <div class="memitem">
495 <tr> 646 <div class="memproto">
496 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper::getMaker</a> </td> 647 <table class="mlabels">
497 <td>(</td> 648 <tr>
498 <td class="paramname"></td><td>)</td> 649 <td class="mlabels-left">
499 <td> const<code> [virtual]</code></td> 650 <table class="memname">
500 </tr> 651 <tr>
501 </table> 652 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
502 </div> 653 <td>(</td>
503 <div class="memdoc"> 654 <td class="paramname"></td><td>)</td>
655 <td> const</td>
656 </tr>
657 </table>
658 </td>
659 <td class="mlabels-right">
660 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
661 </tr>
662 </table>
663 </div><div class="memdoc">
504 664
505 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 665 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
506 <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> 666 <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>
507 667
508 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 668 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
509 669
510 </div> 670 </div>
511 </div> 671 </div>
512 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a> 672 <a id="a9537de27c826a1441b2d3643df4880bb"></a>
513 <div class="memitem"> 673 <h2 class="memtitle"><span class="permalink"><a href="#a9537de27c826a1441b2d3643df4880bb">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
514 <div class="memproto"> 674
515 <table class="memname"> 675 <div class="memitem">
516 <tr> 676 <div class="memproto">
517 <td class="memname">int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper::getPluginVersion</a> </td> 677 <table class="mlabels">
518 <td>(</td> 678 <tr>
519 <td class="paramname"></td><td>)</td> 679 <td class="mlabels-left">
520 <td> const<code> [virtual]</code></td> 680 <table class="memname">
521 </tr> 681 <tr>
522 </table> 682 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
523 </div> 683 <td>(</td>
524 <div class="memdoc"> 684 <td class="paramname"></td><td>)</td>
685 <td> const</td>
686 </tr>
687 </table>
688 </td>
689 <td class="mlabels-right">
690 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
691 </tr>
692 </table>
693 </div><div class="memdoc">
525 694
526 <p>Get the version number of the plugin. </p> 695 <p>Get the version number of the plugin. </p>
527 696
528 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 697 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
529 698
530 </div> 699 </div>
531 </div> 700 </div>
532 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a> 701 <a id="aea9c238f86de65d3380fa887bb9e47e6"></a>
533 <div class="memitem"> 702 <h2 class="memtitle"><span class="permalink"><a href="#aea9c238f86de65d3380fa887bb9e47e6">&#9670;&nbsp;</a></span>getCopyright()</h2>
534 <div class="memproto"> 703
535 <table class="memname"> 704 <div class="memitem">
536 <tr> 705 <div class="memproto">
537 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper::getCopyright</a> </td> 706 <table class="mlabels">
538 <td>(</td> 707 <tr>
539 <td class="paramname"></td><td>)</td> 708 <td class="mlabels-left">
540 <td> const<code> [virtual]</code></td> 709 <table class="memname">
541 </tr> 710 <tr>
542 </table> 711 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
543 </div> 712 <td>(</td>
544 <div class="memdoc"> 713 <td class="paramname"></td><td>)</td>
714 <td> const</td>
715 </tr>
716 </table>
717 </td>
718 <td class="mlabels-right">
719 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
720 </tr>
721 </table>
722 </div><div class="memdoc">
545 723
546 <p>Get the copyright statement or licensing summary for the plugin. </p> 724 <p>Get the copyright statement or licensing summary for the plugin. </p>
547 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 725 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
548 726
549 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 727 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
550 728
551 </div> 729 </div>
552 </div> 730 </div>
553 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a> 731 <a id="ab2b67205d86e921cb0a9bd1f819d2cf9"></a>
554 <div class="memitem"> 732 <h2 class="memtitle"><span class="permalink"><a href="#ab2b67205d86e921cb0a9bd1f819d2cf9">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
555 <div class="memproto"> 733
556 <table class="memname"> 734 <div class="memitem">
557 <tr> 735 <div class="memproto">
558 <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> 736 <table class="mlabels">
559 <td>(</td> 737 <tr>
560 <td class="paramname"></td><td>)</td> 738 <td class="mlabels-left">
561 <td> const<code> [virtual]</code></td> 739 <table class="memname">
562 </tr> 740 <tr>
563 </table> 741 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
564 </div> 742 <td>(</td>
565 <div class="memdoc"> 743 <td class="paramname"></td><td>)</td>
744 <td> const</td>
745 </tr>
746 </table>
747 </td>
748 <td class="mlabels-right">
749 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
750 </tr>
751 </table>
752 </div><div class="memdoc">
566 753
567 <p>Get the controllable parameters of this plugin. </p> 754 <p>Get the controllable parameters of this plugin. </p>
568 755
569 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 756 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
570 757
571 </div> 758 </div>
572 </div> 759 </div>
573 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a> 760 <a id="a5c0a4d72a25fded51829de21771de521"></a>
574 <div class="memitem"> 761 <h2 class="memtitle"><span class="permalink"><a href="#a5c0a4d72a25fded51829de21771de521">&#9670;&nbsp;</a></span>getParameter()</h2>
575 <div class="memproto"> 762
576 <table class="memname"> 763 <div class="memitem">
577 <tr> 764 <div class="memproto">
578 <td class="memname">float <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper::getParameter</a> </td> 765 <table class="mlabels">
766 <tr>
767 <td class="mlabels-left">
768 <table class="memname">
769 <tr>
770 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
579 <td>(</td> 771 <td>(</td>
580 <td class="paramtype">std::string&#160;</td> 772 <td class="paramtype">std::string&#160;</td>
581 <td class="paramname"></td><td>)</td> 773 <td class="paramname"></td><td>)</td>
582 <td> const<code> [virtual]</code></td> 774 <td> const</td>
583 </tr> 775 </tr>
584 </table> 776 </table>
585 </div> 777 </td>
586 <div class="memdoc"> 778 <td class="mlabels-right">
779 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
780 </tr>
781 </table>
782 </div><div class="memdoc">
587 783
588 <p>Get the value of a named parameter. </p> 784 <p>Get the value of a named parameter. </p>
589 <p>The argument is the identifier field from that parameter's descriptor. </p> 785 <p>The argument is the identifier field from that parameter's descriptor. </p>
590 786
591 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 787 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
592 788
593 </div> 789 </div>
594 </div> 790 </div>
595 <a class="anchor" id="a651b15a5dc4c27942ac0c87c6092bfe5"></a> 791 <a id="a651b15a5dc4c27942ac0c87c6092bfe5"></a>
596 <div class="memitem"> 792 <h2 class="memtitle"><span class="permalink"><a href="#a651b15a5dc4c27942ac0c87c6092bfe5">&#9670;&nbsp;</a></span>setParameter()</h2>
597 <div class="memproto"> 793
598 <table class="memname"> 794 <div class="memitem">
599 <tr> 795 <div class="memproto">
600 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper::setParameter</a> </td> 796 <table class="mlabels">
797 <tr>
798 <td class="mlabels-left">
799 <table class="memname">
800 <tr>
801 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
601 <td>(</td> 802 <td>(</td>
602 <td class="paramtype">std::string&#160;</td> 803 <td class="paramtype">std::string&#160;</td>
603 <td class="paramname">, </td> 804 <td class="paramname">, </td>
604 </tr> 805 </tr>
605 <tr> 806 <tr>
609 <td class="paramname">&#160;</td> 810 <td class="paramname">&#160;</td>
610 </tr> 811 </tr>
611 <tr> 812 <tr>
612 <td></td> 813 <td></td>
613 <td>)</td> 814 <td>)</td>
614 <td></td><td><code> [virtual]</code></td> 815 <td></td><td></td>
615 </tr> 816 </tr>
616 </table> 817 </table>
617 </div> 818 </td>
618 <div class="memdoc"> 819 <td class="mlabels-right">
820 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
821 </tr>
822 </table>
823 </div><div class="memdoc">
619 824
620 <p>Set a named parameter. </p> 825 <p>Set a named parameter. </p>
621 <p>The first argument is the identifier field from that parameter's descriptor. </p> 826 <p>The first argument is the identifier field from that parameter's descriptor. </p>
622 827
623 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 828 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
624 829
625 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 830 </div>
626 831 </div>
627 </div> 832 <a id="aa0b72ea17766266d20539f293ccae7c8"></a>
628 </div> 833 <h2 class="memtitle"><span class="permalink"><a href="#aa0b72ea17766266d20539f293ccae7c8">&#9670;&nbsp;</a></span>getPrograms()</h2>
629 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a> 834
630 <div class="memitem"> 835 <div class="memitem">
631 <div class="memproto"> 836 <div class="memproto">
632 <table class="memname"> 837 <table class="mlabels">
633 <tr> 838 <tr>
634 <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> 839 <td class="mlabels-left">
635 <td>(</td> 840 <table class="memname">
636 <td class="paramname"></td><td>)</td> 841 <tr>
637 <td> const<code> [virtual]</code></td> 842 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
638 </tr> 843 <td>(</td>
639 </table> 844 <td class="paramname"></td><td>)</td>
640 </div> 845 <td> const</td>
641 <div class="memdoc"> 846 </tr>
847 </table>
848 </td>
849 <td class="mlabels-right">
850 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
851 </tr>
852 </table>
853 </div><div class="memdoc">
642 854
643 <p>Get the program settings available in this plugin. </p> 855 <p>Get the program settings available in this plugin. </p>
644 <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> 856 <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>
645 <p>The programs must have unique names. </p> 857 <p>The programs must have unique names. </p>
646 858
647 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 859 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">Vamp::PluginBase</a>.</p>
648 860
649 </div> 861 </div>
650 </div> 862 </div>
651 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a> 863 <a id="a3936fe2c4b3c960dd244849a7c3320ad"></a>
652 <div class="memitem"> 864 <h2 class="memtitle"><span class="permalink"><a href="#a3936fe2c4b3c960dd244849a7c3320ad">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
653 <div class="memproto"> 865
654 <table class="memname"> 866 <div class="memitem">
655 <tr> 867 <div class="memproto">
656 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper::getCurrentProgram</a> </td> 868 <table class="mlabels">
657 <td>(</td> 869 <tr>
658 <td class="paramname"></td><td>)</td> 870 <td class="mlabels-left">
659 <td> const<code> [virtual]</code></td> 871 <table class="memname">
660 </tr> 872 <tr>
661 </table> 873 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
662 </div> 874 <td>(</td>
663 <div class="memdoc"> 875 <td class="paramname"></td><td>)</td>
876 <td> const</td>
877 </tr>
878 </table>
879 </td>
880 <td class="mlabels-right">
881 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
882 </tr>
883 </table>
884 </div><div class="memdoc">
664 885
665 <p>Get the current program. </p> 886 <p>Get the current program. </p>
666 887
667 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 888 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">Vamp::PluginBase</a>.</p>
668 889
669 </div> 890 </div>
670 </div> 891 </div>
671 <a class="anchor" id="a074978333a74fdcf336a8a1d8ea20abf"></a> 892 <a id="a074978333a74fdcf336a8a1d8ea20abf"></a>
672 <div class="memitem"> 893 <h2 class="memtitle"><span class="permalink"><a href="#a074978333a74fdcf336a8a1d8ea20abf">&#9670;&nbsp;</a></span>selectProgram()</h2>
673 <div class="memproto"> 894
674 <table class="memname"> 895 <div class="memitem">
675 <tr> 896 <div class="memproto">
676 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper::selectProgram</a> </td> 897 <table class="mlabels">
898 <tr>
899 <td class="mlabels-left">
900 <table class="memname">
901 <tr>
902 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
677 <td>(</td> 903 <td>(</td>
678 <td class="paramtype">std::string&#160;</td> 904 <td class="paramtype">std::string&#160;</td>
679 <td class="paramname"></td><td>)</td> 905 <td class="paramname"></td><td>)</td>
680 <td><code> [virtual]</code></td> 906 <td></td>
681 </tr> 907 </tr>
682 </table> 908 </table>
683 </div> 909 </td>
684 <div class="memdoc"> 910 <td class="mlabels-right">
911 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
912 </tr>
913 </table>
914 </div><div class="memdoc">
685 915
686 <p>Select a program. </p> 916 <p>Select a program. </p>
687 <p>(If the given program name is not one of the available programs, do nothing.) </p> 917 <p>(If the given program name is not one of the available programs, do nothing.) </p>
688 918
689 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 919 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
690 920
691 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 921 </div>
692 922 </div>
693 </div> 923 <a id="adf2ea98d6eeb0435c0c8d7cdc29fed7c"></a>
694 </div> 924 <h2 class="memtitle"><span class="permalink"><a href="#adf2ea98d6eeb0435c0c8d7cdc29fed7c">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
695 <a class="anchor" id="a0137d93d7019bacc31104836fb4d352e"></a> 925
696 <div class="memitem"> 926 <div class="memitem">
697 <div class="memproto"> 927 <div class="memproto">
698 <table class="memname"> 928 <table class="mlabels">
699 <tr> 929 <tr>
700 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper::getPreferredStepSize</a> </td> 930 <td class="mlabels-left">
701 <td>(</td> 931 <table class="memname">
702 <td class="paramname"></td><td>)</td> 932 <tr>
703 <td> const<code> [virtual]</code></td> 933 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
704 </tr> 934 <td>(</td>
705 </table> 935 <td class="paramname"></td><td>)</td>
706 </div> 936 <td> const</td>
707 <div class="memdoc"> 937 </tr>
708 938 </table>
709 <p>Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. </p> 939 </td>
710 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p> 940 <td class="mlabels-right">
711 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p> 941 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
712 942 </tr>
713 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p> 943 </table>
714 944 </div><div class="memdoc">
715 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 945
716 946 <p>Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
717 </div> 947 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a>.</p>
718 </div> 948 <p>A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a> call. </p>
719 <a class="anchor" id="a2c62a656313a819650656643a867ad01"></a> 949
720 <div class="memitem"> 950 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin</a>.</p>
721 <div class="memproto"> 951
722 <table class="memname"> 952 </div>
723 <tr> 953 </div>
724 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper::getPreferredBlockSize</a> </td> 954 <a id="a94f855a2cf674ccc2e7315484f706d68"></a>
725 <td>(</td> 955 <h2 class="memtitle"><span class="permalink"><a href="#a94f855a2cf674ccc2e7315484f706d68">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
726 <td class="paramname"></td><td>)</td> 956
727 <td> const<code> [virtual]</code></td> 957 <div class="memitem">
728 </tr> 958 <div class="memproto">
729 </table> 959 <table class="mlabels">
730 </div> 960 <tr>
731 <div class="memdoc"> 961 <td class="mlabels-left">
732 962 <table class="memname">
733 <p>Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). </p> 963 <tr>
734 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p> 964 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
735 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p> 965 <td>(</td>
736 966 <td class="paramname"></td><td>)</td>
737 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> 967 <td> const</td>
738 968 </tr>
739 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 969 </table>
740 970 </td>
741 </div> 971 <td class="mlabels-right">
742 </div> 972 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
743 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a> 973 </tr>
744 <div class="memitem"> 974 </table>
745 <div class="memproto"> 975 </div><div class="memdoc">
746 <table class="memname"> 976
747 <tr> 977 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data. ">process()</a> function). </p>
748 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper::getMinChannelCount</a> </td> 978 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a>.</p>
749 <td>(</td> 979 <p>A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). ">initialise()</a> call. </p>
750 <td class="paramname"></td><td>)</td> 980
751 <td> const<code> [virtual]</code></td> 981 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin</a>.</p>
752 </tr> 982
753 </table> 983 </div>
754 </div> 984 </div>
755 <div class="memdoc"> 985 <a id="abc0a4e6ce0ae9de39c40725de1f30d2f"></a>
986 <h2 class="memtitle"><span class="permalink"><a href="#abc0a4e6ce0ae9de39c40725de1f30d2f">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
987
988 <div class="memitem">
989 <div class="memproto">
990 <table class="mlabels">
991 <tr>
992 <td class="mlabels-left">
993 <table class="memname">
994 <tr>
995 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
996 <td>(</td>
997 <td class="paramname"></td><td>)</td>
998 <td> const</td>
999 </tr>
1000 </table>
1001 </td>
1002 <td class="mlabels-right">
1003 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1004 </tr>
1005 </table>
1006 </div><div class="memdoc">
756 1007
757 <p>Get the minimum supported number of input channels. </p> 1008 <p>Get the minimum supported number of input channels. </p>
758 1009
759 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1010 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">Vamp::Plugin</a>.</p>
760 1011
761 </div> 1012 </div>
762 </div> 1013 </div>
763 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a> 1014 <a id="acfed040cd91e797ee89d077db22b4a97"></a>
764 <div class="memitem"> 1015 <h2 class="memtitle"><span class="permalink"><a href="#acfed040cd91e797ee89d077db22b4a97">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
765 <div class="memproto"> 1016
766 <table class="memname"> 1017 <div class="memitem">
767 <tr> 1018 <div class="memproto">
768 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper::getMaxChannelCount</a> </td> 1019 <table class="mlabels">
769 <td>(</td> 1020 <tr>
770 <td class="paramname"></td><td>)</td> 1021 <td class="mlabels-left">
771 <td> const<code> [virtual]</code></td> 1022 <table class="memname">
772 </tr> 1023 <tr>
773 </table> 1024 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
774 </div> 1025 <td>(</td>
775 <div class="memdoc"> 1026 <td class="paramname"></td><td>)</td>
1027 <td> const</td>
1028 </tr>
1029 </table>
1030 </td>
1031 <td class="mlabels-right">
1032 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1033 </tr>
1034 </table>
1035 </div><div class="memdoc">
776 1036
777 <p>Get the maximum supported number of input channels. </p> 1037 <p>Get the maximum supported number of input channels. </p>
778 1038
779 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1039 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">Vamp::Plugin</a>.</p>
780 1040
781 </div> 1041 </div>
782 </div> 1042 </div>
783 <a class="anchor" id="a5a9411305f713b4c9827844b89acd270"></a> 1043 <a id="af67a6cd3afa18895393ec8d4bdec3b4c"></a>
784 <div class="memitem"> 1044 <h2 class="memtitle"><span class="permalink"><a href="#af67a6cd3afa18895393ec8d4bdec3b4c">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
785 <div class="memproto"> 1045
786 <table class="memname"> 1046 <div class="memitem">
787 <tr> 1047 <div class="memproto">
788 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a9411305f713b4c9827844b89acd270">Vamp::HostExt::PluginWrapper::getOutputDescriptors</a> </td> 1048 <table class="mlabels">
789 <td>(</td> 1049 <tr>
790 <td class="paramname"></td><td>)</td> 1050 <td class="mlabels-left">
791 <td> const<code> [virtual]</code></td> 1051 <table class="memname">
792 </tr> 1052 <tr>
793 </table> 1053 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
794 </div> 1054 <td>(</td>
795 <div class="memdoc"> 1055 <td class="paramname"></td><td>)</td>
1056 <td> const</td>
1057 </tr>
1058 </table>
1059 </td>
1060 <td class="mlabels-right">
1061 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1062 </tr>
1063 </table>
1064 </div><div class="memdoc">
796 1065
797 <p>Get the outputs of this plugin. </p> 1066 <p>Get the outputs of this plugin. </p>
798 <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_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call. </p> 1067 <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_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data. ">process()</a> call. </p>
799 1068
800 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 1069 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
801 1070
802 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 1071 </div>
803 1072 </div>
804 </div> 1073 <a id="a6bd72d6dfb3047524dbe8ae3294527cf"></a>
805 </div> 1074 <h2 class="memtitle"><span class="permalink"><a href="#a6bd72d6dfb3047524dbe8ae3294527cf">&#9670;&nbsp;</a></span>process()</h2>
806 <a class="anchor" id="a6bd72d6dfb3047524dbe8ae3294527cf"></a> 1075
807 <div class="memitem"> 1076 <div class="memitem">
808 <div class="memproto"> 1077 <div class="memproto">
809 <table class="memname"> 1078 <table class="mlabels">
810 <tr> 1079 <tr>
811 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper::process</a> </td> 1080 <td class="mlabels-left">
1081 <table class="memname">
1082 <tr>
1083 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::process </td>
812 <td>(</td> 1084 <td>(</td>
813 <td class="paramtype">const float *const *&#160;</td> 1085 <td class="paramtype">const float *const *&#160;</td>
814 <td class="paramname"><em>inputBuffers</em>, </td> 1086 <td class="paramname"><em>inputBuffers</em>, </td>
815 </tr> 1087 </tr>
816 <tr> 1088 <tr>
820 <td class="paramname"><em>timestamp</em>&#160;</td> 1092 <td class="paramname"><em>timestamp</em>&#160;</td>
821 </tr> 1093 </tr>
822 <tr> 1094 <tr>
823 <td></td> 1095 <td></td>
824 <td>)</td> 1096 <td>)</td>
825 <td></td><td><code> [virtual]</code></td> 1097 <td></td><td></td>
826 </tr> 1098 </tr>
827 </table> 1099 </table>
828 </div> 1100 </td>
829 <div class="memdoc"> 1101 <td class="mlabels-right">
1102 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1103 </tr>
1104 </table>
1105 </div><div class="memdoc">
830 1106
831 <p>Process a single block of input data. </p> 1107 <p>Process a single block of input data. </p>
832 <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> 1108 <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>
833 <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> 1109 <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>
834 <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> 1110 <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>
835 1111
836 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 1112 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
837 1113
838 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a55058a20c1f8bffc0dc927350df778a0">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html#a6ff37bf754ff8711dbcb2f020fa3902c">Vamp::HostExt::PluginChannelAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ab36a81ac9a0ded8d83c6b855263c0231">Vamp::HostExt::PluginInputDomainAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter</a>.</p> 1114 </div>
839 1115 </div>
840 </div> 1116 <a id="a2bc8c0992e64f06991fb7cf89f99857e"></a>
841 </div> 1117 <h2 class="memtitle"><span class="permalink"><a href="#a2bc8c0992e64f06991fb7cf89f99857e">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
842 <a class="anchor" id="a2bc8c0992e64f06991fb7cf89f99857e"></a> 1118
843 <div class="memitem"> 1119 <div class="memitem">
844 <div class="memproto"> 1120 <div class="memproto">
845 <table class="memname"> 1121 <table class="mlabels">
846 <tr> 1122 <tr>
847 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper::getRemainingFeatures</a> </td> 1123 <td class="mlabels-left">
848 <td>(</td> 1124 <table class="memname">
849 <td class="paramname"></td><td>)</td> 1125 <tr>
850 <td><code> [virtual]</code></td> 1126 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginWrapper::getRemainingFeatures </td>
851 </tr> 1127 <td>(</td>
852 </table> 1128 <td class="paramname"></td><td>)</td>
853 </div> 1129 <td></td>
854 <div class="memdoc"> 1130 </tr>
1131 </table>
1132 </td>
1133 <td class="mlabels-right">
1134 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1135 </tr>
1136 </table>
1137 </div><div class="memdoc">
855 1138
856 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 1139 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
857 1140
858 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 1141 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
859 1142
860 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a28423951b2eda1a1fc371485434f417b">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter</a>.</p> 1143 </div>
861 1144 </div>
862 </div> 1145 <a id="a653d0308e8e34881a8749b7631d00f05"></a>
863 </div> 1146 <h2 class="memtitle"><span class="permalink"><a href="#a653d0308e8e34881a8749b7631d00f05">&#9670;&nbsp;</a></span>getWrapper()</h2>
864 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a> 1147
865 <div class="memitem"> 1148 <div class="memitem">
866 <div class="memproto"> 1149 <div class="memproto">
867 <div class="memtemplate"> 1150 <div class="memtemplate">
868 template&lt;typename WrapperType &gt; </div> 1151 template&lt;typename WrapperType &gt; </div>
869 <table class="memname"> 1152 <table class="mlabels">
870 <tr> 1153 <tr>
871 <td class="memname">WrapperType* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">Vamp::HostExt::PluginWrapper::getWrapper</a> </td> 1154 <td class="mlabels-left">
872 <td>(</td> 1155 <table class="memname">
873 <td class="paramname"></td><td>)</td> 1156 <tr>
874 <td><code> [inline]</code></td> 1157 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
875 </tr> 1158 <td>(</td>
876 </table> 1159 <td class="paramname"></td><td>)</td>
877 </div> 1160 <td></td>
878 <div class="memdoc"> 1161 </tr>
1162 </table>
1163 </td>
1164 <td class="mlabels-right">
1165 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
1166 </tr>
1167 </table>
1168 </div><div class="memdoc">
879 1169
880 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p> 1170 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
881 <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> 1171 <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>
882 1172
883 <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> 1173 <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>
884 1174
885 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>.</p> 1175 <p class="reference">References <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>.</p>
886 1176
887 <p>Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1177 <p class="reference">Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
888 1178
889 </div> 1179 </div>
890 </div> 1180 </div>
891 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 1181 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
892 <div class="memitem"> 1182 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
893 <div class="memproto"> 1183
894 <table class="memname"> 1184 <div class="memitem">
895 <tr> 1185 <div class="memproto">
896 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 1186 <table class="mlabels">
897 <td>(</td> 1187 <tr>
898 <td class="paramname"></td><td>)</td> 1188 <td class="mlabels-left">
899 <td> const<code> [inline, virtual, inherited]</code></td> 1189 <table class="memname">
900 </tr> 1190 <tr>
901 </table> 1191 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
902 </div> 1192 <td>(</td>
903 <div class="memdoc"> 1193 <td class="paramname"></td><td>)</td>
904 1194 <td> const</td>
905 <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> 1195 </tr>
1196 </table>
1197 </td>
1198 <td class="mlabels-right">
1199 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1200 </tr>
1201 </table>
1202 </div><div class="memdoc">
1203
1204 <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>
906 <p>Do not reimplement this function in your subclass. </p> 1205 <p>Do not reimplement this function in your subclass. </p>
907 1206
908 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1207 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
909 1208
910 <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> 1209 <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>
911 1210
912 </div> 1211 </div>
913 </div> 1212 </div>
914 <hr/><h2>Member Data Documentation</h2> 1213 <h2 class="groupheader">Member Data Documentation</h2>
915 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a> 1214 <a id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a>
916 <div class="memitem"> 1215 <h2 class="memtitle"><span class="permalink"><a href="#ab4e40ecd98b445e1a2aa9e7baa280ea2">&#9670;&nbsp;</a></span>m_plugin</h2>
917 <div class="memproto"> 1216
918 <table class="memname"> 1217 <div class="memitem">
919 <tr> 1218 <div class="memproto">
920 <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]</code></td> 1219 <table class="mlabels">
921 </tr> 1220 <tr>
922 </table> 1221 <td class="mlabels-left">
923 </div> 1222 <table class="memname">
924 <div class="memdoc"> 1223 <tr>
925 1224 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginWrapper::m_plugin</td>
926 <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> 1225 </tr>
927 1226 </table>
928 </div> 1227 </td>
929 </div> 1228 <td class="mlabels-right">
930 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1229 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
931 <div class="memitem"> 1230 </tr>
932 <div class="memproto"> 1231 </table>
933 <table class="memname"> 1232 </div><div class="memdoc">
934 <tr> 1233
935 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1234 <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>
936 </tr> 1235
937 </table> 1236 </div>
938 </div> 1237 </div>
939 <div class="memdoc"> 1238 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
940 1239 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
941 <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> 1240
942 1241 <div class="memitem">
943 <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> 1242 <div class="memproto">
1243 <table class="mlabels">
1244 <tr>
1245 <td class="mlabels-left">
1246 <table class="memname">
1247 <tr>
1248 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1249 </tr>
1250 </table>
1251 </td>
1252 <td class="mlabels-right">
1253 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1254 </tr>
1255 </table>
1256 </div><div class="memdoc">
1257
1258 <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>
1259
1260 <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>
944 1261
945 </div> 1262 </div>
946 </div> 1263 </div>
947 <hr/>The documentation for this class was generated from the following file:<ul> 1264 <hr/>The documentation for this class was generated from the following file:<ul>
948 <li><a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a></li> 1265 <li><a class="el" href="PluginWrapper_8h_source.html">PluginWrapper.h</a></li>
949 </ul> 1266 </ul>
950 </div><!-- contents --> 1267 </div><!-- contents -->
951 </div> 1268 </div><!-- doc-content -->
952 <div id="nav-path" class="navpath"> 1269 <!-- start footer part -->
953 <ul> 1270 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
954 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 1271 <ul>
955 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li> 1272 <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_1PluginWrapper.html">PluginWrapper</a></li>
956 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">PluginWrapper</a> </li> 1273 <li class="footer">Generated by
957
958 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
959 <a href="http://www.doxygen.org/index.html"> 1274 <a href="http://www.doxygen.org/index.html">
960 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1275 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
961 </ul> 1276 </ul>
962 </div> 1277 </div>
963
964
965 </body> 1278 </body>
966 </html> 1279 </html>