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

Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: Vamp::HostExt::PluginSummarisingAdapter Class Reference</title> 8 <title>VampPluginSDK: Vamp::HostExt::PluginSummarisingAdapter 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_1PluginSummarisingAdapter.html',''); 58 $(document).ready(function(){initNavTree('classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-types">Public Types</a> &#124; 63 <a href="#pub-types">Public Types</a> &#124;
78 <a href="#pub-methods">Public Member Functions</a> &#124; 64 <a href="#pub-methods">Public Member Functions</a> &#124;
79 <a href="#pro-attribs">Protected Attributes</a> </div> 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
66 <a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html">List of all members</a> </div>
80 <div class="headertitle"> 67 <div class="headertitle">
81 <div class="title">Vamp::HostExt::PluginSummarisingAdapter Class Reference</div> </div> 68 <div class="title">Vamp::HostExt::PluginSummarisingAdapter Class Reference</div> </div>
82 </div><!--header--> 69 </div><!--header-->
83 <div class="contents"> 70 <div class="contents">
84 71
89 <div class="dynheader"> 76 <div class="dynheader">
90 Inheritance diagram for Vamp::HostExt::PluginSummarisingAdapter:</div> 77 Inheritance diagram for Vamp::HostExt::PluginSummarisingAdapter:</div>
91 <div class="dyncontent"> 78 <div class="dyncontent">
92 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map" alt="Inheritance graph"/></div> 79 <div class="center"><img src="classVamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map" alt="Inheritance graph"/></div>
93 <map name="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map"> 80 <map name="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map">
94 <area shape="rect" id="node2" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="40,155,224,181"/><area shape="rect" id="node4" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="86,81,177,106"/><area shape="rect" id="node6" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="73,6,191,31"/></map> 81 <area shape="rect" id="node2" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. " alt="" coords="19,152,210,177"/>
82 <area shape="rect" id="node3" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="67,79,162,104"/>
83 <area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="53,5,176,31"/>
84 </map>
95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> 85 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
96
97 <p><a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html">List of all members.</a></p>
98 <table class="memberdecls"> 86 <table class="memberdecls">
99 <tr><td colspan="2"><h2><a name="pub-types"></a> 87 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
100 Public Types</h2></td></tr> 88 Public Types</h2></td></tr>
101 <tr class="memitem:af504f810448961fc489e9b6572471705"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> { <br/> 89 <tr class="memitem:af504f810448961fc489e9b6572471705"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> { <br />
102 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c">Minimum</a> = 0, 90 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c">Minimum</a> = 0,
103 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9">Maximum</a> = 1, 91 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9">Maximum</a> = 1,
104 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75">Mean</a> = 2, 92 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75">Mean</a> = 2,
105 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195">Median</a> = 3, 93 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195">Median</a> = 3,
106 <br/> 94 <br />
107 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614">Mode</a> = 4, 95 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614">Mode</a> = 4,
108 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b">Sum</a> = 5, 96 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b">Sum</a> = 5,
109 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075">Variance</a> = 6, 97 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075">Variance</a> = 6,
110 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7">StandardDeviation</a> = 7, 98 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7">StandardDeviation</a> = 7,
111 <br/> 99 <br />
112 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6">Count</a> = 8, 100 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6">Count</a> = 8,
113 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c">UnknownSummaryType</a> = 999 101 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c">UnknownSummaryType</a> = 999
114 <br/> 102 <br />
115 }</td></tr> 103 }</td></tr>
116 <tr class="memitem:a294e9eed9c541dcedbaa4f2dfda1ac76"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> { <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a> = 0, 104 <tr class="separator:af504f810448961fc489e9b6572471705"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa">ContinuousTimeAverage</a> = 1 105 <tr class="memitem:a294e9eed9c541dcedbaa4f2dfda1ac76"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> { <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a> = 0,
118 }</td></tr> 106 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa">ContinuousTimeAverage</a> = 1
119 <tr class="memdesc:a294e9eed9c541dcedbaa4f2dfda1ac76"><td class="mdescLeft">&#160;</td><td class="mdescRight">AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. <a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">More...</a><br/></td></tr> 107 }<tr class="memdesc:a294e9eed9c541dcedbaa4f2dfda1ac76"><td class="mdescLeft">&#160;</td><td class="mdescRight">AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. <a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">More...</a><br /></td></tr>
108 </td></tr>
109 <tr class="separator:a294e9eed9c541dcedbaa4f2dfda1ac76"><td class="memSeparator" colspan="2">&#160;</td></tr>
120 <tr class="memitem:a74e7f93c745802a2409185b63922466b"><td class="memItemLeft" align="right" valign="top">typedef std::set&lt; <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a></td></tr> 110 <tr class="memitem:a74e7f93c745802a2409185b63922466b"><td class="memItemLeft" align="right" valign="top">typedef std::set&lt; <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a></td></tr>
111 <tr class="separator:a74e7f93c745802a2409185b63922466b"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <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>, 112 <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>,
122 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 113 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
123 }</td></tr> 114 }</td></tr>
124 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 115 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 &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> 116 <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>
117 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <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> 118 <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>
127 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/> 119 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
128 <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> 120 <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>
129 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 121 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 &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> 122 <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>
123 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <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> 124 <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>
132 <tr><td colspan="2"><h2><a name="pub-methods"></a> 125 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 </table><table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
133 Public Member Functions</h2></td></tr> 128 Public Member Functions</h2></td></tr>
134 <tr class="memitem:a31b41f54560a2ae6c3ec1a945f3f1d68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a31b41f54560a2ae6c3ec1a945f3f1d68">PluginSummarisingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 129 <tr class="memitem:a31b41f54560a2ae6c3ec1a945f3f1d68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a31b41f54560a2ae6c3ec1a945f3f1d68">PluginSummarisingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr>
135 <tr class="memdesc:a31b41f54560a2ae6c3ec1a945f3f1d68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> wrapping the given plugin. <a href="#a31b41f54560a2ae6c3ec1a945f3f1d68"></a><br/></td></tr> 130 <tr class="memdesc:a31b41f54560a2ae6c3ec1a945f3f1d68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> wrapping the given plugin. <a href="#a31b41f54560a2ae6c3ec1a945f3f1d68">More...</a><br /></td></tr>
131 <tr class="separator:a31b41f54560a2ae6c3ec1a945f3f1d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:a47846e7cc0ef4a29335e08b9645316d0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a47846e7cc0ef4a29335e08b9645316d0">~PluginSummarisingAdapter</a> ()</td></tr> 132 <tr class="memitem:a47846e7cc0ef4a29335e08b9645316d0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a47846e7cc0ef4a29335e08b9645316d0">~PluginSummarisingAdapter</a> ()</td></tr>
133 <tr class="separator:a47846e7cc0ef4a29335e08b9645316d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:a1e994576d43efe103bf8f83b69716745"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 134 <tr class="memitem:a1e994576d43efe103bf8f83b69716745"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
138 <tr class="memdesc:a1e994576d43efe103bf8f83b69716745"><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="#a1e994576d43efe103bf8f83b69716745"></a><br/></td></tr> 135 <tr class="memdesc:a1e994576d43efe103bf8f83b69716745"><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="#a1e994576d43efe103bf8f83b69716745">More...</a><br /></td></tr>
136 <tr class="separator:a1e994576d43efe103bf8f83b69716745"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <tr class="memitem:a3402381d145d507bd26d1a67e3616911"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911">reset</a> ()</td></tr> 137 <tr class="memitem:a3402381d145d507bd26d1a67e3616911"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911">reset</a> ()</td></tr>
140 <tr class="memdesc:a3402381d145d507bd26d1a67e3616911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a3402381d145d507bd26d1a67e3616911"></a><br/></td></tr> 138 <tr class="memdesc:a3402381d145d507bd26d1a67e3616911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a3402381d145d507bd26d1a67e3616911">More...</a><br /></td></tr>
139 <tr class="separator:a3402381d145d507bd26d1a67e3616911"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a3314b456a4780601c021dac25b478846"><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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 140 <tr class="memitem:a3314b456a4780601c021dac25b478846"><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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
142 <tr class="memdesc:a3314b456a4780601c021dac25b478846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a3314b456a4780601c021dac25b478846"></a><br/></td></tr> 141 <tr class="memdesc:a3314b456a4780601c021dac25b478846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a3314b456a4780601c021dac25b478846">More...</a><br /></td></tr>
142 <tr class="separator:a3314b456a4780601c021dac25b478846"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:ae9dcbd1ba8197ff90b4fc6bf7ade7688"><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_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688">getRemainingFeatures</a> ()</td></tr> 143 <tr class="memitem:ae9dcbd1ba8197ff90b4fc6bf7ade7688"><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_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688">getRemainingFeatures</a> ()</td></tr>
144 <tr class="memdesc:ae9dcbd1ba8197ff90b4fc6bf7ade7688"><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="#ae9dcbd1ba8197ff90b4fc6bf7ade7688"></a><br/></td></tr> 144 <tr class="memdesc:ae9dcbd1ba8197ff90b4fc6bf7ade7688"><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="#ae9dcbd1ba8197ff90b4fc6bf7ade7688">More...</a><br /></td></tr>
145 <tr class="separator:ae9dcbd1ba8197ff90b4fc6bf7ade7688"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:a1a659500ca1290a228c0b9b91f6ac0b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1a659500ca1290a228c0b9b91f6ac0b7">setSummarySegmentBoundaries</a> (const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;)</td></tr> 146 <tr class="memitem:a1a659500ca1290a228c0b9b91f6ac0b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1a659500ca1290a228c0b9b91f6ac0b7">setSummarySegmentBoundaries</a> (const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;)</td></tr>
146 <tr class="memdesc:a1a659500ca1290a228c0b9b91f6ac0b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. <a href="#a1a659500ca1290a228c0b9b91f6ac0b7"></a><br/></td></tr> 147 <tr class="memdesc:a1a659500ca1290a228c0b9b91f6ac0b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. <a href="#a1a659500ca1290a228c0b9b91f6ac0b7">More...</a><br /></td></tr>
148 <tr class="separator:a1a659500ca1290a228c0b9b91f6ac0b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:abe13faa68d3244b962dbd362671e23f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#abe13faa68d3244b962dbd362671e23f9">getSummaryForOutput</a> (int output, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a>)</td></tr> 149 <tr class="memitem:abe13faa68d3244b962dbd362671e23f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#abe13faa68d3244b962dbd362671e23f9">getSummaryForOutput</a> (int output, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a>)</td></tr>
148 <tr class="memdesc:abe13faa68d3244b962dbd362671e23f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. <a href="#abe13faa68d3244b962dbd362671e23f9"></a><br/></td></tr> 150 <tr class="memdesc:abe13faa68d3244b962dbd362671e23f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. <a href="#abe13faa68d3244b962dbd362671e23f9">More...</a><br /></td></tr>
151 <tr class="separator:abe13faa68d3244b962dbd362671e23f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"><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_1PluginSummarisingAdapter.html#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b">getSummaryForAllOutputs</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a>)</td></tr> 152 <tr class="memitem:ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"><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_1PluginSummarisingAdapter.html#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b">getSummaryForAllOutputs</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a>)</td></tr>
150 <tr class="memdesc:ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. <a href="#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a><br/></td></tr> 153 <tr class="memdesc:ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. <a href="#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b">More...</a><br /></td></tr>
151 <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> 154 <tr class="separator:ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <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> 155 <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>
153 <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> 156 <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>
154 <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> 157 <tr class="separator:a8838facfe9d88cf36b13c1b42165fc6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <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> 158 <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>
156 <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> 159 <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>
157 <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> 160 <tr class="separator:afa79272f991fb720ddd09784be1b3cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <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> 161 <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>
159 <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> 162 <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>
160 <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> 163 <tr class="separator:ad9312a38c199004c7bad0c42f590393f"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <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> 164 <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>
162 <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> 165 <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>
163 <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> 166 <tr class="separator:aa2b40de6e240d872997a63dd4a301ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <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> 167 <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>
165 <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> 168 <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>
166 <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> 169 <tr class="separator:ad6e453c30b265a2daf243f953b35c815"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <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> 170 <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>
168 <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> 171 <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>
169 <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> 172 <tr class="separator:af9b2f01063828ef0745dc2623fc8dd42"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <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> 173 <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>
174 <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>
175 <tr class="separator:a9537de27c826a1441b2d3643df4880bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <tr class="separator:aea9c238f86de65d3380fa887bb9e47e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
179 <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>
180 <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>
181 <tr class="separator:ab2b67205d86e921cb0a9bd1f819d2cf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 <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>
183 <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>
184 <tr class="separator:a5c0a4d72a25fded51829de21771de521"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <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> 185 <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>
172 <tr class="memdesc:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5"></a><br/></td></tr> 186 <tr class="memdesc:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5">More...</a><br /></td></tr>
173 <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> 187 <tr class="separator:a651b15a5dc4c27942ac0c87c6092bfe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <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> 188 <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>
175 <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> 189 <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>
176 <tr class="memdesc:a7a312dd42d161064b70afd7ff24c0651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr> 190 <tr class="separator:aa0b72ea17766266d20539f293ccae7c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
191 <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>
192 <tr class="memdesc:a3936fe2c4b3c960dd244849a7c3320ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a3936fe2c4b3c960dd244849a7c3320ad">More...</a><br /></td></tr>
193 <tr class="separator:a3936fe2c4b3c960dd244849a7c3320ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <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> 194 <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>
178 <tr class="memdesc:a074978333a74fdcf336a8a1d8ea20abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf"></a><br/></td></tr> 195 <tr class="memdesc:a074978333a74fdcf336a8a1d8ea20abf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf">More...</a><br /></td></tr>
179 <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> 196 <tr class="separator:a074978333a74fdcf336a8a1d8ea20abf"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <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> 197 <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>
181 <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> 198 <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>
182 <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> 199 <tr class="separator:adf2ea98d6eeb0435c0c8d7cdc29fed7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <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> 200 <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>
184 <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> 201 <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>
185 <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> 202 <tr class="separator:a94f855a2cf674ccc2e7315484f706d68"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 <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> 203 <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>
187 <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> 204 <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>
188 <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> 205 <tr class="separator:abc0a4e6ce0ae9de39c40725de1f30d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
206 <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>
207 <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>
208 <tr class="separator:acfed040cd91e797ee89d077db22b4a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
209 <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>
210 <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>
211 <tr class="separator:af67a6cd3afa18895393ec8d4bdec3b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
189 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr> 212 <tr class="memitem:a653d0308e8e34881a8749b7631d00f05"><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
190 <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> 213 <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>
191 <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> 214 <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>
192 <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> 215 <tr class="separator:a653d0308e8e34881a8749b7631d00f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 <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> 216 <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>
194 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 217 <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>
218 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
219 </table><table class="memberdecls">
220 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
195 Protected Attributes</h2></td></tr> 221 Protected Attributes</h2></td></tr>
196 <tr class="memitem:af131140817d9f131650af98b6b8d7a94"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94">m_impl</a></td></tr> 222 <tr class="memitem:af131140817d9f131650af98b6b8d7a94"><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94">m_impl</a></td></tr>
223 <tr class="separator:af131140817d9f131650af98b6b8d7a94"><td class="memSeparator" colspan="2">&#160;</td></tr>
197 <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> 224 <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>
225 <tr class="separator:ab4e40ecd98b445e1a2aa9e7baa280ea2"><td class="memSeparator" colspan="2">&#160;</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> 226 <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>
199 </table> 227 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
200 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 228 </table>
229 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
201 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate. </p> 230 <div class="textblock"><p><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate. </p>
202 <p>To make use of <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a>, the host should configure, initialise and run the plugin through the adapter interface just as normal. Then, after the process and getRemainingFeatures methods have been properly called and processing is complete, the host may call getSummaryForOutput or getSummaryForAllOutputs to obtain summarised features: averages, maximum values, etc, depending on the SummaryType passed to the function.</p> 231 <p>To make use of <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a>, the host should configure, initialise and run the plugin through the adapter interface just as normal. Then, after the process and getRemainingFeatures methods have been properly called and processing is complete, the host may call getSummaryForOutput or getSummaryForAllOutputs to obtain summarised features: averages, maximum values, etc, depending on the SummaryType passed to the function.</p>
203 <p>By default <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> calculates a single summary of each output's feature across the whole duration of processed audio. A host needing summaries of sub-segments of the whole audio may call setSummarySegmentBoundaries before retrieving the summaries, providing a list of times such that one summary will be provided for each segment between two consecutive times.</p> 232 <p>By default <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> calculates a single summary of each output's feature across the whole duration of processed audio. A host needing summaries of sub-segments of the whole audio may call setSummarySegmentBoundaries before retrieving the summaries, providing a list of times such that one summary will be provided for each segment between two consecutive times.</p>
204 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> is straightforward rather than fast. It calculates all of the summary types for all outputs always, and then returns only the ones that are requested. It is designed on the basis that, for most features, summarising and storing summarised results is far cheaper than calculating the results in the first place. If this is not true for your particular feature, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> may not be the best approach for you.</p> 233 <p><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> is straightforward rather than fast. It calculates all of the summary types for all outputs always, and then returns only the ones that are requested. It is designed on the basis that, for most features, summarising and storing summarised results is far cheaper than calculating the results in the first place. If this is not true for your particular feature, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> may not be the best approach for you.</p>
205 <dl class="section note"><dt>Note:</dt><dd>This class was introduced in version 2.0 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl> 234 <dl class="section note"><dt>Note</dt><dd>This class was introduced in version 2.0 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
206 235
207 <p>Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00086">86</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p> 236 <p class="definition">Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00086">86</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
208 </div><hr/><h2>Member Typedef Documentation</h2> 237 </div><h2 class="groupheader">Member Typedef Documentation</h2>
209 <a class="anchor" id="a74e7f93c745802a2409185b63922466b"></a> 238 <a id="a74e7f93c745802a2409185b63922466b"></a>
239 <h2 class="memtitle"><span class="permalink"><a href="#a74e7f93c745802a2409185b63922466b">&#9670;&nbsp;</a></span>SegmentBoundaries</h2>
240
210 <div class="memitem"> 241 <div class="memitem">
211 <div class="memproto"> 242 <div class="memproto">
212 <table class="memname"> 243 <table class="memname">
213 <tr> 244 <tr>
214 <td class="memname">typedef std::set&lt;<a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries</a></td> 245 <td class="memname">typedef std::set&lt;<a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&gt; <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries</a></td>
215 </tr> 246 </tr>
216 </table> 247 </table>
217 </div> 248 </div><div class="memdoc">
218 <div class="memdoc"> 249
219 250 <p class="definition">Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00104">104</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
220 <p>Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00104">104</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p> 251
221 252 </div>
222 </div> 253 </div>
223 </div> 254 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
224 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 255 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
225 <div class="memitem"> 256
226 <div class="memproto"> 257 <div class="memitem">
227 <table class="memname"> 258 <div class="memproto">
228 <tr> 259 <table class="mlabels">
229 <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> 260 <tr>
230 </tr> 261 <td class="mlabels-left">
231 </table> 262 <table class="memname">
232 </div> 263 <tr>
233 <div class="memdoc"> 264 <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>
234 265 </tr>
235 <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> 266 </table>
236 267 </td>
237 </div> 268 <td class="mlabels-right">
238 </div> 269 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
239 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 270 </tr>
240 <div class="memitem"> 271 </table>
241 <div class="memproto"> 272 </div><div class="memdoc">
242 <table class="memname"> 273
243 <tr> 274 <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>
244 <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> 275
245 </tr> 276 </div>
246 </table> 277 </div>
247 </div> 278 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
248 <div class="memdoc"> 279 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
249 280
250 <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> 281 <div class="memitem">
251 282 <div class="memproto">
252 </div> 283 <table class="mlabels">
253 </div> 284 <tr>
254 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 285 <td class="mlabels-left">
255 <div class="memitem"> 286 <table class="memname">
256 <div class="memproto"> 287 <tr>
257 <table class="memname"> 288 <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>
258 <tr> 289 </tr>
259 <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> 290 </table>
260 </tr> 291 </td>
261 </table> 292 <td class="mlabels-right">
262 </div> 293 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
263 <div class="memdoc"> 294 </tr>
264 295 </table>
265 <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> 296 </div><div class="memdoc">
266 297
267 </div> 298 <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>
268 </div> 299
269 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 300 </div>
270 <div class="memitem"> 301 </div>
271 <div class="memproto"> 302 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
272 <table class="memname"> 303 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
273 <tr> 304
274 <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> 305 <div class="memitem">
275 </tr> 306 <div class="memproto">
276 </table> 307 <table class="mlabels">
277 </div> 308 <tr>
278 <div class="memdoc"> 309 <td class="mlabels-left">
279 310 <table class="memname">
280 <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> 311 <tr>
281 312 <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>
282 </div> 313 </tr>
283 </div> 314 </table>
284 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 315 </td>
285 <div class="memitem"> 316 <td class="mlabels-right">
286 <div class="memproto"> 317 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
287 <table class="memname"> 318 </tr>
288 <tr> 319 </table>
289 <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> 320 </div><div class="memdoc">
290 </tr> 321
291 </table> 322 <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>
292 </div> 323
293 <div class="memdoc"> 324 </div>
294 325 </div>
295 <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> 326 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
296 327 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
297 </div> 328
298 </div> 329 <div class="memitem">
299 <hr/><h2>Member Enumeration Documentation</h2> 330 <div class="memproto">
300 <a class="anchor" id="af504f810448961fc489e9b6572471705"></a> 331 <table class="mlabels">
332 <tr>
333 <td class="mlabels-left">
334 <table class="memname">
335 <tr>
336 <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>
337 </tr>
338 </table>
339 </td>
340 <td class="mlabels-right">
341 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
342 </tr>
343 </table>
344 </div><div class="memdoc">
345
346 <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>
347
348 </div>
349 </div>
350 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
351 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
352
353 <div class="memitem">
354 <div class="memproto">
355 <table class="mlabels">
356 <tr>
357 <td class="mlabels-left">
358 <table class="memname">
359 <tr>
360 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
361 </tr>
362 </table>
363 </td>
364 <td class="mlabels-right">
365 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
366 </tr>
367 </table>
368 </div><div class="memdoc">
369
370 <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>
371
372 </div>
373 </div>
374 <h2 class="groupheader">Member Enumeration Documentation</h2>
375 <a id="af504f810448961fc489e9b6572471705"></a>
376 <h2 class="memtitle"><span class="permalink"><a href="#af504f810448961fc489e9b6572471705">&#9670;&nbsp;</a></span>SummaryType</h2>
377
301 <div class="memitem"> 378 <div class="memitem">
302 <div class="memproto"> 379 <div class="memproto">
303 <table class="memname"> 380 <table class="memname">
304 <tr> 381 <tr>
305 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">Vamp::HostExt::PluginSummarisingAdapter::SummaryType</a></td> 382 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">Vamp::HostExt::PluginSummarisingAdapter::SummaryType</a></td>
306 </tr> 383 </tr>
307 </table> 384 </table>
308 </div> 385 </div><div class="memdoc">
309 <div class="memdoc"> 386 <table class="fieldtable">
310 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 387 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c"></a>Minimum&#160;</td><td class="fielddoc"></td></tr>
311 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c"></a>Minimum</em>&nbsp;</td><td> 388 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9"></a>Maximum&#160;</td><td class="fielddoc"></td></tr>
312 </td></tr> 389 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75"></a>Mean&#160;</td><td class="fielddoc"></td></tr>
313 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9"></a>Maximum</em>&nbsp;</td><td> 390 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195"></a>Median&#160;</td><td class="fielddoc"></td></tr>
314 </td></tr> 391 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614"></a>Mode&#160;</td><td class="fielddoc"></td></tr>
315 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75"></a>Mean</em>&nbsp;</td><td> 392 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b"></a>Sum&#160;</td><td class="fielddoc"></td></tr>
316 </td></tr> 393 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075"></a>Variance&#160;</td><td class="fielddoc"></td></tr>
317 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195"></a>Median</em>&nbsp;</td><td> 394 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7"></a>StandardDeviation&#160;</td><td class="fielddoc"></td></tr>
318 </td></tr> 395 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6"></a>Count&#160;</td><td class="fielddoc"></td></tr>
319 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614"></a>Mode</em>&nbsp;</td><td> 396 <tr><td class="fieldname"><a id="af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c"></a>UnknownSummaryType&#160;</td><td class="fielddoc"></td></tr>
320 </td></tr> 397 </table>
321 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b"></a>Sum</em>&nbsp;</td><td> 398
322 </td></tr> 399 <p class="definition">Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00121">121</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
323 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075"></a>Variance</em>&nbsp;</td><td> 400
324 </td></tr> 401 </div>
325 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7"></a>StandardDeviation</em>&nbsp;</td><td> 402 </div>
326 </td></tr> 403 <a id="a294e9eed9c541dcedbaa4f2dfda1ac76"></a>
327 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6"></a>Count</em>&nbsp;</td><td> 404 <h2 class="memtitle"><span class="permalink"><a href="#a294e9eed9c541dcedbaa4f2dfda1ac76">&#9670;&nbsp;</a></span>AveragingMethod</h2>
328 </td></tr> 405
329 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c"></a>UnknownSummaryType</em>&nbsp;</td><td>
330 </td></tr>
331 </table>
332 </dd>
333 </dl>
334
335 <p>Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00121">121</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
336
337 </div>
338 </div>
339 <a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76"></a>
340 <div class="memitem"> 406 <div class="memitem">
341 <div class="memproto"> 407 <div class="memproto">
342 <table class="memname"> 408 <table class="memname">
343 <tr> 409 <tr>
344 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod</a></td> 410 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod</a></td>
345 </tr> 411 </tr>
346 </table> 412 </table>
347 </div> 413 </div><div class="memdoc">
348 <div class="memdoc">
349 414
350 <p>AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. </p> 415 <p>AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. </p>
351 <p>If SampleAverage is specified, summary types based on averages will be calculated by treating each result individually without regard to its time: for example, the mean will be the sum of all values divided by the number of values.</p> 416 <p>If SampleAverage is specified, summary types based on averages will be calculated by treating each result individually without regard to its time: for example, the mean will be the sum of all values divided by the number of values.</p>
352 <p>If ContinuousTimeAverage is specified, each feature will be considered to have a duration, either as specified in the feature's duration field, or until the following feature: thus, for example, the mean will be the sum of the products of values and durations, divided by the total duration.</p> 417 <p>If ContinuousTimeAverage is specified, each feature will be considered to have a duration, either as specified in the feature's duration field, or until the following feature: thus, for example, the mean will be the sum of the products of values and durations, divided by the total duration.</p>
353 <p>Although SampleAverage is useful for many types of feature, ContinuousTimeAverage is essential for some situations, for example finding the result that spans the largest proportion of the input given a feature that emits a new result only when the value changes (the modal value integrated over time). </p> 418 <p>Although SampleAverage is useful for many types of feature, ContinuousTimeAverage is essential for some situations, for example finding the result that spans the largest proportion of the input given a feature that emits a new result only when the value changes (the modal value integrated over time). </p>
354 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 419 <table class="fieldtable">
355 <tr><td valign="top"><em><a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36"></a>SampleAverage</em>&nbsp;</td><td> 420 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36"></a>SampleAverage&#160;</td><td class="fielddoc"></td></tr>
356 </td></tr> 421 <tr><td class="fieldname"><a id="a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa"></a>ContinuousTimeAverage&#160;</td><td class="fielddoc"></td></tr>
357 <tr><td valign="top"><em><a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa"></a>ContinuousTimeAverage</em>&nbsp;</td><td> 422 </table>
358 </td></tr> 423
359 </table> 424 <p class="definition">Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00157">157</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
360 </dd> 425
361 </dl> 426 </div>
362 427 </div>
363 <p>Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00157">157</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p> 428 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
364 429 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
365 </div> 430
366 </div> 431 <div class="memitem">
367 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 432 <div class="memproto">
368 <div class="memitem"> 433 <table class="mlabels">
369 <div class="memproto"> 434 <tr>
370 <table class="memname"> 435 <td class="mlabels-left">
371 <tr> 436 <table class="memname">
372 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 437 <tr>
373 </tr> 438 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
374 </table> 439 </tr>
375 </div> 440 </table>
376 <div class="memdoc"> 441 </td>
377 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 442 <td class="mlabels-right">
378 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 443 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
379 </td></tr> 444 </tr>
380 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 445 </table>
381 </td></tr> 446 </div><div class="memdoc">
382 </table> 447 <table class="fieldtable">
383 </dd> 448 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
384 </dl> 449 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
385 450 </table>
386 <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> 451
387 452 <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>
388 </div> 453
389 </div> 454 </div>
390 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 455 </div>
391 <a class="anchor" id="a31b41f54560a2ae6c3ec1a945f3f1d68"></a> 456 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
392 <div class="memitem"> 457 <a id="a31b41f54560a2ae6c3ec1a945f3f1d68"></a>
393 <div class="memproto"> 458 <h2 class="memtitle"><span class="permalink"><a href="#a31b41f54560a2ae6c3ec1a945f3f1d68">&#9670;&nbsp;</a></span>PluginSummarisingAdapter()</h2>
394 <table class="memname"> 459
395 <tr> 460 <div class="memitem">
396 <td class="memname"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a31b41f54560a2ae6c3ec1a945f3f1d68">Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter</a> </td> 461 <div class="memproto">
462 <table class="memname">
463 <tr>
464 <td class="memname">Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter </td>
397 <td>(</td> 465 <td>(</td>
398 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td> 466 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
399 <td class="paramname"><em>plugin</em></td><td>)</td> 467 <td class="paramname"><em>plugin</em></td><td>)</td>
400 <td></td> 468 <td></td>
401 </tr> 469 </tr>
402 </table> 470 </table>
403 </div> 471 </div><div class="memdoc">
404 <div class="memdoc">
405 472
406 <p>Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> wrapping the given plugin. </p> 473 <p>Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> wrapping the given plugin. </p>
407 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p> 474 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p>
408 475
409 </div> 476 </div>
410 </div> 477 </div>
411 <a class="anchor" id="a47846e7cc0ef4a29335e08b9645316d0"></a> 478 <a id="a47846e7cc0ef4a29335e08b9645316d0"></a>
412 <div class="memitem"> 479 <h2 class="memtitle"><span class="permalink"><a href="#a47846e7cc0ef4a29335e08b9645316d0">&#9670;&nbsp;</a></span>~PluginSummarisingAdapter()</h2>
413 <div class="memproto"> 480
414 <table class="memname"> 481 <div class="memitem">
415 <tr> 482 <div class="memproto">
416 <td class="memname">virtual <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a47846e7cc0ef4a29335e08b9645316d0">Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter</a> </td> 483 <table class="mlabels">
417 <td>(</td> 484 <tr>
418 <td class="paramname"></td><td>)</td> 485 <td class="mlabels-left">
419 <td><code> [virtual]</code></td> 486 <table class="memname">
420 </tr> 487 <tr>
421 </table> 488 <td class="memname">virtual Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter </td>
422 </div> 489 <td>(</td>
423 <div class="memdoc"> 490 <td class="paramname"></td><td>)</td>
424 491 <td></td>
425 </div> 492 </tr>
426 </div> 493 </table>
427 <hr/><h2>Member Function Documentation</h2> 494 </td>
428 <a class="anchor" id="a1e994576d43efe103bf8f83b69716745"></a> 495 <td class="mlabels-right">
429 <div class="memitem"> 496 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
430 <div class="memproto"> 497 </tr>
431 <table class="memname"> 498 </table>
432 <tr> 499 </div><div class="memdoc">
433 <td class="memname">bool <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745">Vamp::HostExt::PluginSummarisingAdapter::initialise</a> </td> 500
501 </div>
502 </div>
503 <h2 class="groupheader">Member Function Documentation</h2>
504 <a id="a1e994576d43efe103bf8f83b69716745"></a>
505 <h2 class="memtitle"><span class="permalink"><a href="#a1e994576d43efe103bf8f83b69716745">&#9670;&nbsp;</a></span>initialise()</h2>
506
507 <div class="memitem">
508 <div class="memproto">
509 <table class="mlabels">
510 <tr>
511 <td class="mlabels-left">
512 <table class="memname">
513 <tr>
514 <td class="memname">bool Vamp::HostExt::PluginSummarisingAdapter::initialise </td>
434 <td>(</td> 515 <td>(</td>
435 <td class="paramtype">size_t&#160;</td> 516 <td class="paramtype">size_t&#160;</td>
436 <td class="paramname"><em>inputChannels</em>, </td> 517 <td class="paramname"><em>inputChannels</em>, </td>
437 </tr> 518 </tr>
438 <tr> 519 <tr>
448 <td class="paramname"><em>blockSize</em>&#160;</td> 529 <td class="paramname"><em>blockSize</em>&#160;</td>
449 </tr> 530 </tr>
450 <tr> 531 <tr>
451 <td></td> 532 <td></td>
452 <td>)</td> 533 <td>)</td>
453 <td></td><td><code> [virtual]</code></td> 534 <td></td><td></td>
454 </tr> 535 </tr>
455 </table> 536 </table>
456 </div> 537 </td>
457 <div class="memdoc"> 538 <td class="mlabels-right">
539 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
540 </tr>
541 </table>
542 </div><div class="memdoc">
458 543
459 <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> 544 <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>
460 <p>The input sample rate should have been already specified at construction time.</p> 545 <p>The input sample rate should have been already specified at construction time.</p>
461 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> 546 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
462 547
463 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> 548 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
464 549
465 </div> 550 </div>
466 </div> 551 </div>
467 <a class="anchor" id="a3402381d145d507bd26d1a67e3616911"></a> 552 <a id="a3402381d145d507bd26d1a67e3616911"></a>
468 <div class="memitem"> 553 <h2 class="memtitle"><span class="permalink"><a href="#a3402381d145d507bd26d1a67e3616911">&#9670;&nbsp;</a></span>reset()</h2>
469 <div class="memproto"> 554
470 <table class="memname"> 555 <div class="memitem">
471 <tr> 556 <div class="memproto">
472 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3402381d145d507bd26d1a67e3616911">Vamp::HostExt::PluginSummarisingAdapter::reset</a> </td> 557 <table class="mlabels">
473 <td>(</td> 558 <tr>
474 <td class="paramname"></td><td>)</td> 559 <td class="mlabels-left">
475 <td><code> [virtual]</code></td> 560 <table class="memname">
476 </tr> 561 <tr>
477 </table> 562 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::reset </td>
478 </div> 563 <td>(</td>
479 <div class="memdoc"> 564 <td class="paramname"></td><td>)</td>
565 <td></td>
566 </tr>
567 </table>
568 </td>
569 <td class="mlabels-right">
570 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
571 </tr>
572 </table>
573 </div><div class="memdoc">
480 574
481 <p>Reset the plugin after use, to prepare it for another clean run. </p> 575 <p>Reset the plugin after use, to prepare it for another clean run. </p>
482 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 576 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
483 577
484 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> 578 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
485 579
486 </div> 580 </div>
487 </div> 581 </div>
488 <a class="anchor" id="a3314b456a4780601c021dac25b478846"></a> 582 <a id="a3314b456a4780601c021dac25b478846"></a>
489 <div class="memitem"> 583 <h2 class="memtitle"><span class="permalink"><a href="#a3314b456a4780601c021dac25b478846">&#9670;&nbsp;</a></span>process()</h2>
490 <div class="memproto"> 584
491 <table class="memname"> 585 <div class="memitem">
492 <tr> 586 <div class="memproto">
493 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846">Vamp::HostExt::PluginSummarisingAdapter::process</a> </td> 587 <table class="mlabels">
588 <tr>
589 <td class="mlabels-left">
590 <table class="memname">
591 <tr>
592 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::process </td>
494 <td>(</td> 593 <td>(</td>
495 <td class="paramtype">const float *const *&#160;</td> 594 <td class="paramtype">const float *const *&#160;</td>
496 <td class="paramname"><em>inputBuffers</em>, </td> 595 <td class="paramname"><em>inputBuffers</em>, </td>
497 </tr> 596 </tr>
498 <tr> 597 <tr>
502 <td class="paramname"><em>timestamp</em>&#160;</td> 601 <td class="paramname"><em>timestamp</em>&#160;</td>
503 </tr> 602 </tr>
504 <tr> 603 <tr>
505 <td></td> 604 <td></td>
506 <td>)</td> 605 <td>)</td>
507 <td></td><td><code> [virtual]</code></td> 606 <td></td><td></td>
508 </tr> 607 </tr>
509 </table> 608 </table>
510 </div> 609 </td>
511 <div class="memdoc"> 610 <td class="mlabels-right">
611 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
612 </tr>
613 </table>
614 </div><div class="memdoc">
512 615
513 <p>Process a single block of input data. </p> 616 <p>Process a single block of input data. </p>
514 <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> 617 <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>
515 <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> 618 <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>
516 <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> 619 <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>
517 620
518 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p> 621 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
519 622
520 </div> 623 </div>
521 </div> 624 </div>
522 <a class="anchor" id="ae9dcbd1ba8197ff90b4fc6bf7ade7688"></a> 625 <a id="ae9dcbd1ba8197ff90b4fc6bf7ade7688"></a>
523 <div class="memitem"> 626 <h2 class="memtitle"><span class="permalink"><a href="#ae9dcbd1ba8197ff90b4fc6bf7ade7688">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
524 <div class="memproto"> 627
525 <table class="memname"> 628 <div class="memitem">
526 <tr> 629 <div class="memproto">
527 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688">Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures</a> </td> 630 <table class="mlabels">
528 <td>(</td> 631 <tr>
529 <td class="paramname"></td><td>)</td> 632 <td class="mlabels-left">
530 <td><code> [virtual]</code></td> 633 <table class="memname">
531 </tr> 634 <tr>
532 </table> 635 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures </td>
533 </div> 636 <td>(</td>
534 <div class="memdoc"> 637 <td class="paramname"></td><td>)</td>
638 <td></td>
639 </tr>
640 </table>
641 </td>
642 <td class="mlabels-right">
643 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
644 </tr>
645 </table>
646 </div><div class="memdoc">
535 647
536 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 648 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
537 649
538 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p> 650 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
539 651
540 </div> 652 </div>
541 </div> 653 </div>
542 <a class="anchor" id="a1a659500ca1290a228c0b9b91f6ac0b7"></a> 654 <a id="a1a659500ca1290a228c0b9b91f6ac0b7"></a>
543 <div class="memitem"> 655 <h2 class="memtitle"><span class="permalink"><a href="#a1a659500ca1290a228c0b9b91f6ac0b7">&#9670;&nbsp;</a></span>setSummarySegmentBoundaries()</h2>
544 <div class="memproto"> 656
545 <table class="memname"> 657 <div class="memitem">
546 <tr> 658 <div class="memproto">
547 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1a659500ca1290a228c0b9b91f6ac0b7">Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries</a> </td> 659 <table class="memname">
660 <tr>
661 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries </td>
548 <td>(</td> 662 <td>(</td>
549 <td class="paramtype">const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;&#160;</td> 663 <td class="paramtype">const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;&#160;</td>
550 <td class="paramname"></td><td>)</td> 664 <td class="paramname"></td><td>)</td>
551 <td></td> 665 <td></td>
552 </tr> 666 </tr>
553 </table> 667 </table>
554 </div> 668 </div><div class="memdoc">
555 <div class="memdoc">
556 669
557 <p>Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. </p> 670 <p>Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. </p>
558 <p>This function must be called before getSummaryForOutput or getSummaryForAllOutputs.</p> 671 <p>This function must be called before getSummaryForOutput or getSummaryForAllOutputs.</p>
559 <p>Note that you cannot retrieve results with multiple different segmentations by repeatedly calling this function followed by one of the getSummary functions. The summaries are all calculated at the first call to any getSummary function, and once the summaries have been calculated, they remain calculated. </p> 672 <p>Note that you cannot retrieve results with multiple different segmentations by repeatedly calling this function followed by one of the getSummary functions. The summaries are all calculated at the first call to any getSummary function, and once the summaries have been calculated, they remain calculated. </p>
560 673
561 </div> 674 </div>
562 </div> 675 </div>
563 <a class="anchor" id="abe13faa68d3244b962dbd362671e23f9"></a> 676 <a id="abe13faa68d3244b962dbd362671e23f9"></a>
564 <div class="memitem"> 677 <h2 class="memtitle"><span class="permalink"><a href="#abe13faa68d3244b962dbd362671e23f9">&#9670;&nbsp;</a></span>getSummaryForOutput()</h2>
565 <div class="memproto"> 678
566 <table class="memname"> 679 <div class="memitem">
567 <tr> 680 <div class="memproto">
568 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#abe13faa68d3244b962dbd362671e23f9">Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput</a> </td> 681 <table class="memname">
682 <tr>
683 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput </td>
569 <td>(</td> 684 <td>(</td>
570 <td class="paramtype">int&#160;</td> 685 <td class="paramtype">int&#160;</td>
571 <td class="paramname"><em>output</em>, </td> 686 <td class="paramname"><em>output</em>, </td>
572 </tr> 687 </tr>
573 <tr> 688 <tr>
586 <td></td> 701 <td></td>
587 <td>)</td> 702 <td>)</td>
588 <td></td><td></td> 703 <td></td><td></td>
589 </tr> 704 </tr>
590 </table> 705 </table>
591 </div> 706 </div><div class="memdoc">
592 <div class="memdoc">
593 707
594 <p>Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. </p> 708 <p>Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. </p>
595 <p>The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data.">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. </p> 709 <p>The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data. ">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. </p>
596 710
597 </div> 711 </div>
598 </div> 712 </div>
599 <a class="anchor" id="ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a> 713 <a id="ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a>
600 <div class="memitem"> 714 <h2 class="memtitle"><span class="permalink"><a href="#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b">&#9670;&nbsp;</a></span>getSummaryForAllOutputs()</h2>
601 <div class="memproto"> 715
602 <table class="memname"> 716 <div class="memitem">
603 <tr> 717 <div class="memproto">
604 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ac3f93d9ca2d25c9fdc80d0ba10eaaa6b">Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs</a> </td> 718 <table class="memname">
719 <tr>
720 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs </td>
605 <td>(</td> 721 <td>(</td>
606 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a>&#160;</td> 722 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a>&#160;</td>
607 <td class="paramname"><em>type</em>, </td> 723 <td class="paramname"><em>type</em>, </td>
608 </tr> 724 </tr>
609 <tr> 725 <tr>
616 <td></td> 732 <td></td>
617 <td>)</td> 733 <td>)</td>
618 <td></td><td></td> 734 <td></td><td></td>
619 </tr> 735 </tr>
620 </table> 736 </table>
621 </div> 737 </div><div class="memdoc">
622 <div class="memdoc">
623 738
624 <p>Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. </p> 739 <p>Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. </p>
625 <p>The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data.">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. </p> 740 <p>The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data. ">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#ae9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features derived from the co...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. </p>
626 741
627 </div> 742 </div>
628 </div> 743 </div>
629 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a> 744 <a id="a8838facfe9d88cf36b13c1b42165fc6d"></a>
630 <div class="memitem"> 745 <h2 class="memtitle"><span class="permalink"><a href="#a8838facfe9d88cf36b13c1b42165fc6d">&#9670;&nbsp;</a></span>getInputDomain()</h2>
631 <div class="memproto"> 746
632 <table class="memname"> 747 <div class="memitem">
633 <tr> 748 <div class="memproto">
634 <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> 749 <table class="mlabels">
635 <td>(</td> 750 <tr>
636 <td class="paramname"></td><td>)</td> 751 <td class="mlabels-left">
637 <td> const<code> [virtual, inherited]</code></td> 752 <table class="memname">
638 </tr> 753 <tr>
639 </table> 754 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
640 </div> 755 <td>(</td>
641 <div class="memdoc"> 756 <td class="paramname"></td><td>)</td>
757 <td> const</td>
758 </tr>
759 </table>
760 </td>
761 <td class="mlabels-right">
762 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
763 </tr>
764 </table>
765 </div><div class="memdoc">
642 766
643 <p>Get the plugin's required input domain. </p> 767 <p>Get the plugin's required input domain. </p>
644 <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> 768 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" 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>
645 <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> 769 <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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" 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>
646 770
647 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 771 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
648 772
649 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 773 </div>
650 774 </div>
651 </div> 775 <a id="afa79272f991fb720ddd09784be1b3cb8"></a>
652 </div> 776 <h2 class="memtitle"><span class="permalink"><a href="#afa79272f991fb720ddd09784be1b3cb8">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
653 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a> 777
654 <div class="memitem"> 778 <div class="memitem">
655 <div class="memproto"> 779 <div class="memproto">
656 <table class="memname"> 780 <table class="mlabels">
657 <tr> 781 <tr>
658 <td class="memname">unsigned int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper::getVampApiVersion</a> </td> 782 <td class="mlabels-left">
659 <td>(</td> 783 <table class="memname">
660 <td class="paramname"></td><td>)</td> 784 <tr>
661 <td> const<code> [virtual, inherited]</code></td> 785 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
662 </tr> 786 <td>(</td>
663 </table> 787 <td class="paramname"></td><td>)</td>
664 </div> 788 <td> const</td>
665 <div class="memdoc"> 789 </tr>
790 </table>
791 </td>
792 <td class="mlabels-right">
793 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
794 </tr>
795 </table>
796 </div><div class="memdoc">
666 797
667 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 798 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
668 799
669 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 800 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">Vamp::PluginBase</a>.</p>
670 801
671 </div> 802 </div>
672 </div> 803 </div>
673 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a> 804 <a id="ad9312a38c199004c7bad0c42f590393f"></a>
674 <div class="memitem"> 805 <h2 class="memtitle"><span class="permalink"><a href="#ad9312a38c199004c7bad0c42f590393f">&#9670;&nbsp;</a></span>getIdentifier()</h2>
675 <div class="memproto"> 806
676 <table class="memname"> 807 <div class="memitem">
677 <tr> 808 <div class="memproto">
678 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a4baa9e48f717c2b3e7f92496aa39d904">Vamp::HostExt::PluginWrapper::getIdentifier</a> </td> 809 <table class="mlabels">
679 <td>(</td> 810 <tr>
680 <td class="paramname"></td><td>)</td> 811 <td class="mlabels-left">
681 <td> const<code> [virtual, inherited]</code></td> 812 <table class="memname">
682 </tr> 813 <tr>
683 </table> 814 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
684 </div> 815 <td>(</td>
685 <div class="memdoc"> 816 <td class="paramname"></td><td>)</td>
817 <td> const</td>
818 </tr>
819 </table>
820 </td>
821 <td class="mlabels-right">
822 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
823 </tr>
824 </table>
825 </div><div class="memdoc">
686 826
687 <p>Get the computer-usable name of the plugin. </p> 827 <p>Get the computer-usable name of the plugin. </p>
688 <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> 828 <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>
689 <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> 829 <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>
690 <p>Example: "zero_crossings" </p> 830 <p>Example: "zero_crossings" </p>
691 831
692 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 832 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
693 833
694 </div> 834 </div>
695 </div> 835 </div>
696 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a> 836 <a id="aa2b40de6e240d872997a63dd4a301ff3"></a>
697 <div class="memitem"> 837 <h2 class="memtitle"><span class="permalink"><a href="#aa2b40de6e240d872997a63dd4a301ff3">&#9670;&nbsp;</a></span>getName()</h2>
698 <div class="memproto"> 838
699 <table class="memname"> 839 <div class="memitem">
700 <tr> 840 <div class="memproto">
701 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac70a3265bb25aeb03f6dd8f8a0442088">Vamp::HostExt::PluginWrapper::getName</a> </td> 841 <table class="mlabels">
702 <td>(</td> 842 <tr>
703 <td class="paramname"></td><td>)</td> 843 <td class="mlabels-left">
704 <td> const<code> [virtual, inherited]</code></td> 844 <table class="memname">
705 </tr> 845 <tr>
706 </table> 846 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
707 </div> 847 <td>(</td>
708 <div class="memdoc"> 848 <td class="paramname"></td><td>)</td>
849 <td> const</td>
850 </tr>
851 </table>
852 </td>
853 <td class="mlabels-right">
854 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
855 </tr>
856 </table>
857 </div><div class="memdoc">
709 858
710 <p>Get a human-readable name or title of the plugin. </p> 859 <p>Get a human-readable name or title of the plugin. </p>
711 <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> 860 <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>
712 <p>Example: "Zero Crossings" </p> 861 <p>Example: "Zero Crossings" </p>
713 862
714 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 863 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
715 864
716 </div> 865 </div>
717 </div> 866 </div>
718 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a> 867 <a id="ad6e453c30b265a2daf243f953b35c815"></a>
719 <div class="memitem"> 868 <h2 class="memtitle"><span class="permalink"><a href="#ad6e453c30b265a2daf243f953b35c815">&#9670;&nbsp;</a></span>getDescription()</h2>
720 <div class="memproto"> 869
721 <table class="memname"> 870 <div class="memitem">
722 <tr> 871 <div class="memproto">
723 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ac334f699c0996055942785410d8a065c">Vamp::HostExt::PluginWrapper::getDescription</a> </td> 872 <table class="mlabels">
724 <td>(</td> 873 <tr>
725 <td class="paramname"></td><td>)</td> 874 <td class="mlabels-left">
726 <td> const<code> [virtual, inherited]</code></td> 875 <table class="memname">
727 </tr> 876 <tr>
728 </table> 877 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
729 </div> 878 <td>(</td>
730 <div class="memdoc"> 879 <td class="paramname"></td><td>)</td>
880 <td> const</td>
881 </tr>
882 </table>
883 </td>
884 <td class="mlabels-right">
885 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
886 </tr>
887 </table>
888 </div><div class="memdoc">
731 889
732 <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> 890 <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>
733 <p>May be empty if the name has said it all already.</p> 891 <p>May be empty if the name has said it all already.</p>
734 <p>Example: "Detect and count zero crossing points" </p> 892 <p>Example: "Detect and count zero crossing points" </p>
735 893
736 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 894 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
737 895
738 </div> 896 </div>
739 </div> 897 </div>
740 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a> 898 <a id="af9b2f01063828ef0745dc2623fc8dd42"></a>
741 <div class="memitem"> 899 <h2 class="memtitle"><span class="permalink"><a href="#af9b2f01063828ef0745dc2623fc8dd42">&#9670;&nbsp;</a></span>getMaker()</h2>
742 <div class="memproto"> 900
743 <table class="memname"> 901 <div class="memitem">
744 <tr> 902 <div class="memproto">
745 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a59d5a2298951b317995675e664b1c7bb">Vamp::HostExt::PluginWrapper::getMaker</a> </td> 903 <table class="mlabels">
746 <td>(</td> 904 <tr>
747 <td class="paramname"></td><td>)</td> 905 <td class="mlabels-left">
748 <td> const<code> [virtual, inherited]</code></td> 906 <table class="memname">
749 </tr> 907 <tr>
750 </table> 908 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
751 </div> 909 <td>(</td>
752 <div class="memdoc"> 910 <td class="paramname"></td><td>)</td>
911 <td> const</td>
912 </tr>
913 </table>
914 </td>
915 <td class="mlabels-right">
916 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
917 </tr>
918 </table>
919 </div><div class="memdoc">
753 920
754 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 921 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
755 <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> 922 <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>
756 923
757 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 924 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
758 925
759 </div> 926 </div>
760 </div> 927 </div>
761 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a> 928 <a id="a9537de27c826a1441b2d3643df4880bb"></a>
762 <div class="memitem"> 929 <h2 class="memtitle"><span class="permalink"><a href="#a9537de27c826a1441b2d3643df4880bb">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
763 <div class="memproto"> 930
764 <table class="memname"> 931 <div class="memitem">
765 <tr> 932 <div class="memproto">
766 <td class="memname">int <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a47e1acf1696813008324a915c9ba59c5">Vamp::HostExt::PluginWrapper::getPluginVersion</a> </td> 933 <table class="mlabels">
767 <td>(</td> 934 <tr>
768 <td class="paramname"></td><td>)</td> 935 <td class="mlabels-left">
769 <td> const<code> [virtual, inherited]</code></td> 936 <table class="memname">
770 </tr> 937 <tr>
771 </table> 938 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
772 </div> 939 <td>(</td>
773 <div class="memdoc"> 940 <td class="paramname"></td><td>)</td>
941 <td> const</td>
942 </tr>
943 </table>
944 </td>
945 <td class="mlabels-right">
946 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
947 </tr>
948 </table>
949 </div><div class="memdoc">
774 950
775 <p>Get the version number of the plugin. </p> 951 <p>Get the version number of the plugin. </p>
776 952
777 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 953 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
778 954
779 </div> 955 </div>
780 </div> 956 </div>
781 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a> 957 <a id="aea9c238f86de65d3380fa887bb9e47e6"></a>
782 <div class="memitem"> 958 <h2 class="memtitle"><span class="permalink"><a href="#aea9c238f86de65d3380fa887bb9e47e6">&#9670;&nbsp;</a></span>getCopyright()</h2>
783 <div class="memproto"> 959
784 <table class="memname"> 960 <div class="memitem">
785 <tr> 961 <div class="memproto">
786 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ae14f6ecb78be909c4cd5f0cdaed3c566">Vamp::HostExt::PluginWrapper::getCopyright</a> </td> 962 <table class="mlabels">
787 <td>(</td> 963 <tr>
788 <td class="paramname"></td><td>)</td> 964 <td class="mlabels-left">
789 <td> const<code> [virtual, inherited]</code></td> 965 <table class="memname">
790 </tr> 966 <tr>
791 </table> 967 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
792 </div> 968 <td>(</td>
793 <div class="memdoc"> 969 <td class="paramname"></td><td>)</td>
970 <td> const</td>
971 </tr>
972 </table>
973 </td>
974 <td class="mlabels-right">
975 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
976 </tr>
977 </table>
978 </div><div class="memdoc">
794 979
795 <p>Get the copyright statement or licensing summary for the plugin. </p> 980 <p>Get the copyright statement or licensing summary for the plugin. </p>
796 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 981 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
797 982
798 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 983 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
799 984
800 </div> 985 </div>
801 </div> 986 </div>
802 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a> 987 <a id="ab2b67205d86e921cb0a9bd1f819d2cf9"></a>
803 <div class="memitem"> 988 <h2 class="memtitle"><span class="permalink"><a href="#ab2b67205d86e921cb0a9bd1f819d2cf9">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
804 <div class="memproto"> 989
805 <table class="memname"> 990 <div class="memitem">
806 <tr> 991 <div class="memproto">
807 <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> 992 <table class="mlabels">
808 <td>(</td> 993 <tr>
809 <td class="paramname"></td><td>)</td> 994 <td class="mlabels-left">
810 <td> const<code> [virtual, inherited]</code></td> 995 <table class="memname">
811 </tr> 996 <tr>
812 </table> 997 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
813 </div> 998 <td>(</td>
814 <div class="memdoc"> 999 <td class="paramname"></td><td>)</td>
1000 <td> const</td>
1001 </tr>
1002 </table>
1003 </td>
1004 <td class="mlabels-right">
1005 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1006 </tr>
1007 </table>
1008 </div><div class="memdoc">
815 1009
816 <p>Get the controllable parameters of this plugin. </p> 1010 <p>Get the controllable parameters of this plugin. </p>
817 1011
818 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 1012 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
819 1013
820 </div> 1014 </div>
821 </div> 1015 </div>
822 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a> 1016 <a id="a5c0a4d72a25fded51829de21771de521"></a>
823 <div class="memitem"> 1017 <h2 class="memtitle"><span class="permalink"><a href="#a5c0a4d72a25fded51829de21771de521">&#9670;&nbsp;</a></span>getParameter()</h2>
824 <div class="memproto"> 1018
825 <table class="memname"> 1019 <div class="memitem">
826 <tr> 1020 <div class="memproto">
827 <td class="memname">float <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper::getParameter</a> </td> 1021 <table class="mlabels">
1022 <tr>
1023 <td class="mlabels-left">
1024 <table class="memname">
1025 <tr>
1026 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
828 <td>(</td> 1027 <td>(</td>
829 <td class="paramtype">std::string&#160;</td> 1028 <td class="paramtype">std::string&#160;</td>
830 <td class="paramname"></td><td>)</td> 1029 <td class="paramname"></td><td>)</td>
831 <td> const<code> [virtual, inherited]</code></td> 1030 <td> const</td>
832 </tr> 1031 </tr>
833 </table> 1032 </table>
834 </div> 1033 </td>
835 <div class="memdoc"> 1034 <td class="mlabels-right">
1035 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1036 </tr>
1037 </table>
1038 </div><div class="memdoc">
836 1039
837 <p>Get the value of a named parameter. </p> 1040 <p>Get the value of a named parameter. </p>
838 <p>The argument is the identifier field from that parameter's descriptor. </p> 1041 <p>The argument is the identifier field from that parameter's descriptor. </p>
839 1042
840 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 1043 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
841 1044
842 </div> 1045 </div>
843 </div> 1046 </div>
844 <a class="anchor" id="a651b15a5dc4c27942ac0c87c6092bfe5"></a> 1047 <a id="a651b15a5dc4c27942ac0c87c6092bfe5"></a>
845 <div class="memitem"> 1048 <h2 class="memtitle"><span class="permalink"><a href="#a651b15a5dc4c27942ac0c87c6092bfe5">&#9670;&nbsp;</a></span>setParameter()</h2>
846 <div class="memproto"> 1049
847 <table class="memname"> 1050 <div class="memitem">
848 <tr> 1051 <div class="memproto">
849 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper::setParameter</a> </td> 1052 <table class="mlabels">
1053 <tr>
1054 <td class="mlabels-left">
1055 <table class="memname">
1056 <tr>
1057 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
850 <td>(</td> 1058 <td>(</td>
851 <td class="paramtype">std::string&#160;</td> 1059 <td class="paramtype">std::string&#160;</td>
852 <td class="paramname">, </td> 1060 <td class="paramname">, </td>
853 </tr> 1061 </tr>
854 <tr> 1062 <tr>
858 <td class="paramname">&#160;</td> 1066 <td class="paramname">&#160;</td>
859 </tr> 1067 </tr>
860 <tr> 1068 <tr>
861 <td></td> 1069 <td></td>
862 <td>)</td> 1070 <td>)</td>
863 <td></td><td><code> [virtual, inherited]</code></td> 1071 <td></td><td></td>
864 </tr> 1072 </tr>
865 </table> 1073 </table>
866 </div> 1074 </td>
867 <div class="memdoc"> 1075 <td class="mlabels-right">
1076 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1077 </tr>
1078 </table>
1079 </div><div class="memdoc">
868 1080
869 <p>Set a named parameter. </p> 1081 <p>Set a named parameter. </p>
870 <p>The first argument is the identifier field from that parameter's descriptor. </p> 1082 <p>The first argument is the identifier field from that parameter's descriptor. </p>
871 1083
872 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 1084 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
873 1085
874 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 1086 </div>
875 1087 </div>
876 </div> 1088 <a id="aa0b72ea17766266d20539f293ccae7c8"></a>
877 </div> 1089 <h2 class="memtitle"><span class="permalink"><a href="#aa0b72ea17766266d20539f293ccae7c8">&#9670;&nbsp;</a></span>getPrograms()</h2>
878 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a> 1090
879 <div class="memitem"> 1091 <div class="memitem">
880 <div class="memproto"> 1092 <div class="memproto">
881 <table class="memname"> 1093 <table class="mlabels">
882 <tr> 1094 <tr>
883 <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> 1095 <td class="mlabels-left">
884 <td>(</td> 1096 <table class="memname">
885 <td class="paramname"></td><td>)</td> 1097 <tr>
886 <td> const<code> [virtual, inherited]</code></td> 1098 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
887 </tr> 1099 <td>(</td>
888 </table> 1100 <td class="paramname"></td><td>)</td>
889 </div> 1101 <td> const</td>
890 <div class="memdoc"> 1102 </tr>
1103 </table>
1104 </td>
1105 <td class="mlabels-right">
1106 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1107 </tr>
1108 </table>
1109 </div><div class="memdoc">
891 1110
892 <p>Get the program settings available in this plugin. </p> 1111 <p>Get the program settings available in this plugin. </p>
893 <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> 1112 <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>
894 <p>The programs must have unique names. </p> 1113 <p>The programs must have unique names. </p>
895 1114
896 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 1115 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">Vamp::PluginBase</a>.</p>
897 1116
898 </div> 1117 </div>
899 </div> 1118 </div>
900 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a> 1119 <a id="a3936fe2c4b3c960dd244849a7c3320ad"></a>
901 <div class="memitem"> 1120 <h2 class="memtitle"><span class="permalink"><a href="#a3936fe2c4b3c960dd244849a7c3320ad">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
902 <div class="memproto"> 1121
903 <table class="memname"> 1122 <div class="memitem">
904 <tr> 1123 <div class="memproto">
905 <td class="memname">std::string <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper::getCurrentProgram</a> </td> 1124 <table class="mlabels">
906 <td>(</td> 1125 <tr>
907 <td class="paramname"></td><td>)</td> 1126 <td class="mlabels-left">
908 <td> const<code> [virtual, inherited]</code></td> 1127 <table class="memname">
909 </tr> 1128 <tr>
910 </table> 1129 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
911 </div> 1130 <td>(</td>
912 <div class="memdoc"> 1131 <td class="paramname"></td><td>)</td>
1132 <td> const</td>
1133 </tr>
1134 </table>
1135 </td>
1136 <td class="mlabels-right">
1137 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1138 </tr>
1139 </table>
1140 </div><div class="memdoc">
913 1141
914 <p>Get the current program. </p> 1142 <p>Get the current program. </p>
915 1143
916 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 1144 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">Vamp::PluginBase</a>.</p>
917 1145
918 </div> 1146 </div>
919 </div> 1147 </div>
920 <a class="anchor" id="a074978333a74fdcf336a8a1d8ea20abf"></a> 1148 <a id="a074978333a74fdcf336a8a1d8ea20abf"></a>
921 <div class="memitem"> 1149 <h2 class="memtitle"><span class="permalink"><a href="#a074978333a74fdcf336a8a1d8ea20abf">&#9670;&nbsp;</a></span>selectProgram()</h2>
922 <div class="memproto"> 1150
923 <table class="memname"> 1151 <div class="memitem">
924 <tr> 1152 <div class="memproto">
925 <td class="memname">void <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper::selectProgram</a> </td> 1153 <table class="mlabels">
1154 <tr>
1155 <td class="mlabels-left">
1156 <table class="memname">
1157 <tr>
1158 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
926 <td>(</td> 1159 <td>(</td>
927 <td class="paramtype">std::string&#160;</td> 1160 <td class="paramtype">std::string&#160;</td>
928 <td class="paramname"></td><td>)</td> 1161 <td class="paramname"></td><td>)</td>
929 <td><code> [virtual, inherited]</code></td> 1162 <td></td>
930 </tr> 1163 </tr>
931 </table> 1164 </table>
932 </div> 1165 </td>
933 <div class="memdoc"> 1166 <td class="mlabels-right">
1167 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1168 </tr>
1169 </table>
1170 </div><div class="memdoc">
934 1171
935 <p>Select a program. </p> 1172 <p>Select a program. </p>
936 <p>(If the given program name is not one of the available programs, do nothing.) </p> 1173 <p>(If the given program name is not one of the available programs, do nothing.) </p>
937 1174
938 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 1175 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
939 1176
940 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 1177 </div>
941 1178 </div>
942 </div> 1179 <a id="adf2ea98d6eeb0435c0c8d7cdc29fed7c"></a>
943 </div> 1180 <h2 class="memtitle"><span class="permalink"><a href="#adf2ea98d6eeb0435c0c8d7cdc29fed7c">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
944 <a class="anchor" id="a0137d93d7019bacc31104836fb4d352e"></a> 1181
945 <div class="memitem"> 1182 <div class="memitem">
946 <div class="memproto"> 1183 <div class="memproto">
947 <table class="memname"> 1184 <table class="mlabels">
948 <tr> 1185 <tr>
949 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper::getPreferredStepSize</a> </td> 1186 <td class="mlabels-left">
950 <td>(</td> 1187 <table class="memname">
951 <td class="paramname"></td><td>)</td> 1188 <tr>
952 <td> const<code> [virtual, inherited]</code></td> 1189 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
953 </tr> 1190 <td>(</td>
954 </table> 1191 <td class="paramname"></td><td>)</td>
955 </div> 1192 <td> const</td>
956 <div class="memdoc"> 1193 </tr>
957 1194 </table>
958 <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> 1195 </td>
959 <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> 1196 <td class="mlabels-right">
960 <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> 1197 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
961 1198 </tr>
962 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p> 1199 </table>
963 1200 </div><div class="memdoc">
964 <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> 1201
965 1202 <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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
966 </div> 1203 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745" 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>
967 </div> 1204 <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_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745" 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>
968 <a class="anchor" id="a2c62a656313a819650656643a867ad01"></a> 1205
969 <div class="memitem"> 1206 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin</a>.</p>
970 <div class="memproto"> 1207
971 <table class="memname"> 1208 </div>
972 <tr> 1209 </div>
973 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper::getPreferredBlockSize</a> </td> 1210 <a id="a94f855a2cf674ccc2e7315484f706d68"></a>
974 <td>(</td> 1211 <h2 class="memtitle"><span class="permalink"><a href="#a94f855a2cf674ccc2e7315484f706d68">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
975 <td class="paramname"></td><td>)</td> 1212
976 <td> const<code> [virtual, inherited]</code></td> 1213 <div class="memitem">
977 </tr> 1214 <div class="memproto">
978 </table> 1215 <table class="mlabels">
979 </div> 1216 <tr>
980 <div class="memdoc"> 1217 <td class="mlabels-left">
981 1218 <table class="memname">
982 <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> 1219 <tr>
983 <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> 1220 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
984 <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> 1221 <td>(</td>
985 1222 <td class="paramname"></td><td>)</td>
986 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> 1223 <td> const</td>
987 1224 </tr>
988 <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> 1225 </table>
989 1226 </td>
990 </div> 1227 <td class="mlabels-right">
991 </div> 1228 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
992 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a> 1229 </tr>
993 <div class="memitem"> 1230 </table>
994 <div class="memproto"> 1231 </div><div class="memdoc">
995 <table class="memname"> 1232
996 <tr> 1233 <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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data. ">process()</a> function). </p>
997 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper::getMinChannelCount</a> </td> 1234 <p>This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745" 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>
998 <td>(</td> 1235 <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_1PluginSummarisingAdapter.html#a1e994576d43efe103bf8f83b69716745" 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>
999 <td class="paramname"></td><td>)</td> 1236
1000 <td> const<code> [virtual, inherited]</code></td> 1237 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin</a>.</p>
1001 </tr> 1238
1002 </table> 1239 </div>
1003 </div> 1240 </div>
1004 <div class="memdoc"> 1241 <a id="abc0a4e6ce0ae9de39c40725de1f30d2f"></a>
1242 <h2 class="memtitle"><span class="permalink"><a href="#abc0a4e6ce0ae9de39c40725de1f30d2f">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
1243
1244 <div class="memitem">
1245 <div class="memproto">
1246 <table class="mlabels">
1247 <tr>
1248 <td class="mlabels-left">
1249 <table class="memname">
1250 <tr>
1251 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
1252 <td>(</td>
1253 <td class="paramname"></td><td>)</td>
1254 <td> const</td>
1255 </tr>
1256 </table>
1257 </td>
1258 <td class="mlabels-right">
1259 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1260 </tr>
1261 </table>
1262 </div><div class="memdoc">
1005 1263
1006 <p>Get the minimum supported number of input channels. </p> 1264 <p>Get the minimum supported number of input channels. </p>
1007 1265
1008 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1266 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">Vamp::Plugin</a>.</p>
1009 1267
1010 </div> 1268 </div>
1011 </div> 1269 </div>
1012 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a> 1270 <a id="acfed040cd91e797ee89d077db22b4a97"></a>
1013 <div class="memitem"> 1271 <h2 class="memtitle"><span class="permalink"><a href="#acfed040cd91e797ee89d077db22b4a97">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
1014 <div class="memproto"> 1272
1015 <table class="memname"> 1273 <div class="memitem">
1016 <tr> 1274 <div class="memproto">
1017 <td class="memname">size_t <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper::getMaxChannelCount</a> </td> 1275 <table class="mlabels">
1018 <td>(</td> 1276 <tr>
1019 <td class="paramname"></td><td>)</td> 1277 <td class="mlabels-left">
1020 <td> const<code> [virtual, inherited]</code></td> 1278 <table class="memname">
1021 </tr> 1279 <tr>
1022 </table> 1280 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
1023 </div> 1281 <td>(</td>
1024 <div class="memdoc"> 1282 <td class="paramname"></td><td>)</td>
1283 <td> const</td>
1284 </tr>
1285 </table>
1286 </td>
1287 <td class="mlabels-right">
1288 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1289 </tr>
1290 </table>
1291 </div><div class="memdoc">
1025 1292
1026 <p>Get the maximum supported number of input channels. </p> 1293 <p>Get the maximum supported number of input channels. </p>
1027 1294
1028 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1295 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">Vamp::Plugin</a>.</p>
1029 1296
1030 </div> 1297 </div>
1031 </div> 1298 </div>
1032 <a class="anchor" id="a5a9411305f713b4c9827844b89acd270"></a> 1299 <a id="af67a6cd3afa18895393ec8d4bdec3b4c"></a>
1033 <div class="memitem"> 1300 <h2 class="memtitle"><span class="permalink"><a href="#af67a6cd3afa18895393ec8d4bdec3b4c">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
1034 <div class="memproto"> 1301
1035 <table class="memname"> 1302 <div class="memitem">
1036 <tr> 1303 <div class="memproto">
1037 <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> 1304 <table class="mlabels">
1038 <td>(</td> 1305 <tr>
1039 <td class="paramname"></td><td>)</td> 1306 <td class="mlabels-left">
1040 <td> const<code> [virtual, inherited]</code></td> 1307 <table class="memname">
1041 </tr> 1308 <tr>
1042 </table> 1309 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
1043 </div> 1310 <td>(</td>
1044 <div class="memdoc"> 1311 <td class="paramname"></td><td>)</td>
1312 <td> const</td>
1313 </tr>
1314 </table>
1315 </td>
1316 <td class="mlabels-right">
1317 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1318 </tr>
1319 </table>
1320 </div><div class="memdoc">
1045 1321
1046 <p>Get the outputs of this plugin. </p> 1322 <p>Get the outputs of this plugin. </p>
1047 <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> 1323 <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_1PluginSummarisingAdapter.html#a3314b456a4780601c021dac25b478846" title="Process a single block of input data. ">process()</a> call. </p>
1048 1324
1049 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 1325 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
1050 1326
1051 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 1327 </div>
1052 1328 </div>
1053 </div> 1329 <a id="a653d0308e8e34881a8749b7631d00f05"></a>
1054 </div> 1330 <h2 class="memtitle"><span class="permalink"><a href="#a653d0308e8e34881a8749b7631d00f05">&#9670;&nbsp;</a></span>getWrapper()</h2>
1055 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a> 1331
1056 <div class="memitem"> 1332 <div class="memitem">
1057 <div class="memproto"> 1333 <div class="memproto">
1058 <div class="memtemplate"> 1334 <div class="memtemplate">
1059 template&lt;typename WrapperType &gt; </div> 1335 template&lt;typename WrapperType &gt; </div>
1060 <table class="memname"> 1336 <table class="mlabels">
1061 <tr> 1337 <tr>
1062 <td class="memname">WrapperType* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a653d0308e8e34881a8749b7631d00f05">Vamp::HostExt::PluginWrapper::getWrapper</a> </td> 1338 <td class="mlabels-left">
1063 <td>(</td> 1339 <table class="memname">
1064 <td class="paramname"></td><td>)</td> 1340 <tr>
1065 <td><code> [inline, inherited]</code></td> 1341 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
1066 </tr> 1342 <td>(</td>
1067 </table> 1343 <td class="paramname"></td><td>)</td>
1068 </div> 1344 <td></td>
1069 <div class="memdoc"> 1345 </tr>
1346 </table>
1347 </td>
1348 <td class="mlabels-right">
1349 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
1350 </tr>
1351 </table>
1352 </div><div class="memdoc">
1070 1353
1071 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p> 1354 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
1072 <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> 1355 <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>
1073 1356
1074 <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> 1357 <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>
1075 1358
1076 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p> 1359 <p class="reference">References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
1077 1360
1078 <p>Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1361 <p class="reference">Referenced by <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
1079 1362
1080 </div> 1363 </div>
1081 </div> 1364 </div>
1082 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 1365 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
1083 <div class="memitem"> 1366 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
1084 <div class="memproto"> 1367
1085 <table class="memname"> 1368 <div class="memitem">
1086 <tr> 1369 <div class="memproto">
1087 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 1370 <table class="mlabels">
1088 <td>(</td> 1371 <tr>
1089 <td class="paramname"></td><td>)</td> 1372 <td class="mlabels-left">
1090 <td> const<code> [inline, virtual, inherited]</code></td> 1373 <table class="memname">
1091 </tr> 1374 <tr>
1092 </table> 1375 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1093 </div> 1376 <td>(</td>
1094 <div class="memdoc"> 1377 <td class="paramname"></td><td>)</td>
1095 1378 <td> const</td>
1096 <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> 1379 </tr>
1380 </table>
1381 </td>
1382 <td class="mlabels-right">
1383 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1384 </tr>
1385 </table>
1386 </div><div class="memdoc">
1387
1388 <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>
1097 <p>Do not reimplement this function in your subclass. </p> 1389 <p>Do not reimplement this function in your subclass. </p>
1098 1390
1099 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1391 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1100 1392
1101 <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> 1393 <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>
1102 1394
1103 </div> 1395 </div>
1104 </div> 1396 </div>
1105 <hr/><h2>Member Data Documentation</h2> 1397 <h2 class="groupheader">Member Data Documentation</h2>
1106 <a class="anchor" id="af131140817d9f131650af98b6b8d7a94"></a> 1398 <a id="af131140817d9f131650af98b6b8d7a94"></a>
1107 <div class="memitem"> 1399 <h2 class="memtitle"><span class="permalink"><a href="#af131140817d9f131650af98b6b8d7a94">&#9670;&nbsp;</a></span>m_impl</h2>
1108 <div class="memproto"> 1400
1109 <table class="memname"> 1401 <div class="memitem">
1110 <tr> 1402 <div class="memproto">
1111 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af131140817d9f131650af98b6b8d7a94">Vamp::HostExt::PluginSummarisingAdapter::m_impl</a><code> [protected]</code></td> 1403 <table class="mlabels">
1112 </tr> 1404 <tr>
1113 </table> 1405 <td class="mlabels-left">
1114 </div> 1406 <table class="memname">
1115 <div class="memdoc"> 1407 <tr>
1116 1408 <td class="memname">Impl* Vamp::HostExt::PluginSummarisingAdapter::m_impl</td>
1117 <p>Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00187">187</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p> 1409 </tr>
1118 1410 </table>
1119 </div> 1411 </td>
1120 </div> 1412 <td class="mlabels-right">
1121 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a> 1413 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
1122 <div class="memitem"> 1414 </tr>
1123 <div class="memproto"> 1415 </table>
1124 <table class="memname"> 1416 </div><div class="memdoc">
1125 <tr> 1417
1126 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code></td> 1418 <p class="definition">Definition at line <a class="el" href="PluginSummarisingAdapter_8h_source.html#l00187">187</a> of file <a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a>.</p>
1127 </tr> 1419
1128 </table> 1420 </div>
1129 </div> 1421 </div>
1130 <div class="memdoc"> 1422 <a id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a>
1131 1423 <h2 class="memtitle"><span class="permalink"><a href="#ab4e40ecd98b445e1a2aa9e7baa280ea2">&#9670;&nbsp;</a></span>m_plugin</h2>
1132 <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> 1424
1133 1425 <div class="memitem">
1134 </div> 1426 <div class="memproto">
1135 </div> 1427 <table class="mlabels">
1136 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1428 <tr>
1137 <div class="memitem"> 1429 <td class="mlabels-left">
1138 <div class="memproto"> 1430 <table class="memname">
1139 <table class="memname"> 1431 <tr>
1140 <tr> 1432 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::HostExt::PluginWrapper::m_plugin</td>
1141 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1433 </tr>
1142 </tr> 1434 </table>
1143 </table> 1435 </td>
1144 </div> 1436 <td class="mlabels-right">
1145 <div class="memdoc"> 1437 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1146 1438 </tr>
1147 <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> 1439 </table>
1148 1440 </div><div class="memdoc">
1149 <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="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::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> 1441
1442 <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>
1443
1444 </div>
1445 </div>
1446 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1447 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1448
1449 <div class="memitem">
1450 <div class="memproto">
1451 <table class="mlabels">
1452 <tr>
1453 <td class="mlabels-left">
1454 <table class="memname">
1455 <tr>
1456 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1457 </tr>
1458 </table>
1459 </td>
1460 <td class="mlabels-right">
1461 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1462 </tr>
1463 </table>
1464 </div><div class="memdoc">
1465
1466 <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>
1467
1468 <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>
1150 1469
1151 </div> 1470 </div>
1152 </div> 1471 </div>
1153 <hr/>The documentation for this class was generated from the following file:<ul> 1472 <hr/>The documentation for this class was generated from the following file:<ul>
1154 <li><a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a></li> 1473 <li><a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a></li>
1155 </ul> 1474 </ul>
1156 </div><!-- contents --> 1475 </div><!-- contents -->
1157 </div> 1476 </div><!-- doc-content -->
1158 <div id="nav-path" class="navpath"> 1477 <!-- start footer part -->
1159 <ul> 1478 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1160 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 1479 <ul>
1161 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li> 1480 <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_1PluginSummarisingAdapter.html">PluginSummarisingAdapter</a></li>
1162 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html">PluginSummarisingAdapter</a> </li> 1481 <li class="footer">Generated by
1163
1164 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
1165 <a href="http://www.doxygen.org/index.html"> 1482 <a href="http://www.doxygen.org/index.html">
1166 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1483 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
1167 </ul> 1484 </ul>
1168 </div> 1485 </div>
1169
1170
1171 </body> 1486 </body>
1172 </html> 1487 </html>