Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html @ 50:8260c0f4e05b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs for 2.3
author cannam
date Tue, 04 Oct 2011 13:47:23 +0000
parents 0976232e353b
children
comparison
equal deleted inserted replaced
49:f75f330aa130 50:8260c0f4e05b
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 <title>VampPluginSDK: Vamp::HostExt::PluginSummarisingAdapter Class Reference</title> 5 <title>VampPluginSDK: Vamp::HostExt::PluginSummarisingAdapter Class Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css"> 6
5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
6 </head><body> 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
7 <!-- Generated by Doxygen 1.5.8 --> 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
8 <div class="navigation" id="top"> 10 <script type="text/javascript" src="jquery.js"></script>
9 <div class="tabs"> 11 <script type="text/javascript" src="resize.js"></script>
10 <ul> 12 <script type="text/javascript" src="navtree.js"></script>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li> 49 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li> 50 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul> 51 </ul>
17 </div> 52 </div>
18 <div class="tabs"> 53 <div id="navrow2" class="tabs2">
19 <ul> 54 <ul class="tablist">
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li> 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li> 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li> 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
23 </ul> 58 </ul>
24 </div> 59 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a>::<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html">PluginSummarisingAdapter</a> 60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 </div>
26 </div> 65 </div>
66 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle">
68 </div>
69 </div>
70 <script type="text/javascript">
71 initNavTree('classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-types">Public Types</a> &#124;
77 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pro-attribs">Protected Attributes</a> </div>
79 <div class="headertitle">
80 <div class="title">Vamp::HostExt::PluginSummarisingAdapter Class Reference</div> </div>
27 </div> 81 </div>
28 <div class="contents"> 82 <div class="contents">
29 <h1>Vamp::HostExt::PluginSummarisingAdapter Class Reference</h1><!-- doxytag: class="Vamp::HostExt::PluginSummarisingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" --><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">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. 83 <!-- doxytag: class="Vamp::HostExt::PluginSummarisingAdapter" --><!-- doxytag: inherits="Vamp::HostExt::PluginWrapper" -->
30 <a href="#_details">More...</a> 84 <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.
31 <p> 85 <a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#details">More...</a></p>
32 <code>#include &lt;<a class="el" href="PluginSummarisingAdapter_8h-source.html">vamp-hostsdk/PluginSummarisingAdapter.h</a>&gt;</code> 86
33 <p> 87 <p><code>#include &lt;<a class="el" href="PluginSummarisingAdapter_8h_source.html">vamp-hostsdk/PluginSummarisingAdapter.h</a>&gt;</code></p>
34 <div class="dynheader"> 88 <div class="dynheader">
35 Inheritance diagram for Vamp::HostExt::PluginSummarisingAdapter:</div> 89 Inheritance diagram for Vamp::HostExt::PluginSummarisingAdapter:</div>
36 <div class="dynsection"> 90 <div class="dyncontent">
37 <p><center><img src="classVamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__map" alt="Inheritance graph"></center> 91 <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>
38 <map name="Vamp_1_1HostExt_1_1PluginSummarisingAdapter__inherit__map"> 92 <map name="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map" id="Vamp_1_1HostExt_1_1PluginSummarisingAdapter_inherit__map">
39 <area shape="rect" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="40,156,229,180"><area shape="rect" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction..." alt="" coords="88,81,181,105"><area shape="rect" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="75,7,195,31"></map> 93 <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>
40 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> 94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
41 95
42 <p> 96 <p><a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html">List of all members.</a></p>
43 <a href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 97 <table class="memberdecls">
44 <tr><td></td></tr> 98 <tr><td colspan="2"><h2><a name="pub-types"></a>
45 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> 99 Public Types</h2></td></tr>
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a> { <br> 100 <tr><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/>
47 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c">Minimum</a> = 0, 101 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c">Minimum</a> = 0,
48 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9">Maximum</a> = 1, 102 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9">Maximum</a> = 1,
49 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75">Mean</a> = 2, 103 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75">Mean</a> = 2,
50 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195">Median</a> = 3, 104 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195">Median</a> = 3,
51 <br> 105 <br/>
52 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614">Mode</a> = 4, 106 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614">Mode</a> = 4,
53 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b">Sum</a> = 5, 107 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b">Sum</a> = 5,
54 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075">Variance</a> = 6, 108 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075">Variance</a> = 6,
55 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7">StandardDeviation</a> = 7, 109 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7">StandardDeviation</a> = 7,
56 <br> 110 <br/>
57 &nbsp;&nbsp;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6">Count</a> = 8, 111 &#160;&#160;<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6">Count</a> = 8,
58 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c">UnknownSummaryType</a> = 999 112 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c">UnknownSummaryType</a> = 999
59 <br> 113 <br/>
60 }</td></tr> 114 }</td></tr>
61 115 <tr><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,
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> { <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36">SampleAverage</a> = 0, 116 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa">ContinuousTimeAverage</a> = 1
63 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa">ContinuousTimeAverage</a> = 1
64 }</td></tr> 117 }</td></tr>
65 118 <tr><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>
66 <tr><td class="mdescLeft">&nbsp;</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#294e9eed9c541dcedbaa4f2dfda1ac76">More...</a><br></td></tr> 119 <tr><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>
67 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::set&lt; <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">SegmentBoundaries</a></td></tr> 120 <tr><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>,
68 121 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
69 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 122 }</td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#31b41f54560a2ae6c3ec1a945f3f1d68">PluginSummarisingAdapter</a> (<a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *plugin)</td></tr> 123 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
71 124 &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>
72 <tr><td class="mdescLeft">&nbsp;</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...">PluginSummarisingAdapter</a> wrapping the given plugin. <a href="#31b41f54560a2ae6c3ec1a945f3f1d68"></a><br></td></tr> 125 <tr><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>
73 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#47846e7cc0ef4a29335e08b9645316d0">~PluginSummarisingAdapter</a> ()</td></tr> 126 <tr><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/>
74 127 <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>
75 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#1e994576d43efe103bf8f83b69716745">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 128 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/>
76 129 &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>
77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames). <a href="#1e994576d43efe103bf8f83b69716745"></a><br></td></tr> 130 <tr><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3402381d145d507bd26d1a67e3616911">reset</a> ()</td></tr> 131 <tr><td colspan="2"><h2><a name="pub-methods"></a>
79 132 Public Member Functions</h2></td></tr>
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#3402381d145d507bd26d1a67e3616911"></a><br></td></tr> 133 <tr><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>
81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3314b456a4780601c021dac25b478846">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 134 <tr><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>
82 135 <tr><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>
83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a single block of input data. <a href="#3314b456a4780601c021dac25b478846"></a><br></td></tr> 136 <tr><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>
84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688">getRemainingFeatures</a> ()</td></tr> 137 <tr><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>
85 138 <tr><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>
86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After all blocks have been processed, calculate and return any remaining features derived from the complete input. <a href="#e9dcbd1ba8197ff90b4fc6bf7ade7688"></a><br></td></tr> 139 <tr><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>
87 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#1a659500ca1290a228c0b9b91f6ac0b7">setSummarySegmentBoundaries</a> (const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;)</td></tr> 140 <tr><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>
88 141 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a3314b456a4780601c021dac25b478846"></a><br/></td></tr>
89 <tr><td class="mdescLeft">&nbsp;</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="#1a659500ca1290a228c0b9b91f6ac0b7"></a><br></td></tr> 142 <tr><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>
90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#be13faa68d3244b962dbd362671e23f9">getSummaryForOutput</a> (int output, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=SampleAverage)</td></tr> 143 <tr><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>
91 144 <tr><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>
92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. <a href="#be13faa68d3244b962dbd362671e23f9"></a><br></td></tr> 145 <tr><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>
93 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#c3f93d9ca2d25c9fdc80d0ba10eaaa6b">getSummaryForAllOutputs</a> (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a> type, <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a> method=SampleAverage)</td></tr> 146 <tr><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=SampleAverage)</td></tr>
94 147 <tr><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>
95 <tr><td class="mdescLeft">&nbsp;</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="#c3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a><br></td></tr> 148 <tr><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=SampleAverage)</td></tr>
96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e203faf8384c9e1fddc381409aa8a214">getInputDomain</a> () const </td></tr> 149 <tr><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>
97 150 <tr><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>
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#e203faf8384c9e1fddc381409aa8a214"></a><br></td></tr> 151 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae203faf8384c9e1fddc381409aa8a214"></a><br/></td></tr>
99 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#74147fda6b44ff2169bd4a1eea0d46ff">getVampApiVersion</a> () const </td></tr> 152 <tr><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>
100 153 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#a74147fda6b44ff2169bd4a1eea0d46ff"></a><br/></td></tr>
101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#74147fda6b44ff2169bd4a1eea0d46ff"></a><br></td></tr> 154 <tr><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>
102 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#4baa9e48f717c2b3e7f92496aa39d904">getIdentifier</a> () const </td></tr> 155 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4baa9e48f717c2b3e7f92496aa39d904"></a><br/></td></tr>
103 156 <tr><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>
104 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#4baa9e48f717c2b3e7f92496aa39d904"></a><br></td></tr> 157 <tr><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>
105 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c70a3265bb25aeb03f6dd8f8a0442088">getName</a> () const </td></tr> 158 <tr><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>
106 159 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#ac334f699c0996055942785410d8a065c"></a><br/></td></tr>
107 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#c70a3265bb25aeb03f6dd8f8a0442088"></a><br></td></tr> 160 <tr><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>
108 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#c334f699c0996055942785410d8a065c">getDescription</a> () const </td></tr> 161 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a59d5a2298951b317995675e664b1c7bb"></a><br/></td></tr>
109 162 <tr><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>
110 <tr><td class="mdescLeft">&nbsp;</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="#c334f699c0996055942785410d8a065c"></a><br></td></tr> 163 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a47e1acf1696813008324a915c9ba59c5"></a><br/></td></tr>
111 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#59d5a2298951b317995675e664b1c7bb">getMaker</a> () const </td></tr> 164 <tr><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>
112 165 <tr><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>
113 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#59d5a2298951b317995675e664b1c7bb"></a><br></td></tr> 166 <tr><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>
114 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#47e1acf1696813008324a915c9ba59c5">getPluginVersion</a> () const </td></tr> 167 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9be71561265c2e6e43b7feaddaa91f36"></a><br/></td></tr>
115 168 <tr><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>
116 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the version number of the plugin. <a href="#47e1acf1696813008324a915c9ba59c5"></a><br></td></tr> 169 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a034920f56c8d7609a85447c42556048c"></a><br/></td></tr>
117 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e14f6ecb78be909c4cd5f0cdaed3c566">getCopyright</a> () const </td></tr> 170 <tr><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>
118 171 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a651b15a5dc4c27942ac0c87c6092bfe5"></a><br/></td></tr>
119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#e14f6ecb78be909c4cd5f0cdaed3c566"></a><br></td></tr> 172 <tr><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>
120 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#9be71561265c2e6e43b7feaddaa91f36">getParameterDescriptors</a> () const </td></tr> 173 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a131fbe1df81215020b9aa8cecef4c802"></a><br/></td></tr>
121 174 <tr><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>
122 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#9be71561265c2e6e43b7feaddaa91f36"></a><br></td></tr> 175 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a7a312dd42d161064b70afd7ff24c0651"></a><br/></td></tr>
123 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#034920f56c8d7609a85447c42556048c">getParameter</a> (std::string) const </td></tr> 176 <tr><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>
124 177 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a074978333a74fdcf336a8a1d8ea20abf"></a><br/></td></tr>
125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of a named parameter. <a href="#034920f56c8d7609a85447c42556048c"></a><br></td></tr> 178 <tr><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>
126 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#651b15a5dc4c27942ac0c87c6092bfe5">setParameter</a> (std::string, float)</td></tr> 179 <tr><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>
127 180 <tr><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>
128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a named parameter. <a href="#651b15a5dc4c27942ac0c87c6092bfe5"></a><br></td></tr> 181 <tr><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>
129 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#131fbe1df81215020b9aa8cecef4c802">getPrograms</a> () const </td></tr> 182 <tr><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>
130 183 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a2b28f1cf37d46a514f1e1411a6037bf8"></a><br/></td></tr>
131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#131fbe1df81215020b9aa8cecef4c802"></a><br></td></tr> 184 <tr><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>
132 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#7a312dd42d161064b70afd7ff24c0651">getCurrentProgram</a> () const </td></tr> 185 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a985eb21f1827bfbc3950d6871b107a58"></a><br/></td></tr>
133 186 <tr><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>
134 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current program. <a href="#7a312dd42d161064b70afd7ff24c0651"></a><br></td></tr> 187 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a5a9411305f713b4c9827844b89acd270"></a><br/></td></tr>
135 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#074978333a74fdcf336a8a1d8ea20abf">selectProgram</a> (std::string)</td></tr> 188 <tr><td class="memTemplParams" colspan="2">template&lt;typename WrapperType &gt; </td></tr>
136 189 <tr><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>
137 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select a program. <a href="#074978333a74fdcf336a8a1d8ea20abf"></a><br></td></tr> 190 <tr><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>
138 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#0137d93d7019bacc31104836fb4d352e">getPreferredStepSize</a> () const </td></tr> 191 <tr><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>
139 192 <tr><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>
140 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#0137d93d7019bacc31104836fb4d352e"></a><br></td></tr> 193 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
141 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2c62a656313a819650656643a867ad01">getPreferredBlockSize</a> () const </td></tr> 194 Protected Attributes</h2></td></tr>
142 195 <tr><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>
143 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). <a href="#2c62a656313a819650656643a867ad01"></a><br></td></tr> 196 <tr><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>
144 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2b28f1cf37d46a514f1e1411a6037bf8">getMinChannelCount</a> () const </td></tr> 197 <tr><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>
145
146 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#2b28f1cf37d46a514f1e1411a6037bf8"></a><br></td></tr>
147 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#985eb21f1827bfbc3950d6871b107a58">getMaxChannelCount</a> () const </td></tr>
148
149 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#985eb21f1827bfbc3950d6871b107a58"></a><br></td></tr>
150 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#5a9411305f713b4c9827844b89acd270">getOutputDescriptors</a> () const </td></tr>
151
152 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#5a9411305f713b4c9827844b89acd270"></a><br></td></tr>
153 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename WrapperType &gt; </td></tr>
154 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">WrapperType *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#e9d79bed7237d55a73018a6b982a55b3">getWrapper</a> ()</td></tr>
155
156 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. <a href="#e9d79bed7237d55a73018a6b982a55b3"></a><br></td></tr>
157 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#be13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr>
158
159 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#be13b3997a69fbcc09e2213faa352f91"></a><br></td></tr>
160 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
161 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">m_impl</a></td></tr>
162
163 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">m_plugin</a></td></tr>
164
165 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
166
167 </table> 198 </table>
168 <hr><a name="_details"></a><h2>Detailed Description</h2> 199 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
169 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">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. 200 <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>
170 <p> 201 <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>
171 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...">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> 202 <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>
172 By default <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">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> 203 <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>
173 <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">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...">PluginSummarisingAdapter</a> may not be the best approach for you.<p> 204 <dl class="note"><dt><b>Note:</b></dt><dd>This class was introduced in version 2.0 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl>
174 <dl class="note" compact><dt><b>Note:</b></dt><dd>This class was introduced in version 2.0 of the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK. </dd></dl> 205
175 206 <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>
176 <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> 207 </div><hr/><h2>Member Typedef Documentation</h2>
177 <hr><h2>Member Typedef Documentation</h2> 208 <a class="anchor" id="a74e7f93c745802a2409185b63922466b"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries" ref="a74e7f93c745802a2409185b63922466b" args="" -->
178 <a class="anchor" name="74e7f93c745802a2409185b63922466b"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries" ref="74e7f93c745802a2409185b63922466b" args="" --> 209 <div class="memitem">
179 <div class="memitem"> 210 <div class="memproto">
180 <div class="memproto"> 211 <table class="memname">
181 <table class="memname"> 212 <tr>
182 <tr> 213 <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>
183 <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#74e7f93c745802a2409185b63922466b">Vamp::HostExt::PluginSummarisingAdapter::SegmentBoundaries</a> </td> 214 </tr>
184 </tr> 215 </table>
185 </table> 216 </div>
186 </div> 217 <div class="memdoc">
187 <div class="memdoc"> 218
188 219 <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>
189 <p> 220
190 221 </div>
191 <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> 222 </div>
192 223 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::OutputList" ref="a30f531b8fb69fac41a24e3d2a6a08ed9" args="" -->
193 </div> 224 <div class="memitem">
194 </div><p> 225 <div class="memproto">
195 <a class="anchor" name="30f531b8fb69fac41a24e3d2a6a08ed9"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::OutputList" ref="30f531b8fb69fac41a24e3d2a6a08ed9" args="" --> 226 <table class="memname">
196 <div class="memitem"> 227 <tr>
197 <div class="memproto"> 228 <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>
198 <table class="memname"> 229 </tr>
199 <tr> 230 </table>
200 <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#30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a><code> [inherited]</code> </td> 231 </div>
201 </tr> 232 <div class="memdoc">
202 </table> 233
203 </div> 234 <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>
204 <div class="memdoc"> 235
205 236 </div>
206 <p> 237 </div>
207 238 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::FeatureList" ref="a0730bc72c87fa02eb8d2854b233f7be1" args="" -->
208 <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> 239 <div class="memitem">
209 240 <div class="memproto">
210 </div> 241 <table class="memname">
211 </div><p> 242 <tr>
212 <a class="anchor" name="0730bc72c87fa02eb8d2854b233f7be1"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::FeatureList" ref="0730bc72c87fa02eb8d2854b233f7be1" args="" --> 243 <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>
213 <div class="memitem"> 244 </tr>
214 <div class="memproto"> 245 </table>
215 <table class="memname"> 246 </div>
216 <tr> 247 <div class="memdoc">
217 <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#0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a><code> [inherited]</code> </td> 248
218 </tr> 249 <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>
219 </table> 250
220 </div> 251 </div>
221 <div class="memdoc"> 252 </div>
222 253 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::FeatureSet" ref="a448fb57dc245d47923ec9eeaf9856c5f" args="" -->
223 <p> 254 <div class="memitem">
224 255 <div class="memproto">
225 <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> 256 <table class="memname">
226 257 <tr>
227 </div> 258 <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>
228 </div><p> 259 </tr>
229 <a class="anchor" name="448fb57dc245d47923ec9eeaf9856c5f"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::FeatureSet" ref="448fb57dc245d47923ec9eeaf9856c5f" args="" --> 260 </table>
230 <div class="memitem"> 261 </div>
231 <div class="memproto"> 262 <div class="memdoc">
232 <table class="memname"> 263
233 <tr> 264 <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>
234 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a><code> [inherited]</code> </td> 265
235 </tr> 266 </div>
236 </table> 267 </div>
237 </div> 268 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::ParameterList" ref="a3b6bb4bbd86affe1ca9deceea1aad4f8" args="" -->
238 <div class="memdoc"> 269 <div class="memitem">
239 270 <div class="memproto">
240 <p> 271 <table class="memname">
241 272 <tr>
242 <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> 273 <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>
243 274 </tr>
244 </div> 275 </table>
245 </div><p> 276 </div>
246 <a class="anchor" name="3b6bb4bbd86affe1ca9deceea1aad4f8"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::ParameterList" ref="3b6bb4bbd86affe1ca9deceea1aad4f8" args="" --> 277 <div class="memdoc">
247 <div class="memitem"> 278
248 <div class="memproto"> 279 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
249 <table class="memname"> 280
250 <tr> 281 </div>
251 <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#3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a><code> [inherited]</code> </td> 282 </div>
252 </tr> 283 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::ProgramList" ref="a7f66f00437b21e5f694fe02356b12f20" args="" -->
253 </table> 284 <div class="memitem">
254 </div> 285 <div class="memproto">
255 <div class="memdoc"> 286 <table class="memname">
256 287 <tr>
257 <p> 288 <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>
258 289 </tr>
259 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 290 </table>
260 291 </div>
261 </div> 292 <div class="memdoc">
262 </div><p> 293
263 <a class="anchor" name="7f66f00437b21e5f694fe02356b12f20"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::ProgramList" ref="7f66f00437b21e5f694fe02356b12f20" args="" --> 294 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
264 <div class="memitem"> 295
265 <div class="memproto"> 296 </div>
266 <table class="memname"> 297 </div>
267 <tr> 298 <hr/><h2>Member Enumeration Documentation</h2>
268 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a><code> [inherited]</code> </td> 299 <a class="anchor" id="af504f810448961fc489e9b6572471705"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::SummaryType" ref="af504f810448961fc489e9b6572471705" args="" -->
269 </tr> 300 <div class="memitem">
270 </table> 301 <div class="memproto">
271 </div> 302 <table class="memname">
272 <div class="memdoc"> 303 <tr>
273 304 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">Vamp::HostExt::PluginSummarisingAdapter::SummaryType</a></td>
274 <p> 305 </tr>
275 306 </table>
276 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> 307 </div>
277 308 <div class="memdoc">
278 </div> 309 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
279 </div><p> 310 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c"></a><!-- doxytag: member="Minimum" ref="af504f810448961fc489e9b6572471705a320b8a4cd0c3d492aeb17f7fc4ed930c" args="" -->Minimum</em>&nbsp;</td><td>
280 <hr><h2>Member Enumeration Documentation</h2> 311 </td></tr>
281 <a class="anchor" name="f504f810448961fc489e9b6572471705"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::SummaryType" ref="f504f810448961fc489e9b6572471705" args="" --> 312 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9"></a><!-- doxytag: member="Maximum" ref="af504f810448961fc489e9b6572471705adefff4e5073aa298a96d99b92025b7f9" args="" -->Maximum</em>&nbsp;</td><td>
282 <div class="memitem"> 313 </td></tr>
283 <div class="memproto"> 314 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75"></a><!-- doxytag: member="Mean" ref="af504f810448961fc489e9b6572471705ae8a03f013397d08c85734e47524f5a75" args="" -->Mean</em>&nbsp;</td><td>
284 <table class="memname"> 315 </td></tr>
285 <tr> 316 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195"></a><!-- doxytag: member="Median" ref="af504f810448961fc489e9b6572471705aadde1f9a5a6557f25223279433699195" args="" -->Median</em>&nbsp;</td><td>
286 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">Vamp::HostExt::PluginSummarisingAdapter::SummaryType</a> </td> 317 </td></tr>
287 </tr> 318 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614"></a><!-- doxytag: member="Mode" ref="af504f810448961fc489e9b6572471705a1688d03811a2268daa062220f5be0614" args="" -->Mode</em>&nbsp;</td><td>
288 </table> 319 </td></tr>
289 </div> 320 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b"></a><!-- doxytag: member="Sum" ref="af504f810448961fc489e9b6572471705a9496664a605b3aa706f909070d73060b" args="" -->Sum</em>&nbsp;</td><td>
290 <div class="memdoc"> 321 </td></tr>
291 322 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075"></a><!-- doxytag: member="Variance" ref="af504f810448961fc489e9b6572471705ae965a9e5381745e6e3a75342d7c8e075" args="" -->Variance</em>&nbsp;</td><td>
292 <p> 323 </td></tr>
293 <dl compact><dt><b>Enumerator: </b></dt><dd> 324 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7"></a><!-- doxytag: member="StandardDeviation" ref="af504f810448961fc489e9b6572471705a9342cd2209e20b93843cd389d9511ec7" args="" -->StandardDeviation</em>&nbsp;</td><td>
294 <table border="0" cellspacing="2" cellpadding="0"> 325 </td></tr>
295 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c"></a><!-- doxytag: member="Minimum" ref="f504f810448961fc489e9b6572471705320b8a4cd0c3d492aeb17f7fc4ed930c" args="" -->Minimum</em>&nbsp;</td><td> 326 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6"></a><!-- doxytag: member="Count" ref="af504f810448961fc489e9b6572471705a2395772fa2e74b3f617e20c76d579ad6" args="" -->Count</em>&nbsp;</td><td>
296 </td></tr> 327 </td></tr>
297 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9"></a><!-- doxytag: member="Maximum" ref="f504f810448961fc489e9b6572471705defff4e5073aa298a96d99b92025b7f9" args="" -->Maximum</em>&nbsp;</td><td> 328 <tr><td valign="top"><em><a class="anchor" id="af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c"></a><!-- doxytag: member="UnknownSummaryType" ref="af504f810448961fc489e9b6572471705aeed3a16d665eb789053b82fdd386ee7c" args="" -->UnknownSummaryType</em>&nbsp;</td><td>
298 </td></tr>
299 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75"></a><!-- doxytag: member="Mean" ref="f504f810448961fc489e9b6572471705e8a03f013397d08c85734e47524f5a75" args="" -->Mean</em>&nbsp;</td><td>
300 </td></tr>
301 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195"></a><!-- doxytag: member="Median" ref="f504f810448961fc489e9b6572471705adde1f9a5a6557f25223279433699195" args="" -->Median</em>&nbsp;</td><td>
302 </td></tr>
303 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614"></a><!-- doxytag: member="Mode" ref="f504f810448961fc489e9b65724717051688d03811a2268daa062220f5be0614" args="" -->Mode</em>&nbsp;</td><td>
304 </td></tr>
305 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b"></a><!-- doxytag: member="Sum" ref="f504f810448961fc489e9b65724717059496664a605b3aa706f909070d73060b" args="" -->Sum</em>&nbsp;</td><td>
306 </td></tr>
307 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075"></a><!-- doxytag: member="Variance" ref="f504f810448961fc489e9b6572471705e965a9e5381745e6e3a75342d7c8e075" args="" -->Variance</em>&nbsp;</td><td>
308 </td></tr>
309 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7"></a><!-- doxytag: member="StandardDeviation" ref="f504f810448961fc489e9b65724717059342cd2209e20b93843cd389d9511ec7" args="" -->StandardDeviation</em>&nbsp;</td><td>
310 </td></tr>
311 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6"></a><!-- doxytag: member="Count" ref="f504f810448961fc489e9b65724717052395772fa2e74b3f617e20c76d579ad6" args="" -->Count</em>&nbsp;</td><td>
312 </td></tr>
313 <tr><td valign="top"><em><a class="anchor" name="f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c"></a><!-- doxytag: member="UnknownSummaryType" ref="f504f810448961fc489e9b6572471705eed3a16d665eb789053b82fdd386ee7c" args="" -->UnknownSummaryType</em>&nbsp;</td><td>
314 </td></tr> 329 </td></tr>
315 </table> 330 </table>
331 </dd>
316 </dl> 332 </dl>
317 333
318 <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> 334 <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>
319 335
320 </div> 336 </div>
321 </div><p> 337 </div>
322 <a class="anchor" name="294e9eed9c541dcedbaa4f2dfda1ac76"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod" ref="294e9eed9c541dcedbaa4f2dfda1ac76" args="" --> 338 <a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod" ref="a294e9eed9c541dcedbaa4f2dfda1ac76" args="" -->
323 <div class="memitem"> 339 <div class="memitem">
324 <div class="memproto"> 340 <div class="memproto">
325 <table class="memname"> 341 <table class="memname">
326 <tr> 342 <tr>
327 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod</a> </td> 343 <td class="memname">enum <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">Vamp::HostExt::PluginSummarisingAdapter::AveragingMethod</a></td>
328 </tr> 344 </tr>
329 </table> 345 </table>
330 </div> 346 </div>
331 <div class="memdoc"> 347 <div class="memdoc">
332 348
333 <p> 349 <p>AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. </p>
334 AveragingMethod indicates how the adapter should handle average-based summaries of features whose results are not equally spaced in time. 350 <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>
335 <p> 351 <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>
336 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>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>
337 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 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
338 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). <dl compact><dt><b>Enumerator: </b></dt><dd> 354 <tr><td valign="top"><em><a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36"></a><!-- doxytag: member="SampleAverage" ref="a294e9eed9c541dcedbaa4f2dfda1ac76ae8833d866dec593d29f1f4e3cd1e6e36" args="" -->SampleAverage</em>&nbsp;</td><td>
339 <table border="0" cellspacing="2" cellpadding="0"> 355 </td></tr>
340 <tr><td valign="top"><em><a class="anchor" name="294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36"></a><!-- doxytag: member="SampleAverage" ref="294e9eed9c541dcedbaa4f2dfda1ac76e8833d866dec593d29f1f4e3cd1e6e36" args="" -->SampleAverage</em>&nbsp;</td><td> 356 <tr><td valign="top"><em><a class="anchor" id="a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa"></a><!-- doxytag: member="ContinuousTimeAverage" ref="a294e9eed9c541dcedbaa4f2dfda1ac76a6af6316c12e29bdbdff90c5fec764baa" args="" -->ContinuousTimeAverage</em>&nbsp;</td><td>
341 </td></tr>
342 <tr><td valign="top"><em><a class="anchor" name="294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa"></a><!-- doxytag: member="ContinuousTimeAverage" ref="294e9eed9c541dcedbaa4f2dfda1ac766af6316c12e29bdbdff90c5fec764baa" args="" -->ContinuousTimeAverage</em>&nbsp;</td><td>
343 </td></tr> 357 </td></tr>
344 </table> 358 </table>
359 </dd>
345 </dl> 360 </dl>
346 361
347 <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> 362 <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>
348 363
349 </div> 364 </div>
350 </div><p> 365 </div>
351 <a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::InputDomain" ref="39cb7649d6dcc20e4cb1640cd55907bc" args="" --> 366 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::InputDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bc" args="" -->
352 <div class="memitem"> 367 <div class="memitem">
353 <div class="memproto"> 368 <div class="memproto">
354 <table class="memname"> 369 <table class="memname">
355 <tr> 370 <tr>
356 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code> </td> 371 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td>
357 </tr> 372 </tr>
358 </table> 373 </table>
359 </div> 374 </div>
360 <div class="memdoc"> 375 <div class="memdoc">
361 376 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
362 <p> 377 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
363 <dl compact><dt><b>Enumerator: </b></dt><dd> 378 </td></tr>
364 <table border="0" cellspacing="2" cellpadding="0"> 379 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
365 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff"></a><!-- doxytag: member="TimeDomain" ref="39cb7649d6dcc20e4cb1640cd55907bcd4a9f31b958a43a9757af7893aa2e7ff" args="" -->TimeDomain</em>&nbsp;</td><td>
366 </td></tr>
367 <tr><td valign="top"><em><a class="anchor" name="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53"></a><!-- doxytag: member="FrequencyDomain" ref="39cb7649d6dcc20e4cb1640cd55907bca30e7877ab33f76acbdca28607e6ab53" args="" -->FrequencyDomain</em>&nbsp;</td><td>
368 </td></tr> 380 </td></tr>
369 </table> 381 </table>
382 </dd>
370 </dl> 383 </dl>
371 384
372 <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> 385 <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>
373 386
374 </div> 387 </div>
375 </div><p> 388 </div>
376 <hr><h2>Constructor &amp; Destructor Documentation</h2> 389 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
377 <a class="anchor" name="31b41f54560a2ae6c3ec1a945f3f1d68"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter" ref="31b41f54560a2ae6c3ec1a945f3f1d68" args="(Plugin *plugin)" --> 390 <a class="anchor" id="a31b41f54560a2ae6c3ec1a945f3f1d68"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter" ref="a31b41f54560a2ae6c3ec1a945f3f1d68" args="(Plugin *plugin)" -->
378 <div class="memitem"> 391 <div class="memitem">
379 <div class="memproto"> 392 <div class="memproto">
380 <table class="memname"> 393 <table class="memname">
381 <tr> 394 <tr>
382 <td class="memname">Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter </td> 395 <td class="memname">Vamp::HostExt::PluginSummarisingAdapter::PluginSummarisingAdapter </td>
383 <td>(</td> 396 <td>(</td>
384 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td> 397 <td class="paramtype"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td>
385 <td class="paramname"> <em>plugin</em> </td> 398 <td class="paramname"><em>plugin</em></td><td>)</td>
386 <td>&nbsp;)&nbsp;</td> 399 <td></td>
387 <td></td> 400 </tr>
388 </tr> 401 </table>
389 </table> 402 </div>
390 </div> 403 <div class="memdoc">
391 <div class="memdoc"> 404
392 405 <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>
393 <p> 406 <p>The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. </p>
394 Construct a <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods...">PluginSummarisingAdapter</a> wrapping the given plugin. 407
395 <p> 408 </div>
396 The adapter takes ownership of the plugin, which will be deleted when the adapter is deleted. 409 </div>
397 </div> 410 <a class="anchor" id="a47846e7cc0ef4a29335e08b9645316d0"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter" ref="a47846e7cc0ef4a29335e08b9645316d0" args="()" -->
398 </div><p> 411 <div class="memitem">
399 <a class="anchor" name="47846e7cc0ef4a29335e08b9645316d0"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter" ref="47846e7cc0ef4a29335e08b9645316d0" args="()" --> 412 <div class="memproto">
400 <div class="memitem"> 413 <table class="memname">
401 <div class="memproto"> 414 <tr>
402 <table class="memname"> 415 <td class="memname">virtual Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter </td>
403 <tr> 416 <td>(</td>
404 <td class="memname">virtual Vamp::HostExt::PluginSummarisingAdapter::~PluginSummarisingAdapter </td> 417 <td class="paramname"></td><td>)</td>
405 <td>(</td>
406 <td class="paramname"> </td>
407 <td>&nbsp;)&nbsp;</td>
408 <td><code> [virtual]</code></td> 418 <td><code> [virtual]</code></td>
409 </tr> 419 </tr>
410 </table> 420 </table>
411 </div> 421 </div>
412 <div class="memdoc"> 422 <div class="memdoc">
413 423
414 <p> 424 </div>
415 425 </div>
416 </div> 426 <hr/><h2>Member Function Documentation</h2>
417 </div><p> 427 <a class="anchor" id="a1e994576d43efe103bf8f83b69716745"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::initialise" ref="a1e994576d43efe103bf8f83b69716745" args="(size_t channels, size_t stepSize, size_t blockSize)" -->
418 <hr><h2>Member Function Documentation</h2> 428 <div class="memitem">
419 <a class="anchor" name="1e994576d43efe103bf8f83b69716745"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::initialise" ref="1e994576d43efe103bf8f83b69716745" args="(size_t channels, size_t stepSize, size_t blockSize)" --> 429 <div class="memproto">
420 <div class="memitem"> 430 <table class="memname">
421 <div class="memproto"> 431 <tr>
422 <table class="memname"> 432 <td class="memname">bool Vamp::HostExt::PluginSummarisingAdapter::initialise </td>
423 <tr> 433 <td>(</td>
424 <td class="memname">bool Vamp::HostExt::PluginSummarisingAdapter::initialise </td> 434 <td class="paramtype">size_t&#160;</td>
425 <td>(</td> 435 <td class="paramname"><em>inputChannels</em>, </td>
426 <td class="paramtype">size_t&nbsp;</td>
427 <td class="paramname"> <em>inputChannels</em>, </td>
428 </tr> 436 </tr>
429 <tr> 437 <tr>
430 <td class="paramkey"></td> 438 <td class="paramkey"></td>
431 <td></td> 439 <td></td>
432 <td class="paramtype">size_t&nbsp;</td> 440 <td class="paramtype">size_t&#160;</td>
433 <td class="paramname"> <em>stepSize</em>, </td> 441 <td class="paramname"><em>stepSize</em>, </td>
434 </tr> 442 </tr>
435 <tr> 443 <tr>
436 <td class="paramkey"></td> 444 <td class="paramkey"></td>
437 <td></td> 445 <td></td>
438 <td class="paramtype">size_t&nbsp;</td> 446 <td class="paramtype">size_t&#160;</td>
439 <td class="paramname"> <em>blockSize</em></td><td>&nbsp;</td> 447 <td class="paramname"><em>blockSize</em>&#160;</td>
440 </tr> 448 </tr>
441 <tr> 449 <tr>
442 <td></td> 450 <td></td>
443 <td>)</td> 451 <td>)</td>
444 <td></td><td></td><td><code> [virtual]</code></td> 452 <td></td><td><code> [virtual]</code></td>
445 </tr> 453 </tr>
446 </table> 454 </table>
447 </div> 455 </div>
448 <div class="memdoc"> 456 <div class="memdoc">
449 457
450 <p> 458 <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>
451 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). 459 <p>The input sample rate should have been already specified at construction time.</p>
452 <p> 460 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
453 The input sample rate should have been already specified at construction time.<p> 461
454 Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. 462 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p>
455 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137">Vamp::HostExt::PluginWrapper</a>.</p> 463
456 464 </div>
457 </div> 465 </div>
458 </div><p> 466 <a class="anchor" id="a3402381d145d507bd26d1a67e3616911"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::reset" ref="a3402381d145d507bd26d1a67e3616911" args="()" -->
459 <a class="anchor" name="3402381d145d507bd26d1a67e3616911"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::reset" ref="3402381d145d507bd26d1a67e3616911" args="()" --> 467 <div class="memitem">
460 <div class="memitem"> 468 <div class="memproto">
461 <div class="memproto"> 469 <table class="memname">
462 <table class="memname"> 470 <tr>
463 <tr> 471 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::reset </td>
464 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::reset </td> 472 <td>(</td>
465 <td>(</td> 473 <td class="paramname"></td><td>)</td>
466 <td class="paramname"> </td>
467 <td>&nbsp;)&nbsp;</td>
468 <td><code> [virtual]</code></td> 474 <td><code> [virtual]</code></td>
469 </tr> 475 </tr>
470 </table> 476 </table>
471 </div> 477 </div>
472 <div class="memdoc"> 478 <div class="memdoc">
473 479
474 <p> 480 <p>Reset the plugin after use, to prepare it for another clean run. </p>
475 Reset the plugin after use, to prepare it for another clean run. 481 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
476 <p> 482
477 Not called for the first initialisation (i.e. initialise must also do a reset). 483 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p>
478 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#d19cc0614ba41cdc26ef3394c5146fe6">Vamp::HostExt::PluginWrapper</a>.</p> 484
479 485 </div>
480 </div> 486 </div>
481 </div><p> 487 <a class="anchor" id="a3314b456a4780601c021dac25b478846"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::process" ref="a3314b456a4780601c021dac25b478846" args="(const float *const *inputBuffers, RealTime timestamp)" -->
482 <a class="anchor" name="3314b456a4780601c021dac25b478846"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::process" ref="3314b456a4780601c021dac25b478846" args="(const float *const *inputBuffers, RealTime timestamp)" --> 488 <div class="memitem">
483 <div class="memitem"> 489 <div class="memproto">
484 <div class="memproto"> 490 <table class="memname">
485 <table class="memname"> 491 <tr>
486 <tr> 492 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::process </td>
487 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::process </td> 493 <td>(</td>
488 <td>(</td> 494 <td class="paramtype">const float *const *&#160;</td>
489 <td class="paramtype">const float *const *&nbsp;</td> 495 <td class="paramname"><em>inputBuffers</em>, </td>
490 <td class="paramname"> <em>inputBuffers</em>, </td>
491 </tr> 496 </tr>
492 <tr> 497 <tr>
493 <td class="paramkey"></td> 498 <td class="paramkey"></td>
494 <td></td> 499 <td></td>
495 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td> 500 <td class="paramtype"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td>
496 <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td> 501 <td class="paramname"><em>timestamp</em>&#160;</td>
497 </tr> 502 </tr>
498 <tr> 503 <tr>
499 <td></td> 504 <td></td>
500 <td>)</td> 505 <td>)</td>
501 <td></td><td></td><td><code> [virtual]</code></td> 506 <td></td><td><code> [virtual]</code></td>
502 </tr> 507 </tr>
503 </table> 508 </table>
504 </div> 509 </div>
505 <div class="memdoc"> 510 <div class="memdoc">
506 511
507 <p> 512 <p>Process a single block of input data. </p>
508 Process a single block of input data. 513 <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>
509 <p> 514 <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 FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
510 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>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>
511 If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).<p> 516
512 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.) 517 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p>
513 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf">Vamp::HostExt::PluginWrapper</a>.</p> 518
514 519 </div>
515 </div> 520 </div>
516 </div><p> 521 <a class="anchor" id="ae9dcbd1ba8197ff90b4fc6bf7ade7688"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures" ref="ae9dcbd1ba8197ff90b4fc6bf7ade7688" args="()" -->
517 <a class="anchor" name="e9dcbd1ba8197ff90b4fc6bf7ade7688"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures" ref="e9dcbd1ba8197ff90b4fc6bf7ade7688" args="()" --> 522 <div class="memitem">
518 <div class="memitem"> 523 <div class="memproto">
519 <div class="memproto"> 524 <table class="memname">
520 <table class="memname"> 525 <tr>
521 <tr> 526 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures </td>
522 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getRemainingFeatures </td> 527 <td>(</td>
523 <td>(</td> 528 <td class="paramname"></td><td>)</td>
524 <td class="paramname"> </td>
525 <td>&nbsp;)&nbsp;</td>
526 <td><code> [virtual]</code></td> 529 <td><code> [virtual]</code></td>
527 </tr> 530 </tr>
528 </table> 531 </table>
529 </div> 532 </div>
530 <div class="memdoc"> 533 <div class="memdoc">
531 534
532 <p> 535 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
533 After all blocks have been processed, calculate and return any remaining features derived from the complete input. 536
534 <p> 537 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p>
535 538
536 <p>Reimplemented from <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#2bc8c0992e64f06991fb7cf89f99857e">Vamp::HostExt::PluginWrapper</a>.</p> 539 </div>
537 540 </div>
538 </div> 541 <a class="anchor" id="a1a659500ca1290a228c0b9b91f6ac0b7"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries" ref="a1a659500ca1290a228c0b9b91f6ac0b7" args="(const SegmentBoundaries &amp;)" -->
539 </div><p> 542 <div class="memitem">
540 <a class="anchor" name="1a659500ca1290a228c0b9b91f6ac0b7"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries" ref="1a659500ca1290a228c0b9b91f6ac0b7" args="(const SegmentBoundaries &amp;)" --> 543 <div class="memproto">
541 <div class="memitem"> 544 <table class="memname">
542 <div class="memproto"> 545 <tr>
543 <table class="memname"> 546 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries </td>
544 <tr> 547 <td>(</td>
545 <td class="memname">void Vamp::HostExt::PluginSummarisingAdapter::setSummarySegmentBoundaries </td> 548 <td class="paramtype">const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;&#160;</td>
546 <td>(</td> 549 <td class="paramname"></td><td>)</td>
547 <td class="paramtype">const <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#74e7f93c745802a2409185b63922466b">SegmentBoundaries</a> &amp;&nbsp;</td> 550 <td></td>
548 <td class="paramname"> </td> 551 </tr>
549 <td>&nbsp;)&nbsp;</td> 552 </table>
550 <td></td> 553 </div>
551 </tr> 554 <div class="memdoc">
552 </table> 555
553 </div> 556 <p>Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. </p>
554 <div class="memdoc"> 557 <p>This function must be called before getSummaryForOutput or getSummaryForAllOutputs.</p>
555 558 <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>
556 <p> 559
557 Specify a series of segment boundaries, such that one summary will be returned for each of the contiguous intra-boundary segments. 560 </div>
558 <p> 561 </div>
559 This function must be called before getSummaryForOutput or getSummaryForAllOutputs.<p> 562 <a class="anchor" id="abe13faa68d3244b962dbd362671e23f9"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput" ref="abe13faa68d3244b962dbd362671e23f9" args="(int output, SummaryType type, AveragingMethod method=SampleAverage)" -->
560 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. 563 <div class="memitem">
561 </div> 564 <div class="memproto">
562 </div><p> 565 <table class="memname">
563 <a class="anchor" name="be13faa68d3244b962dbd362671e23f9"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput" ref="be13faa68d3244b962dbd362671e23f9" args="(int output, SummaryType type, AveragingMethod method=SampleAverage)" --> 566 <tr>
564 <div class="memitem"> 567 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput </td>
565 <div class="memproto"> 568 <td>(</td>
566 <table class="memname"> 569 <td class="paramtype">int&#160;</td>
567 <tr> 570 <td class="paramname"><em>output</em>, </td>
568 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForOutput </td>
569 <td>(</td>
570 <td class="paramtype">int&nbsp;</td>
571 <td class="paramname"> <em>output</em>, </td>
572 </tr> 571 </tr>
573 <tr> 572 <tr>
574 <td class="paramkey"></td> 573 <td class="paramkey"></td>
575 <td></td> 574 <td></td>
576 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a>&nbsp;</td> 575 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a>&#160;</td>
577 <td class="paramname"> <em>type</em>, </td> 576 <td class="paramname"><em>type</em>, </td>
578 </tr> 577 </tr>
579 <tr> 578 <tr>
580 <td class="paramkey"></td> 579 <td class="paramkey"></td>
581 <td></td> 580 <td></td>
582 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a>&nbsp;</td> 581 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a>&#160;</td>
583 <td class="paramname"> <em>method</em> = <code>SampleAverage</code></td><td>&nbsp;</td> 582 <td class="paramname"><em>method</em> = <code>SampleAverage</code>&#160;</td>
584 </tr> 583 </tr>
585 <tr> 584 <tr>
586 <td></td> 585 <td></td>
587 <td>)</td> 586 <td>)</td>
588 <td></td><td></td><td></td> 587 <td></td><td></td>
589 </tr> 588 </tr>
590 </table> 589 </table>
591 </div> 590 </div>
592 <div class="memdoc"> 591 <div class="memdoc">
593 592
594 <p> 593 <p>Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. </p>
595 Return summaries of the features that were returned on the given output, using the given SummaryType and AveragingMethod. 594 <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 <p> 595
597 The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3314b456a4780601c021dac25b478846" title="Process a single block of input data.">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. 596 </div>
598 </div> 597 </div>
599 </div><p> 598 <a class="anchor" id="ac3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs" ref="ac3f93d9ca2d25c9fdc80d0ba10eaaa6b" args="(SummaryType type, AveragingMethod method=SampleAverage)" -->
600 <a class="anchor" name="c3f93d9ca2d25c9fdc80d0ba10eaaa6b"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs" ref="c3f93d9ca2d25c9fdc80d0ba10eaaa6b" args="(SummaryType type, AveragingMethod method=SampleAverage)" --> 599 <div class="memitem">
601 <div class="memitem"> 600 <div class="memproto">
602 <div class="memproto"> 601 <table class="memname">
603 <table class="memname"> 602 <tr>
604 <tr> 603 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs </td>
605 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::HostExt::PluginSummarisingAdapter::getSummaryForAllOutputs </td> 604 <td>(</td>
606 <td>(</td> 605 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#af504f810448961fc489e9b6572471705">SummaryType</a>&#160;</td>
607 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f504f810448961fc489e9b6572471705">SummaryType</a>&nbsp;</td> 606 <td class="paramname"><em>type</em>, </td>
608 <td class="paramname"> <em>type</em>, </td>
609 </tr> 607 </tr>
610 <tr> 608 <tr>
611 <td class="paramkey"></td> 609 <td class="paramkey"></td>
612 <td></td> 610 <td></td>
613 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a>&nbsp;</td> 611 <td class="paramtype"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#a294e9eed9c541dcedbaa4f2dfda1ac76">AveragingMethod</a>&#160;</td>
614 <td class="paramname"> <em>method</em> = <code>SampleAverage</code></td><td>&nbsp;</td> 612 <td class="paramname"><em>method</em> = <code>SampleAverage</code>&#160;</td>
615 </tr> 613 </tr>
616 <tr> 614 <tr>
617 <td></td> 615 <td></td>
618 <td>)</td> 616 <td>)</td>
619 <td></td><td></td><td></td> 617 <td></td><td></td>
620 </tr> 618 </tr>
621 </table> 619 </table>
622 </div> 620 </div>
623 <div class="memdoc"> 621 <div class="memdoc">
624 622
625 <p> 623 <p>Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. </p>
626 Return summaries of the features that were returned on all of the plugin's outputs, using the given SummaryType and AveragingMethod. 624 <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>
627 <p> 625
628 The plugin must have been fully run (<a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#3314b456a4780601c021dac25b478846" title="Process a single block of input data.">process()</a> and <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#e9dcbd1ba8197ff90b4fc6bf7ade7688" title="After all blocks have been processed, calculate and return any remaining features...">getRemainingFeatures()</a> calls all made as appropriate) before this function is called. 626 </div>
629 </div> 627 </div>
630 </div><p> 628 <a class="anchor" id="ae203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getInputDomain" ref="ae203faf8384c9e1fddc381409aa8a214" args="() const " -->
631 <a class="anchor" name="e203faf8384c9e1fddc381409aa8a214"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getInputDomain" ref="e203faf8384c9e1fddc381409aa8a214" args="() const " --> 629 <div class="memitem">
632 <div class="memitem"> 630 <div class="memproto">
633 <div class="memproto"> 631 <table class="memname">
634 <table class="memname"> 632 <tr>
635 <tr> 633 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td>
636 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::HostExt::PluginWrapper::getInputDomain </td> 634 <td>(</td>
637 <td>(</td> 635 <td class="paramname"></td><td>)</td>
638 <td class="paramname"> </td> 636 <td> const<code> [virtual, inherited]</code></td>
639 <td>&nbsp;)&nbsp;</td> 637 </tr>
640 <td> const<code> [virtual, inherited]</code></td> 638 </table>
641 </tr> 639 </div>
642 </table> 640 <div class="memdoc">
643 </div> 641
644 <div class="memdoc"> 642 <p>Get the plugin's required input domain. </p>
645 643 <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>
646 <p> 644 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The input data for the FFT 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>
647 Get the plugin's required input domain. 645
648 <p> 646 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
649 If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function (below) will be in the time domain, as for a traditional audio processing plugin.<p> 647
650 If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a>. The input data for the FFT 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. 648 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p>
651 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#e1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 649
652 650 </div>
653 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#47ff1ed72889f323da63f8abc9ea581a">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 651 </div>
654 652 <a class="anchor" id="a74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getVampApiVersion" ref="a74147fda6b44ff2169bd4a1eea0d46ff" args="() const " -->
655 </div> 653 <div class="memitem">
656 </div><p> 654 <div class="memproto">
657 <a class="anchor" name="74147fda6b44ff2169bd4a1eea0d46ff"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getVampApiVersion" ref="74147fda6b44ff2169bd4a1eea0d46ff" args="() const " --> 655 <table class="memname">
658 <div class="memitem"> 656 <tr>
659 <div class="memproto"> 657 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td>
660 <table class="memname"> 658 <td>(</td>
661 <tr> 659 <td class="paramname"></td><td>)</td>
662 <td class="memname">unsigned int Vamp::HostExt::PluginWrapper::getVampApiVersion </td> 660 <td> const<code> [virtual, inherited]</code></td>
663 <td>(</td> 661 </tr>
664 <td class="paramname"> </td> 662 </table>
665 <td>&nbsp;)&nbsp;</td> 663 </div>
666 <td> const<code> [virtual, inherited]</code></td> 664 <div class="memdoc">
667 </tr> 665
668 </table> 666 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
669 </div> 667
670 <div class="memdoc"> 668 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p>
671 669
672 <p> 670 </div>
673 Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. 671 </div>
674 <p> 672 <a class="anchor" id="a4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getIdentifier" ref="a4baa9e48f717c2b3e7f92496aa39d904" args="() const " -->
675 673 <div class="memitem">
676 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 674 <div class="memproto">
677 675 <table class="memname">
678 </div> 676 <tr>
679 </div><p> 677 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td>
680 <a class="anchor" name="4baa9e48f717c2b3e7f92496aa39d904"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getIdentifier" ref="4baa9e48f717c2b3e7f92496aa39d904" args="() const " --> 678 <td>(</td>
681 <div class="memitem"> 679 <td class="paramname"></td><td>)</td>
682 <div class="memproto"> 680 <td> const<code> [virtual, inherited]</code></td>
683 <table class="memname"> 681 </tr>
684 <tr> 682 </table>
685 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getIdentifier </td> 683 </div>
686 <td>(</td> 684 <div class="memdoc">
687 <td class="paramname"> </td> 685
688 <td>&nbsp;)&nbsp;</td> 686 <p>Get the computer-usable name of the plugin. </p>
689 <td> const<code> [virtual, inherited]</code></td> 687 <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>
690 </tr> 688 <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>
691 </table> 689 <p>Example: "zero_crossings" </p>
692 </div> 690
693 <div class="memdoc"> 691 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
694 692
695 <p> 693 </div>
696 Get the computer-usable name of the plugin. 694 </div>
697 <p> 695 <a class="anchor" id="ac70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getName" ref="ac70a3265bb25aeb03f6dd8f8a0442088" args="() const " -->
698 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> 696 <div class="memitem">
699 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> 697 <div class="memproto">
700 Example: "zero_crossings" 698 <table class="memname">
701 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#d1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 699 <tr>
702 700 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td>
703 </div> 701 <td>(</td>
704 </div><p> 702 <td class="paramname"></td><td>)</td>
705 <a class="anchor" name="c70a3265bb25aeb03f6dd8f8a0442088"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getName" ref="c70a3265bb25aeb03f6dd8f8a0442088" args="() const " --> 703 <td> const<code> [virtual, inherited]</code></td>
706 <div class="memitem"> 704 </tr>
707 <div class="memproto"> 705 </table>
708 <table class="memname"> 706 </div>
709 <tr> 707 <div class="memdoc">
710 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getName </td> 708
711 <td>(</td> 709 <p>Get a human-readable name or title of the plugin. </p>
712 <td class="paramname"> </td> 710 <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>
713 <td>&nbsp;)&nbsp;</td> 711 <p>Example: "Zero Crossings" </p>
714 <td> const<code> [virtual, inherited]</code></td> 712
715 </tr> 713 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
716 </table> 714
717 </div> 715 </div>
718 <div class="memdoc"> 716 </div>
719 717 <a class="anchor" id="ac334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getDescription" ref="ac334f699c0996055942785410d8a065c" args="() const " -->
720 <p> 718 <div class="memitem">
721 Get a human-readable name or title of the plugin. 719 <div class="memproto">
722 <p> 720 <table class="memname">
723 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> 721 <tr>
724 Example: "Zero Crossings" 722 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td>
725 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 723 <td>(</td>
726 724 <td class="paramname"></td><td>)</td>
727 </div> 725 <td> const<code> [virtual, inherited]</code></td>
728 </div><p> 726 </tr>
729 <a class="anchor" name="c334f699c0996055942785410d8a065c"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getDescription" ref="c334f699c0996055942785410d8a065c" args="() const " --> 727 </table>
730 <div class="memitem"> 728 </div>
731 <div class="memproto"> 729 <div class="memdoc">
732 <table class="memname"> 730
733 <tr> 731 <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>
734 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getDescription </td> 732 <p>May be empty if the name has said it all already.</p>
735 <td>(</td> 733 <p>Example: "Detect and count zero crossing points" </p>
736 <td class="paramname"> </td> 734
737 <td>&nbsp;)&nbsp;</td> 735 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
738 <td> const<code> [virtual, inherited]</code></td> 736
739 </tr> 737 </div>
740 </table> 738 </div>
741 </div> 739 <a class="anchor" id="a59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMaker" ref="a59d5a2298951b317995675e664b1c7bb" args="() const " -->
742 <div class="memdoc"> 740 <div class="memitem">
743 741 <div class="memproto">
744 <p> 742 <table class="memname">
745 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". 743 <tr>
746 <p> 744 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td>
747 May be empty if the name has said it all already.<p> 745 <td>(</td>
748 Example: "Detect and count zero crossing points" 746 <td class="paramname"></td><td>)</td>
749 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 747 <td> const<code> [virtual, inherited]</code></td>
750 748 </tr>
751 </div> 749 </table>
752 </div><p> 750 </div>
753 <a class="anchor" name="59d5a2298951b317995675e664b1c7bb"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMaker" ref="59d5a2298951b317995675e664b1c7bb" args="() const " --> 751 <div class="memdoc">
754 <div class="memitem"> 752
755 <div class="memproto"> 753 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
756 <table class="memname"> 754 <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>
757 <tr> 755
758 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getMaker </td> 756 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
759 <td>(</td> 757
760 <td class="paramname"> </td> 758 </div>
761 <td>&nbsp;)&nbsp;</td> 759 </div>
762 <td> const<code> [virtual, inherited]</code></td> 760 <a class="anchor" id="a47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPluginVersion" ref="a47e1acf1696813008324a915c9ba59c5" args="() const " -->
763 </tr> 761 <div class="memitem">
764 </table> 762 <div class="memproto">
765 </div> 763 <table class="memname">
766 <div class="memdoc"> 764 <tr>
767 765 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td>
768 <p> 766 <td>(</td>
769 Get the name of the author or vendor of the plugin in human-readable form. 767 <td class="paramname"></td><td>)</td>
770 <p> 768 <td> const<code> [virtual, inherited]</code></td>
771 This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. 769 </tr>
772 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 770 </table>
773 771 </div>
774 </div> 772 <div class="memdoc">
775 </div><p> 773
776 <a class="anchor" name="47e1acf1696813008324a915c9ba59c5"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPluginVersion" ref="47e1acf1696813008324a915c9ba59c5" args="() const " --> 774 <p>Get the version number of the plugin. </p>
777 <div class="memitem"> 775
778 <div class="memproto"> 776 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
779 <table class="memname"> 777
780 <tr> 778 </div>
781 <td class="memname">int Vamp::HostExt::PluginWrapper::getPluginVersion </td> 779 </div>
782 <td>(</td> 780 <a class="anchor" id="ae14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getCopyright" ref="ae14f6ecb78be909c4cd5f0cdaed3c566" args="() const " -->
783 <td class="paramname"> </td> 781 <div class="memitem">
784 <td>&nbsp;)&nbsp;</td> 782 <div class="memproto">
785 <td> const<code> [virtual, inherited]</code></td> 783 <table class="memname">
786 </tr> 784 <tr>
787 </table> 785 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td>
788 </div> 786 <td>(</td>
789 <div class="memdoc"> 787 <td class="paramname"></td><td>)</td>
790 788 <td> const<code> [virtual, inherited]</code></td>
791 <p> 789 </tr>
792 Get the version number of the plugin. 790 </table>
793 <p> 791 </div>
794 792 <div class="memdoc">
795 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 793
796 794 <p>Get the copyright statement or licensing summary for the plugin. </p>
797 </div> 795 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
798 </div><p> 796
799 <a class="anchor" name="e14f6ecb78be909c4cd5f0cdaed3c566"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getCopyright" ref="e14f6ecb78be909c4cd5f0cdaed3c566" args="() const " --> 797 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
800 <div class="memitem"> 798
801 <div class="memproto"> 799 </div>
802 <table class="memname"> 800 </div>
803 <tr> 801 <a class="anchor" id="a9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getParameterDescriptors" ref="a9be71561265c2e6e43b7feaddaa91f36" args="() const " -->
804 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCopyright </td> 802 <div class="memitem">
805 <td>(</td> 803 <div class="memproto">
806 <td class="paramname"> </td> 804 <table class="memname">
807 <td>&nbsp;)&nbsp;</td> 805 <tr>
808 <td> const<code> [virtual, inherited]</code></td> 806 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td>
809 </tr> 807 <td>(</td>
810 </table> 808 <td class="paramname"></td><td>)</td>
811 </div> 809 <td> const<code> [virtual, inherited]</code></td>
812 <div class="memdoc"> 810 </tr>
813 811 </table>
814 <p> 812 </div>
815 Get the copyright statement or licensing summary for the plugin. 813 <div class="memdoc">
816 <p> 814
817 This can be an informative text, without the same presentation constraints as mentioned for getMaker above. 815 <p>Get the controllable parameters of this plugin. </p>
818 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#b7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 816
819 817 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p>
820 </div> 818
821 </div><p> 819 </div>
822 <a class="anchor" name="9be71561265c2e6e43b7feaddaa91f36"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getParameterDescriptors" ref="9be71561265c2e6e43b7feaddaa91f36" args="() const " --> 820 </div>
823 <div class="memitem"> 821 <a class="anchor" id="a034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getParameter" ref="a034920f56c8d7609a85447c42556048c" args="(std::string) const " -->
824 <div class="memproto"> 822 <div class="memitem">
825 <table class="memname"> 823 <div class="memproto">
826 <tr> 824 <table class="memname">
827 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::HostExt::PluginWrapper::getParameterDescriptors </td> 825 <tr>
828 <td>(</td> 826 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td>
829 <td class="paramname"> </td> 827 <td>(</td>
830 <td>&nbsp;)&nbsp;</td> 828 <td class="paramtype">std::string&#160;</td>
831 <td> const<code> [virtual, inherited]</code></td> 829 <td class="paramname"></td><td>)</td>
832 </tr> 830 <td> const<code> [virtual, inherited]</code></td>
833 </table> 831 </tr>
834 </div> 832 </table>
835 <div class="memdoc"> 833 </div>
836 834 <div class="memdoc">
837 <p> 835
838 Get the controllable parameters of this plugin. 836 <p>Get the value of a named parameter. </p>
839 <p> 837 <p>The argument is the identifier field from that parameter's descriptor. </p>
840 838
841 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 839 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
842 840
843 </div> 841 </div>
844 </div><p> 842 </div>
845 <a class="anchor" name="034920f56c8d7609a85447c42556048c"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getParameter" ref="034920f56c8d7609a85447c42556048c" args="(std::string) const " --> 843 <a class="anchor" id="a651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::setParameter" ref="a651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
846 <div class="memitem"> 844 <div class="memitem">
847 <div class="memproto"> 845 <div class="memproto">
848 <table class="memname"> 846 <table class="memname">
849 <tr> 847 <tr>
850 <td class="memname">float Vamp::HostExt::PluginWrapper::getParameter </td> 848 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
851 <td>(</td> 849 <td>(</td>
852 <td class="paramtype">std::string&nbsp;</td> 850 <td class="paramtype">std::string&#160;</td>
853 <td class="paramname"> </td>
854 <td>&nbsp;)&nbsp;</td>
855 <td> const<code> [virtual, inherited]</code></td>
856 </tr>
857 </table>
858 </div>
859 <div class="memdoc">
860
861 <p>
862 Get the value of a named parameter.
863 <p>
864 The argument is the identifier field from that parameter's descriptor.
865 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p>
866
867 </div>
868 </div><p>
869 <a class="anchor" name="651b15a5dc4c27942ac0c87c6092bfe5"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::setParameter" ref="651b15a5dc4c27942ac0c87c6092bfe5" args="(std::string, float)" -->
870 <div class="memitem">
871 <div class="memproto">
872 <table class="memname">
873 <tr>
874 <td class="memname">void Vamp::HostExt::PluginWrapper::setParameter </td>
875 <td>(</td>
876 <td class="paramtype">std::string&nbsp;</td>
877 <td class="paramname">, </td> 851 <td class="paramname">, </td>
878 </tr> 852 </tr>
879 <tr> 853 <tr>
880 <td class="paramkey"></td> 854 <td class="paramkey"></td>
881 <td></td> 855 <td></td>
882 <td class="paramtype">float&nbsp;</td> 856 <td class="paramtype">float&#160;</td>
883 <td class="paramname"></td><td>&nbsp;</td> 857 <td class="paramname">&#160;</td>
884 </tr> 858 </tr>
885 <tr> 859 <tr>
886 <td></td> 860 <td></td>
887 <td>)</td> 861 <td>)</td>
888 <td></td><td></td><td><code> [virtual, inherited]</code></td> 862 <td></td><td><code> [virtual, inherited]</code></td>
889 </tr> 863 </tr>
890 </table> 864 </table>
891 </div> 865 </div>
892 <div class="memdoc"> 866 <div class="memdoc">
893 867
894 <p> 868 <p>Set a named parameter. </p>
895 Set a named parameter. 869 <p>The first argument is the identifier field from that parameter's descriptor. </p>
896 <p> 870
897 The first argument is the identifier field from that parameter's descriptor. 871 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
898 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 872
899 873 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
900 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 874
901 875 </div>
902 </div> 876 </div>
903 </div><p> 877 <a class="anchor" id="a131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPrograms" ref="a131fbe1df81215020b9aa8cecef4c802" args="() const " -->
904 <a class="anchor" name="131fbe1df81215020b9aa8cecef4c802"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPrograms" ref="131fbe1df81215020b9aa8cecef4c802" args="() const " --> 878 <div class="memitem">
905 <div class="memitem"> 879 <div class="memproto">
906 <div class="memproto"> 880 <table class="memname">
907 <table class="memname"> 881 <tr>
908 <tr> 882 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td>
909 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::HostExt::PluginWrapper::getPrograms </td> 883 <td>(</td>
910 <td>(</td> 884 <td class="paramname"></td><td>)</td>
911 <td class="paramname"> </td> 885 <td> const<code> [virtual, inherited]</code></td>
912 <td>&nbsp;)&nbsp;</td> 886 </tr>
913 <td> const<code> [virtual, inherited]</code></td> 887 </table>
914 </tr> 888 </div>
915 </table> 889 <div class="memdoc">
916 </div> 890
917 <div class="memdoc"> 891 <p>Get the program settings available in this plugin. </p>
918 892 <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>
919 <p> 893 <p>The programs must have unique names. </p>
920 Get the program settings available in this plugin. 894
921 <p> 895 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p>
922 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> 896
923 The programs must have unique names. 897 </div>
924 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#bb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 898 </div>
925 899 <a class="anchor" id="a7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getCurrentProgram" ref="a7a312dd42d161064b70afd7ff24c0651" args="() const " -->
926 </div> 900 <div class="memitem">
927 </div><p> 901 <div class="memproto">
928 <a class="anchor" name="7a312dd42d161064b70afd7ff24c0651"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getCurrentProgram" ref="7a312dd42d161064b70afd7ff24c0651" args="() const " --> 902 <table class="memname">
929 <div class="memitem"> 903 <tr>
930 <div class="memproto"> 904 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td>
931 <table class="memname"> 905 <td>(</td>
932 <tr> 906 <td class="paramname"></td><td>)</td>
933 <td class="memname">std::string Vamp::HostExt::PluginWrapper::getCurrentProgram </td> 907 <td> const<code> [virtual, inherited]</code></td>
934 <td>(</td> 908 </tr>
935 <td class="paramname"> </td> 909 </table>
936 <td>&nbsp;)&nbsp;</td> 910 </div>
937 <td> const<code> [virtual, inherited]</code></td> 911 <div class="memdoc">
938 </tr> 912
939 </table> 913 <p>Get the current program. </p>
940 </div> 914
941 <div class="memdoc"> 915 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p>
942 916
943 <p> 917 </div>
944 Get the current program. 918 </div>
945 <p> 919 <a class="anchor" id="a074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::selectProgram" ref="a074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" -->
946 920 <div class="memitem">
947 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 921 <div class="memproto">
948 922 <table class="memname">
949 </div> 923 <tr>
950 </div><p> 924 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
951 <a class="anchor" name="074978333a74fdcf336a8a1d8ea20abf"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::selectProgram" ref="074978333a74fdcf336a8a1d8ea20abf" args="(std::string)" --> 925 <td>(</td>
952 <div class="memitem"> 926 <td class="paramtype">std::string&#160;</td>
953 <div class="memproto"> 927 <td class="paramname"></td><td>)</td>
954 <table class="memname">
955 <tr>
956 <td class="memname">void Vamp::HostExt::PluginWrapper::selectProgram </td>
957 <td>(</td>
958 <td class="paramtype">std::string&nbsp;</td>
959 <td class="paramname"> </td>
960 <td>&nbsp;)&nbsp;</td>
961 <td><code> [virtual, inherited]</code></td> 928 <td><code> [virtual, inherited]</code></td>
962 </tr> 929 </tr>
963 </table> 930 </table>
964 </div> 931 </div>
965 <div class="memdoc"> 932 <div class="memdoc">
966 933
967 <p> 934 <p>Select a program. </p>
968 Select a program. 935 <p>(If the given program name is not one of the available programs, do nothing.) </p>
969 <p> 936
970 (If the given program name is not one of the available programs, do nothing.) 937 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
971 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#add3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 938
972 939 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
973 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>.</p> 940
974 941 </div>
975 </div> 942 </div>
976 </div><p> 943 <a class="anchor" id="a0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPreferredStepSize" ref="a0137d93d7019bacc31104836fb4d352e" args="() const " -->
977 <a class="anchor" name="0137d93d7019bacc31104836fb4d352e"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPreferredStepSize" ref="0137d93d7019bacc31104836fb4d352e" args="() const " --> 944 <div class="memitem">
978 <div class="memitem"> 945 <div class="memproto">
979 <div class="memproto"> 946 <table class="memname">
980 <table class="memname"> 947 <tr>
981 <tr> 948 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td>
982 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredStepSize </td> 949 <td>(</td>
983 <td>(</td> 950 <td class="paramname"></td><td>)</td>
984 <td class="paramname"> </td> 951 <td> const<code> [virtual, inherited]</code></td>
985 <td>&nbsp;)&nbsp;</td> 952 </tr>
986 <td> const<code> [virtual, inherited]</code></td> 953 </table>
987 </tr> 954 </div>
988 </table> 955 <div class="memdoc">
989 </div> 956
990 <div class="memdoc"> 957 <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>
991 958 <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>
992 <p> 959 <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>
993 Get the preferred step size (window increment -- the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function) for the plugin. 960
994 <p> 961 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p>
995 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 962
996 A plugin may return 0 if it has no particular interest in the step size. In this case, the host should make the step size equal to the block size if the plugin is accepting input in the time domain. If the plugin is accepting input in the frequency domain, the host may use any step size. The final step size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 963 <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>
997 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p> 964
998 965 </div>
999 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#d979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 966 </div>
1000 967 <a class="anchor" id="a2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPreferredBlockSize" ref="a2c62a656313a819650656643a867ad01" args="() const " -->
1001 </div> 968 <div class="memitem">
1002 </div><p> 969 <div class="memproto">
1003 <a class="anchor" name="2c62a656313a819650656643a867ad01"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getPreferredBlockSize" ref="2c62a656313a819650656643a867ad01" args="() const " --> 970 <table class="memname">
1004 <div class="memitem"> 971 <tr>
1005 <div class="memproto"> 972 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td>
1006 <table class="memname"> 973 <td>(</td>
1007 <tr> 974 <td class="paramname"></td><td>)</td>
1008 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getPreferredBlockSize </td> 975 <td> const<code> [virtual, inherited]</code></td>
1009 <td>(</td> 976 </tr>
1010 <td class="paramname"> </td> 977 </table>
1011 <td>&nbsp;)&nbsp;</td> 978 </div>
1012 <td> const<code> [virtual, inherited]</code></td> 979 <div class="memdoc">
1013 </tr> 980
1014 </table> 981 <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>
1015 </div> 982 <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>
1016 <div class="memdoc"> 983 <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>
1017 984
1018 <p> 985 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p>
1019 Get the preferred block size (window size -- the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> function). 986
1020 <p> 987 <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>
1021 This should be called before <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a>.<p> 988
1022 A plugin that can handle any block size may return 0. The final block size will be set in the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5a1f8290d8e9a315695584dcb3ad137" title="Initialise a plugin to prepare it for use with the given number of input channels...">initialise()</a> call. 989 </div>
1023 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> 990 </div>
1024 991 <a class="anchor" id="a2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMinChannelCount" ref="a2b28f1cf37d46a514f1e1411a6037bf8" args="() const " -->
1025 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>.</p> 992 <div class="memitem">
1026 993 <div class="memproto">
1027 </div> 994 <table class="memname">
1028 </div><p> 995 <tr>
1029 <a class="anchor" name="2b28f1cf37d46a514f1e1411a6037bf8"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMinChannelCount" ref="2b28f1cf37d46a514f1e1411a6037bf8" args="() const " --> 996 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td>
1030 <div class="memitem"> 997 <td>(</td>
1031 <div class="memproto"> 998 <td class="paramname"></td><td>)</td>
1032 <table class="memname"> 999 <td> const<code> [virtual, inherited]</code></td>
1033 <tr> 1000 </tr>
1034 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMinChannelCount </td> 1001 </table>
1035 <td>(</td> 1002 </div>
1036 <td class="paramname"> </td> 1003 <div class="memdoc">
1037 <td>&nbsp;)&nbsp;</td> 1004
1038 <td> const<code> [virtual, inherited]</code></td> 1005 <p>Get the minimum supported number of input channels. </p>
1039 </tr> 1006
1040 </table> 1007 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p>
1041 </div> 1008
1042 <div class="memdoc"> 1009 </div>
1043 1010 </div>
1044 <p> 1011 <a class="anchor" id="a985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMaxChannelCount" ref="a985eb21f1827bfbc3950d6871b107a58" args="() const " -->
1045 Get the minimum supported number of input channels. 1012 <div class="memitem">
1046 <p> 1013 <div class="memproto">
1047 1014 <table class="memname">
1048 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1015 <tr>
1049 1016 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td>
1050 </div> 1017 <td>(</td>
1051 </div><p> 1018 <td class="paramname"></td><td>)</td>
1052 <a class="anchor" name="985eb21f1827bfbc3950d6871b107a58"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getMaxChannelCount" ref="985eb21f1827bfbc3950d6871b107a58" args="() const " --> 1019 <td> const<code> [virtual, inherited]</code></td>
1053 <div class="memitem"> 1020 </tr>
1054 <div class="memproto"> 1021 </table>
1055 <table class="memname"> 1022 </div>
1056 <tr> 1023 <div class="memdoc">
1057 <td class="memname">size_t Vamp::HostExt::PluginWrapper::getMaxChannelCount </td> 1024
1058 <td>(</td> 1025 <p>Get the maximum supported number of input channels. </p>
1059 <td class="paramname"> </td> 1026
1060 <td>&nbsp;)&nbsp;</td> 1027 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p>
1061 <td> const<code> [virtual, inherited]</code></td> 1028
1062 </tr> 1029 </div>
1063 </table> 1030 </div>
1064 </div> 1031 <a class="anchor" id="a5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getOutputDescriptors" ref="a5a9411305f713b4c9827844b89acd270" args="() const " -->
1065 <div class="memdoc"> 1032 <div class="memitem">
1066 1033 <div class="memproto">
1067 <p> 1034 <table class="memname">
1068 Get the maximum supported number of input channels. 1035 <tr>
1069 <p> 1036 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td>
1070 1037 <td>(</td>
1071 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1038 <td class="paramname"></td><td>)</td>
1072 1039 <td> const<code> [virtual, inherited]</code></td>
1073 </div> 1040 </tr>
1074 </div><p> 1041 </table>
1075 <a class="anchor" name="5a9411305f713b4c9827844b89acd270"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getOutputDescriptors" ref="5a9411305f713b4c9827844b89acd270" args="() const " --> 1042 </div>
1076 <div class="memitem"> 1043 <div class="memdoc">
1077 <div class="memproto"> 1044
1078 <table class="memname"> 1045 <p>Get the outputs of this plugin. </p>
1079 <tr> 1046 <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>
1080 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::HostExt::PluginWrapper::getOutputDescriptors </td> 1047
1081 <td>(</td> 1048 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
1082 <td class="paramname"> </td> 1049
1083 <td>&nbsp;)&nbsp;</td> 1050 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#af8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
1084 <td> const<code> [virtual, inherited]</code></td> 1051
1085 </tr> 1052 </div>
1086 </table> 1053 </div>
1087 </div> 1054 <a class="anchor" id="a653d0308e8e34881a8749b7631d00f05"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getWrapper" ref="a653d0308e8e34881a8749b7631d00f05" args="()" -->
1088 <div class="memdoc">
1089
1090 <p>
1091 Get the outputs of this plugin.
1092 <p>
1093 An output's index in this list is used as its numeric index when looking it up in the FeatureSet returned from the <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#6bd72d6dfb3047524dbe8ae3294527cf" title="Process a single block of input data.">process()</a> call.
1094 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#d064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
1095
1096 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#f8cc914897a284433de220f1153f3845">Vamp::HostExt::PluginBufferingAdapter</a>.</p>
1097
1098 </div>
1099 </div><p>
1100 <a class="anchor" name="e9d79bed7237d55a73018a6b982a55b3"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getWrapper" ref="e9d79bed7237d55a73018a6b982a55b3" args="()" -->
1101 <div class="memitem"> 1055 <div class="memitem">
1102 <div class="memproto"> 1056 <div class="memproto">
1103 <div class="memtemplate"> 1057 <div class="memtemplate">
1104 template&lt;typename WrapperType &gt; </div> 1058 template&lt;typename WrapperType &gt; </div>
1105 <table class="memname"> 1059 <table class="memname">
1106 <tr> 1060 <tr>
1107 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td> 1061 <td class="memname">WrapperType* Vamp::HostExt::PluginWrapper::getWrapper </td>
1108 <td>(</td> 1062 <td>(</td>
1109 <td class="paramname"> </td> 1063 <td class="paramname"></td><td>)</td>
1110 <td>&nbsp;)&nbsp;</td>
1111 <td><code> [inline, inherited]</code></td> 1064 <td><code> [inline, inherited]</code></td>
1112 </tr> 1065 </tr>
1113 </table> 1066 </table>
1114 </div> 1067 </div>
1115 <div class="memdoc"> 1068 <div class="memdoc">
1116 1069
1117 <p> 1070 <p>Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. </p>
1118 Return a pointer to the plugin wrapper of type WrapperType surrounding this wrapper's plugin, if present. 1071 <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>
1119 <p> 1072
1120 This is useful in situations where a plugin is wrapped by multiple different wrappers (one inside another) and the host wants to call some wrapper-specific function on one of the layers without having to care about the order in which they are wrapped. For example, the plugin returned by <a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html#964689eb9688cd7e58e8c82ebb0d305f" title="Load a Vamp plugin, given its identifying key.">PluginLoader::loadPlugin</a> may have more than one wrapper; if the host wanted to query or fine-tune some property of one of them, it would be hard to do so without knowing the order of the wrappers. This function therefore gives direct access to the wrapper of a particular type. 1073 <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>
1121 <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> 1074
1122 1075 <p>References <a class="el" href="PluginWrapper_8h_source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p>
1123 <p>References <a class="el" href="PluginWrapper_8h-source.html#l00116">Vamp::HostExt::PluginWrapper::getWrapper()</a>.</p> 1076
1124 1077 <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>
1125 <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> 1078
1126 1079 </div>
1127 </div> 1080 </div>
1128 </div><p> 1081 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getType" ref="abe13b3997a69fbcc09e2213faa352f91" args="() const " -->
1129 <a class="anchor" name="be13b3997a69fbcc09e2213faa352f91"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::getType" ref="be13b3997a69fbcc09e2213faa352f91" args="() const " --> 1082 <div class="memitem">
1130 <div class="memitem"> 1083 <div class="memproto">
1131 <div class="memproto"> 1084 <table class="memname">
1132 <table class="memname"> 1085 <tr>
1133 <tr> 1086 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1134 <td class="memname">virtual std::string Vamp::Plugin::getType </td> 1087 <td>(</td>
1135 <td>(</td> 1088 <td class="paramname"></td><td>)</td>
1136 <td class="paramname"> </td>
1137 <td>&nbsp;)&nbsp;</td>
1138 <td> const<code> [inline, virtual, inherited]</code></td> 1089 <td> const<code> [inline, virtual, inherited]</code></td>
1139 </tr> 1090 </tr>
1140 </table> 1091 </table>
1141 </div> 1092 </div>
1142 <div class="memdoc"> 1093 <div class="memdoc">
1143 1094
1144 <p> 1095 <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>
1145 Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. 1096 <p>Do not reimplement this function in your subclass. </p>
1146 <p> 1097
1147 Do not reimplement this function in your subclass. 1098 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
1148 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1099
1149 1100 <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>
1150 <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> 1101
1151 1102 </div>
1152 </div> 1103 </div>
1153 </div><p> 1104 <hr/><h2>Member Data Documentation</h2>
1154 <hr><h2>Member Data Documentation</h2> 1105 <a class="anchor" id="af131140817d9f131650af98b6b8d7a94"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_impl" ref="af131140817d9f131650af98b6b8d7a94" args="" -->
1155 <a class="anchor" name="f131140817d9f131650af98b6b8d7a94"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_impl" ref="f131140817d9f131650af98b6b8d7a94" args="" --> 1106 <div class="memitem">
1156 <div class="memitem"> 1107 <div class="memproto">
1157 <div class="memproto"> 1108 <table class="memname">
1158 <table class="memname"> 1109 <tr>
1159 <tr> 1110 <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>
1160 <td class="memname">Impl* <a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html#f131140817d9f131650af98b6b8d7a94">Vamp::HostExt::PluginSummarisingAdapter::m_impl</a><code> [protected]</code> </td> 1111 </tr>
1161 </tr> 1112 </table>
1162 </table> 1113 </div>
1163 </div> 1114 <div class="memdoc">
1164 <div class="memdoc"> 1115
1165 1116 <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>
1166 <p> 1117
1167 1118 </div>
1168 <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> 1119 </div>
1169 1120 <a class="anchor" id="ab4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_plugin" ref="ab4e40ecd98b445e1a2aa9e7baa280ea2" args="" -->
1170 </div> 1121 <div class="memitem">
1171 </div><p> 1122 <div class="memproto">
1172 <a class="anchor" name="b4e40ecd98b445e1a2aa9e7baa280ea2"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_plugin" ref="b4e40ecd98b445e1a2aa9e7baa280ea2" args="" --> 1123 <table class="memname">
1173 <div class="memitem"> 1124 <tr>
1174 <div class="memproto"> 1125 <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>
1175 <table class="memname"> 1126 </tr>
1176 <tr> 1127 </table>
1177 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#b4e40ecd98b445e1a2aa9e7baa280ea2">Vamp::HostExt::PluginWrapper::m_plugin</a><code> [protected, inherited]</code> </td> 1128 </div>
1178 </tr> 1129 <div class="memdoc">
1179 </table> 1130
1180 </div> 1131 <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>
1181 <div class="memdoc"> 1132
1182 1133 </div>
1183 <p> 1134 </div>
1184 1135 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_inputSampleRate" ref="a59b9dd82a4f4eb946cd0474cc81abc23" args="" -->
1185 <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> 1136 <div class="memitem">
1186 1137 <div class="memproto">
1187 </div> 1138 <table class="memname">
1188 </div><p> 1139 <tr>
1189 <a class="anchor" name="59b9dd82a4f4eb946cd0474cc81abc23"></a><!-- doxytag: member="Vamp::HostExt::PluginSummarisingAdapter::m_inputSampleRate" ref="59b9dd82a4f4eb946cd0474cc81abc23" args="" --> 1140 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td>
1190 <div class="memitem"> 1141 </tr>
1191 <div class="memproto"> 1142 </table>
1192 <table class="memname"> 1143 </div>
1193 <tr> 1144 <div class="memdoc">
1194 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code> </td> 1145
1195 </tr> 1146 <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>
1196 </table> 1147
1197 </div> 1148 <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>
1198 <div class="memdoc"> 1149
1199 1150 </div>
1200 <p> 1151 </div>
1201 1152 <hr/>The documentation for this class was generated from the following file:<ul>
1202 <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> 1153 <li><a class="el" href="PluginSummarisingAdapter_8h_source.html">PluginSummarisingAdapter.h</a></li>
1203 1154 </ul>
1204 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp-source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">SpectralCentroid::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> 1155 </div>
1205 1156 </div>
1206 </div> 1157 <div id="nav-path" class="navpath">
1207 </div><p> 1158 <ul>
1208 <hr>The documentation for this class was generated from the following file:<ul> 1159 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
1209 <li><a class="el" href="PluginSummarisingAdapter_8h-source.html">PluginSummarisingAdapter.h</a></ul> 1160 <li class="navelem"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a> </li>
1210 </div> 1161 <li class="navelem"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html">PluginSummarisingAdapter</a> </li>
1211 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp; 1162
1212 <a href="http://www.doxygen.org/index.html"> 1163 <li class="footer">Generated on Tue Oct 4 2011 14:38:53 for VampPluginSDK by
1213 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 1164 <a href="http://www.doxygen.org/index.html">
1165 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
1166 </ul>
1167 </div>
1168
1169
1214 </body> 1170 </body>
1215 </html> 1171 </html>