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

Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: Vamp::PluginHostAdapter Class Reference</title> 8 <title>VampPluginSDK: Vamp::PluginHostAdapter Class Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34 31 </td>
35 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
57 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
58 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
59 </ul>
60 </div>
61 </div>
62 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
63 <div id="nav-tree"> 48 <div id="nav-tree">
64 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
65 </div> 51 </div>
66 </div> 52 </div>
67 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
69 </div> 55 </div>
70 </div> 56 </div>
71 <script type="text/javascript"> 57 <script type="text/javascript">
72 initNavTree('classVamp_1_1PluginHostAdapter.html',''); 58 $(document).ready(function(){initNavTree('classVamp_1_1PluginHostAdapter.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-types">Public Types</a> &#124; 63 <a href="#pub-types">Public Types</a> &#124;
78 <a href="#pub-methods">Public Member Functions</a> &#124; 64 <a href="#pub-methods">Public Member Functions</a> &#124;
79 <a href="#pub-static-methods">Static Public Member Functions</a> &#124; 65 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
80 <a href="#pro-methods">Protected Member Functions</a> &#124; 66 <a href="#pro-methods">Protected Member Functions</a> &#124;
81 <a href="#pro-attribs">Protected Attributes</a> </div> 67 <a href="#pro-attribs">Protected Attributes</a> &#124;
68 <a href="classVamp_1_1PluginHostAdapter-members.html">List of all members</a> </div>
82 <div class="headertitle"> 69 <div class="headertitle">
83 <div class="title">Vamp::PluginHostAdapter Class Reference</div> </div> 70 <div class="title">Vamp::PluginHostAdapter Class Reference</div> </div>
84 </div><!--header--> 71 </div><!--header-->
85 <div class="contents"> 72 <div class="contents">
86 73
91 <div class="dynheader"> 78 <div class="dynheader">
92 Inheritance diagram for Vamp::PluginHostAdapter:</div> 79 Inheritance diagram for Vamp::PluginHostAdapter:</div>
93 <div class="dyncontent"> 80 <div class="dyncontent">
94 <div class="center"><img src="classVamp_1_1PluginHostAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginHostAdapter_inherit__map" alt="Inheritance graph"/></div> 81 <div class="center"><img src="classVamp_1_1PluginHostAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginHostAdapter_inherit__map" alt="Inheritance graph"/></div>
95 <map name="Vamp_1_1PluginHostAdapter_inherit__map" id="Vamp_1_1PluginHostAdapter_inherit__map"> 82 <map name="Vamp_1_1PluginHostAdapter_inherit__map" id="Vamp_1_1PluginHostAdapter_inherit__map">
96 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="38,81,129,106"/><area shape="rect" id="node4" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="25,6,143,31"/></map> 83 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="39,79,134,104"/>
84 <area shape="rect" id="node3" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="25,5,148,31"/>
85 </map>
97 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> 86 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
98
99 <p><a href="classVamp_1_1PluginHostAdapter-members.html">List of all members.</a></p>
100 <table class="memberdecls"> 87 <table class="memberdecls">
101 <tr><td colspan="2"><h2><a name="pub-types"></a> 88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
102 Public Types</h2></td></tr> 89 Public Types</h2></td></tr>
103 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, 90 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
104 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 91 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
105 }</td></tr> 92 }</td></tr>
106 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 93 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr> 94 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr>
95 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> 96 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
109 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/> 97 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 <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> 98 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
111 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 99 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
112 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> 100 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
101 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> 102 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
114 <tr><td colspan="2"><h2><a name="pub-methods"></a> 103 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 </table><table class="memberdecls">
105 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
115 Public Member Functions</h2></td></tr> 106 Public Member Functions</h2></td></tr>
116 <tr class="memitem:a6535abd551acfbbaab381bbe1268cd49"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a> (const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *descriptor, float inputSampleRate)</td></tr> 107 <tr class="memitem:a6535abd551acfbbaab381bbe1268cd49"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6535abd551acfbbaab381bbe1268cd49">PluginHostAdapter</a> (const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *descriptor, float inputSampleRate)</td></tr>
108 <tr class="separator:a6535abd551acfbbaab381bbe1268cd49"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <tr class="memitem:aed66c091340aa668d3be89c4b4c24474"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aed66c091340aa668d3be89c4b4c24474">~PluginHostAdapter</a> ()</td></tr> 109 <tr class="memitem:aed66c091340aa668d3be89c4b4c24474"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aed66c091340aa668d3be89c4b4c24474">~PluginHostAdapter</a> ()</td></tr>
110 <tr class="separator:aed66c091340aa668d3be89c4b4c24474"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memitem:add6a2f1ee7e47bd97fa599cead14b738"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 111 <tr class="memitem:add6a2f1ee7e47bd97fa599cead14b738"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
119 <tr class="memdesc:add6a2f1ee7e47bd97fa599cead14b738"><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="#add6a2f1ee7e47bd97fa599cead14b738"></a><br/></td></tr> 112 <tr class="memdesc:add6a2f1ee7e47bd97fa599cead14b738"><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="#add6a2f1ee7e47bd97fa599cead14b738">More...</a><br /></td></tr>
113 <tr class="separator:add6a2f1ee7e47bd97fa599cead14b738"><td class="memSeparator" colspan="2">&#160;</td></tr>
120 <tr class="memitem:a5d54c5bbd76bc27b7a243827148afeaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5d54c5bbd76bc27b7a243827148afeaa">reset</a> ()</td></tr> 114 <tr class="memitem:a5d54c5bbd76bc27b7a243827148afeaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5d54c5bbd76bc27b7a243827148afeaa">reset</a> ()</td></tr>
121 <tr class="memdesc:a5d54c5bbd76bc27b7a243827148afeaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a5d54c5bbd76bc27b7a243827148afeaa"></a><br/></td></tr> 115 <tr class="memdesc:a5d54c5bbd76bc27b7a243827148afeaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a5d54c5bbd76bc27b7a243827148afeaa">More...</a><br /></td></tr>
122 <tr class="memitem:a8e9d25673367c741631a60cbb36e91d2"><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_1PluginHostAdapter.html#a8e9d25673367c741631a60cbb36e91d2">getInputDomain</a> () const </td></tr> 116 <tr class="separator:a5d54c5bbd76bc27b7a243827148afeaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="memdesc:a8e9d25673367c741631a60cbb36e91d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a8e9d25673367c741631a60cbb36e91d2"></a><br/></td></tr> 117 <tr class="memitem:ae1364251d4110ad9538523b3373f8d5e"><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_1PluginHostAdapter.html#ae1364251d4110ad9538523b3373f8d5e">getInputDomain</a> () const</td></tr>
124 <tr class="memitem:a98aadddc8403eb46c9d8c5a9d1fdd19e"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">getVampApiVersion</a> () const </td></tr> 118 <tr class="memdesc:ae1364251d4110ad9538523b3373f8d5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#ae1364251d4110ad9538523b3373f8d5e">More...</a><br /></td></tr>
125 <tr class="memdesc:a98aadddc8403eb46c9d8c5a9d1fdd19e"><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="#a98aadddc8403eb46c9d8c5a9d1fdd19e"></a><br/></td></tr> 119 <tr class="separator:ae1364251d4110ad9538523b3373f8d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <tr class="memitem:ab27423a656f878d97d2ad2eba4e76c7a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ab27423a656f878d97d2ad2eba4e76c7a">getIdentifier</a> () const </td></tr> 120 <tr class="memitem:adc708325d057516bd92d5ea1c0808dbc"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#adc708325d057516bd92d5ea1c0808dbc">getVampApiVersion</a> () const</td></tr>
127 <tr class="memdesc:ab27423a656f878d97d2ad2eba4e76c7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ab27423a656f878d97d2ad2eba4e76c7a"></a><br/></td></tr> 121 <tr class="memdesc:adc708325d057516bd92d5ea1c0808dbc"><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="#adc708325d057516bd92d5ea1c0808dbc">More...</a><br /></td></tr>
128 <tr class="memitem:a45f1d0377e233eeddd1b7cefb48be62a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a45f1d0377e233eeddd1b7cefb48be62a">getName</a> () const </td></tr> 122 <tr class="separator:adc708325d057516bd92d5ea1c0808dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memdesc:a45f1d0377e233eeddd1b7cefb48be62a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a45f1d0377e233eeddd1b7cefb48be62a"></a><br/></td></tr> 123 <tr class="memitem:a68749b61d8a4e322d7ce6662347817ca"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a68749b61d8a4e322d7ce6662347817ca">getIdentifier</a> () const</td></tr>
130 <tr class="memitem:a5eaafcef030e81b90a3e77cf16cf8ae1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5eaafcef030e81b90a3e77cf16cf8ae1">getDescription</a> () const </td></tr> 124 <tr class="memdesc:a68749b61d8a4e322d7ce6662347817ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a68749b61d8a4e322d7ce6662347817ca">More...</a><br /></td></tr>
131 <tr class="memdesc:a5eaafcef030e81b90a3e77cf16cf8ae1"><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="#a5eaafcef030e81b90a3e77cf16cf8ae1"></a><br/></td></tr> 125 <tr class="separator:a68749b61d8a4e322d7ce6662347817ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:af572be0b175f5661559006a380a0f3db"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#af572be0b175f5661559006a380a0f3db">getMaker</a> () const </td></tr> 126 <tr class="memitem:a6276b0838a3a9ac155d295cae0e7bb67"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6276b0838a3a9ac155d295cae0e7bb67">getName</a> () const</td></tr>
133 <tr class="memdesc:af572be0b175f5661559006a380a0f3db"><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="#af572be0b175f5661559006a380a0f3db"></a><br/></td></tr> 127 <tr class="memdesc:a6276b0838a3a9ac155d295cae0e7bb67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a6276b0838a3a9ac155d295cae0e7bb67">More...</a><br /></td></tr>
134 <tr class="memitem:a6fbd94781867ca46a20368c2a3593c77"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6fbd94781867ca46a20368c2a3593c77">getPluginVersion</a> () const </td></tr> 128 <tr class="separator:a6276b0838a3a9ac155d295cae0e7bb67"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memdesc:a6fbd94781867ca46a20368c2a3593c77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a6fbd94781867ca46a20368c2a3593c77"></a><br/></td></tr> 129 <tr class="memitem:aae795d71594901243de8cda96d871fc8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aae795d71594901243de8cda96d871fc8">getDescription</a> () const</td></tr>
136 <tr class="memitem:ac73c9d6baad04369beee695e99584815"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ac73c9d6baad04369beee695e99584815">getCopyright</a> () const </td></tr> 130 <tr class="memdesc:aae795d71594901243de8cda96d871fc8"><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="#aae795d71594901243de8cda96d871fc8">More...</a><br /></td></tr>
137 <tr class="memdesc:ac73c9d6baad04369beee695e99584815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ac73c9d6baad04369beee695e99584815"></a><br/></td></tr> 131 <tr class="separator:aae795d71594901243de8cda96d871fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a602faa0bfaae83e2ca53b36292271a76"><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_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">getParameterDescriptors</a> () const </td></tr> 132 <tr class="memitem:ac906c3a0eef77f545fb4dad2456ee2b4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ac906c3a0eef77f545fb4dad2456ee2b4">getMaker</a> () const</td></tr>
139 <tr class="memdesc:a602faa0bfaae83e2ca53b36292271a76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a602faa0bfaae83e2ca53b36292271a76"></a><br/></td></tr> 133 <tr class="memdesc:ac906c3a0eef77f545fb4dad2456ee2b4"><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="#ac906c3a0eef77f545fb4dad2456ee2b4">More...</a><br /></td></tr>
140 <tr class="memitem:af0c46d4f67ca93be7c76f3ea2e6c8efb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">getParameter</a> (std::string) const </td></tr> 134 <tr class="separator:ac906c3a0eef77f545fb4dad2456ee2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memdesc:af0c46d4f67ca93be7c76f3ea2e6c8efb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#af0c46d4f67ca93be7c76f3ea2e6c8efb"></a><br/></td></tr> 135 <tr class="memitem:a5e774f5b0e86293714c0506676d4fa62"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a5e774f5b0e86293714c0506676d4fa62">getPluginVersion</a> () const</td></tr>
136 <tr class="memdesc:a5e774f5b0e86293714c0506676d4fa62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a5e774f5b0e86293714c0506676d4fa62">More...</a><br /></td></tr>
137 <tr class="separator:a5e774f5b0e86293714c0506676d4fa62"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a6f68665c4c00bb55e4736a091a68d9a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6f68665c4c00bb55e4736a091a68d9a9">getCopyright</a> () const</td></tr>
139 <tr class="memdesc:a6f68665c4c00bb55e4736a091a68d9a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a6f68665c4c00bb55e4736a091a68d9a9">More...</a><br /></td></tr>
140 <tr class="separator:a6f68665c4c00bb55e4736a091a68d9a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a8f2b1c45be01169414bc86b685f4508e"><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_1PluginHostAdapter.html#a8f2b1c45be01169414bc86b685f4508e">getParameterDescriptors</a> () const</td></tr>
142 <tr class="memdesc:a8f2b1c45be01169414bc86b685f4508e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a8f2b1c45be01169414bc86b685f4508e">More...</a><br /></td></tr>
143 <tr class="separator:a8f2b1c45be01169414bc86b685f4508e"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a97149b60fb9d7c4359262ba8f6ff9743"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a97149b60fb9d7c4359262ba8f6ff9743">getParameter</a> (std::string) const</td></tr>
145 <tr class="memdesc:a97149b60fb9d7c4359262ba8f6ff9743"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97149b60fb9d7c4359262ba8f6ff9743">More...</a><br /></td></tr>
146 <tr class="separator:a97149b60fb9d7c4359262ba8f6ff9743"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a29f75395aa75b9de0228aa11edf9c6d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">setParameter</a> (std::string, float)</td></tr> 147 <tr class="memitem:a29f75395aa75b9de0228aa11edf9c6d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">setParameter</a> (std::string, float)</td></tr>
143 <tr class="memdesc:a29f75395aa75b9de0228aa11edf9c6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a29f75395aa75b9de0228aa11edf9c6d6"></a><br/></td></tr> 148 <tr class="memdesc:a29f75395aa75b9de0228aa11edf9c6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a29f75395aa75b9de0228aa11edf9c6d6">More...</a><br /></td></tr>
144 <tr class="memitem:ae0cde5cd625418c1bc470b91f75daafc"><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_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">getPrograms</a> () const </td></tr> 149 <tr class="separator:a29f75395aa75b9de0228aa11edf9c6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memdesc:ae0cde5cd625418c1bc470b91f75daafc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#ae0cde5cd625418c1bc470b91f75daafc"></a><br/></td></tr> 150 <tr class="memitem:a1e3c40e9b9d8dc876d2e732976950c4b"><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_1PluginHostAdapter.html#a1e3c40e9b9d8dc876d2e732976950c4b">getPrograms</a> () const</td></tr>
146 <tr class="memitem:a34859eff8ca8d862af39be9636ec1867"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">getCurrentProgram</a> () const </td></tr> 151 <tr class="memdesc:a1e3c40e9b9d8dc876d2e732976950c4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#a1e3c40e9b9d8dc876d2e732976950c4b">More...</a><br /></td></tr>
147 <tr class="memdesc:a34859eff8ca8d862af39be9636ec1867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a34859eff8ca8d862af39be9636ec1867"></a><br/></td></tr> 152 <tr class="separator:a1e3c40e9b9d8dc876d2e732976950c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:abf984c347c4dac9e4b01123498bfe68f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#abf984c347c4dac9e4b01123498bfe68f">getCurrentProgram</a> () const</td></tr>
154 <tr class="memdesc:abf984c347c4dac9e4b01123498bfe68f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#abf984c347c4dac9e4b01123498bfe68f">More...</a><br /></td></tr>
155 <tr class="separator:abf984c347c4dac9e4b01123498bfe68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a8f5515ab34cc13d9403ccc6b4b788683"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">selectProgram</a> (std::string)</td></tr> 156 <tr class="memitem:a8f5515ab34cc13d9403ccc6b4b788683"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">selectProgram</a> (std::string)</td></tr>
149 <tr class="memdesc:a8f5515ab34cc13d9403ccc6b4b788683"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a8f5515ab34cc13d9403ccc6b4b788683"></a><br/></td></tr> 157 <tr class="memdesc:a8f5515ab34cc13d9403ccc6b4b788683"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#a8f5515ab34cc13d9403ccc6b4b788683">More...</a><br /></td></tr>
150 <tr class="memitem:a859ad5d59402691daed3cf1af1899ebe"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">getPreferredStepSize</a> () const </td></tr> 158 <tr class="separator:a8f5515ab34cc13d9403ccc6b4b788683"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memdesc:a859ad5d59402691daed3cf1af1899ebe"><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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a859ad5d59402691daed3cf1af1899ebe"></a><br/></td></tr> 159 <tr class="memitem:a344c85cc017c97bf4f0f144e7d6e0f42"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a344c85cc017c97bf4f0f144e7d6e0f42">getPreferredStepSize</a> () const</td></tr>
152 <tr class="memitem:ad5e0ea8042bdec4dd18428991117e07a"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">getPreferredBlockSize</a> () const </td></tr> 160 <tr class="memdesc:a344c85cc017c97bf4f0f144e7d6e0f42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a> function) for the plugin. <a href="#a344c85cc017c97bf4f0f144e7d6e0f42">More...</a><br /></td></tr>
153 <tr class="memdesc:ad5e0ea8042bdec4dd18428991117e07a"><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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function). <a href="#ad5e0ea8042bdec4dd18428991117e07a"></a><br/></td></tr> 161 <tr class="separator:a344c85cc017c97bf4f0f144e7d6e0f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:a67d1198c0e58d3f0076d0eda599ff28d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">getMinChannelCount</a> () const </td></tr> 162 <tr class="memitem:a9ee8ecc8406f633c68e9aa1516700332"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a9ee8ecc8406f633c68e9aa1516700332">getPreferredBlockSize</a> () const</td></tr>
155 <tr class="memdesc:a67d1198c0e58d3f0076d0eda599ff28d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a67d1198c0e58d3f0076d0eda599ff28d"></a><br/></td></tr> 163 <tr class="memdesc:a9ee8ecc8406f633c68e9aa1516700332"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a> function). <a href="#a9ee8ecc8406f633c68e9aa1516700332">More...</a><br /></td></tr>
156 <tr class="memitem:a25091905e97e39d515d8ffc1a9f2b9e0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">getMaxChannelCount</a> () const </td></tr> 164 <tr class="separator:a9ee8ecc8406f633c68e9aa1516700332"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memdesc:a25091905e97e39d515d8ffc1a9f2b9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a25091905e97e39d515d8ffc1a9f2b9e0"></a><br/></td></tr> 165 <tr class="memitem:a8e7f62e03adea0321080839f6ef6c77b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e7f62e03adea0321080839f6ef6c77b">getMinChannelCount</a> () const</td></tr>
158 <tr class="memitem:a9649a113da0252fe8bd9fc731b047ae0"><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_1PluginHostAdapter.html#a9649a113da0252fe8bd9fc731b047ae0">getOutputDescriptors</a> () const </td></tr> 166 <tr class="memdesc:a8e7f62e03adea0321080839f6ef6c77b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a8e7f62e03adea0321080839f6ef6c77b">More...</a><br /></td></tr>
159 <tr class="memdesc:a9649a113da0252fe8bd9fc731b047ae0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a9649a113da0252fe8bd9fc731b047ae0"></a><br/></td></tr> 167 <tr class="separator:a8e7f62e03adea0321080839f6ef6c77b"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:a626ad6e35eb0f4ed93bc3c6d976cdca4"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a626ad6e35eb0f4ed93bc3c6d976cdca4">getMaxChannelCount</a> () const</td></tr>
169 <tr class="memdesc:a626ad6e35eb0f4ed93bc3c6d976cdca4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a626ad6e35eb0f4ed93bc3c6d976cdca4">More...</a><br /></td></tr>
170 <tr class="separator:a626ad6e35eb0f4ed93bc3c6d976cdca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:ad799e6317c4caf1a1c55b172ed6cc1fc"><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_1PluginHostAdapter.html#ad799e6317c4caf1a1c55b172ed6cc1fc">getOutputDescriptors</a> () const</td></tr>
172 <tr class="memdesc:ad799e6317c4caf1a1c55b172ed6cc1fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ad799e6317c4caf1a1c55b172ed6cc1fc">More...</a><br /></td></tr>
173 <tr class="separator:ad799e6317c4caf1a1c55b172ed6cc1fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memitem:a38fe1080b343ba10e5d8a4b30c87cbdd"><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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr> 174 <tr class="memitem:a38fe1080b343ba10e5d8a4b30c87cbdd"><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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> timestamp)</td></tr>
161 <tr class="memdesc:a38fe1080b343ba10e5d8a4b30c87cbdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a38fe1080b343ba10e5d8a4b30c87cbdd"></a><br/></td></tr> 175 <tr class="memdesc:a38fe1080b343ba10e5d8a4b30c87cbdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a38fe1080b343ba10e5d8a4b30c87cbdd">More...</a><br /></td></tr>
176 <tr class="separator:a38fe1080b343ba10e5d8a4b30c87cbdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a984a4c11f3fbdcfd90e4837b1619a5ab"><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_1PluginHostAdapter.html#a984a4c11f3fbdcfd90e4837b1619a5ab">getRemainingFeatures</a> ()</td></tr> 177 <tr class="memitem:a984a4c11f3fbdcfd90e4837b1619a5ab"><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_1PluginHostAdapter.html#a984a4c11f3fbdcfd90e4837b1619a5ab">getRemainingFeatures</a> ()</td></tr>
163 <tr class="memdesc:a984a4c11f3fbdcfd90e4837b1619a5ab"><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="#a984a4c11f3fbdcfd90e4837b1619a5ab"></a><br/></td></tr> 178 <tr class="memdesc:a984a4c11f3fbdcfd90e4837b1619a5ab"><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="#a984a4c11f3fbdcfd90e4837b1619a5ab">More...</a><br /></td></tr>
164 <tr class="memitem:abe13b3997a69fbcc09e2213faa352f91"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a> () const </td></tr> 179 <tr class="separator:a984a4c11f3fbdcfd90e4837b1619a5ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memdesc:abe13b3997a69fbcc09e2213faa352f91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc.">PluginBase</a>. <a href="#abe13b3997a69fbcc09e2213faa352f91"></a><br/></td></tr> 180 <tr class="memitem:a530123068767a8728c568ffccfe3e4e5"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">getType</a> () const</td></tr>
166 <tr><td colspan="2"><h2><a name="pub-static-methods"></a> 181 <tr class="memdesc:a530123068767a8728c568ffccfe3e4e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to distinguish between <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> and other potential sibling subclasses of <a class="el" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. ">PluginBase</a>. <a href="#a530123068767a8728c568ffccfe3e4e5">More...</a><br /></td></tr>
182 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 </table><table class="memberdecls">
184 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
167 Static Public Member Functions</h2></td></tr> 185 Static Public Member Functions</h2></td></tr>
168 <tr class="memitem:a09cbfb7903d28f10d6d556c6cb81c5f6"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a09cbfb7903d28f10d6d556c6cb81c5f6">getPluginPath</a> ()</td></tr> 186 <tr class="memitem:a09cbfb7903d28f10d6d556c6cb81c5f6"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a09cbfb7903d28f10d6d556c6cb81c5f6">getPluginPath</a> ()</td></tr>
169 <tr><td colspan="2"><h2><a name="pro-methods"></a> 187 <tr class="separator:a09cbfb7903d28f10d6d556c6cb81c5f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
188 </table><table class="memberdecls">
189 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
170 Protected Member Functions</h2></td></tr> 190 Protected Member Functions</h2></td></tr>
171 <tr class="memitem:aee417a4c9ba9dbb63777c963d5f9452a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a> (<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *, <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;)</td></tr> 191 <tr class="memitem:aee417a4c9ba9dbb63777c963d5f9452a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#aee417a4c9ba9dbb63777c963d5f9452a">convertFeatures</a> (<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *, <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> &amp;)</td></tr>
172 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 192 <tr class="separator:aee417a4c9ba9dbb63777c963d5f9452a"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 </table><table class="memberdecls">
194 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
173 Protected Attributes</h2></td></tr> 195 Protected Attributes</h2></td></tr>
174 <tr class="memitem:a0c9f252aca8ac298e30cadd0de032ec2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a></td></tr> 196 <tr class="memitem:a0c9f252aca8ac298e30cadd0de032ec2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2">m_descriptor</a></td></tr>
197 <tr class="separator:a0c9f252aca8ac298e30cadd0de032ec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:a02ebd03b226b4a467cad747ce77e79ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee">m_handle</a></td></tr> 198 <tr class="memitem:a02ebd03b226b4a467cad747ce77e79ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee">m_handle</a></td></tr>
199 <tr class="separator:a02ebd03b226b4a467cad747ce77e79ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr> 200 <tr class="memitem:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td></tr>
177 </table> 201 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 202 </table>
203 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
179 <div class="textblock"><p><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <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> object. </p> 204 <div class="textblock"><p><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <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> object. </p>
180 <p>The <a class="el" href="namespaceVamp.html">Vamp</a> API is defined in <a class="el" href="vamp_8h.html">vamp/vamp.h</a> as a C API. The C++ objects used for convenience by plugins and hosts actually communicate using the C low-level API, but the details of this communication are handled seamlessly by the <a class="el" href="namespaceVamp.html">Vamp</a> SDK implementation provided the plugin and host use the proper C++ wrapper objects.</p> 205 <p>The <a class="el" href="namespaceVamp.html">Vamp</a> API is defined in <a class="el" href="vamp_8h.html">vamp/vamp.h</a> as a C API. The C++ objects used for convenience by plugins and hosts actually communicate using the C low-level API, but the details of this communication are handled seamlessly by the <a class="el" href="namespaceVamp.html">Vamp</a> SDK implementation provided the plugin and host use the proper C++ wrapper objects.</p>
181 <p>See also <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a>, the plugin-side wrapper that makes a C++ plugin object available using the C query API. </p> 206 <p>See also <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a>, the plugin-side wrapper that makes a C++ plugin object available using the C query API. </p>
182 207
183 <p>Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00068">68</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p> 208 <p class="definition">Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00068">68</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p>
184 </div><hr/><h2>Member Typedef Documentation</h2> 209 </div><h2 class="groupheader">Member Typedef Documentation</h2>
185 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 210 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
186 <div class="memitem"> 211 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
187 <div class="memproto"> 212
188 <table class="memname"> 213 <div class="memitem">
189 <tr> 214 <div class="memproto">
190 <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> 215 <table class="mlabels">
191 </tr> 216 <tr>
192 </table> 217 <td class="mlabels-left">
193 </div> 218 <table class="memname">
194 <div class="memdoc"> 219 <tr>
195 220 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">Vamp::Plugin::OutputList</a></td>
196 <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> 221 </tr>
197 222 </table>
198 </div> 223 </td>
199 </div> 224 <td class="mlabels-right">
200 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 225 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
201 <div class="memitem"> 226 </tr>
202 <div class="memproto"> 227 </table>
203 <table class="memname"> 228 </div><div class="memdoc">
204 <tr> 229
205 <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> 230 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00335">335</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
206 </tr> 231
207 </table> 232 </div>
208 </div> 233 </div>
209 <div class="memdoc"> 234 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
210 235 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
211 <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> 236
212 237 <div class="memitem">
213 </div> 238 <div class="memproto">
214 </div> 239 <table class="mlabels">
215 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 240 <tr>
216 <div class="memitem"> 241 <td class="mlabels-left">
217 <div class="memproto"> 242 <table class="memname">
218 <table class="memname"> 243 <tr>
219 <tr> 244 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">Vamp::Plugin::FeatureList</a></td>
220 <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> 245 </tr>
221 </tr> 246 </table>
222 </table> 247 </td>
223 </div> 248 <td class="mlabels-right">
224 <div class="memdoc"> 249 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
225 250 </tr>
226 <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> 251 </table>
227 252 </div><div class="memdoc">
228 </div> 253
229 </div> 254 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00393">393</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
230 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 255
231 <div class="memitem"> 256 </div>
232 <div class="memproto"> 257 </div>
233 <table class="memname"> 258 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
234 <tr> 259 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
235 <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> 260
236 </tr> 261 <div class="memitem">
237 </table> 262 <div class="memproto">
238 </div> 263 <table class="mlabels">
239 <div class="memdoc"> 264 <tr>
240 265 <td class="mlabels-left">
241 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 266 <table class="memname">
242 267 <tr>
243 </div> 268 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></td>
244 </div> 269 </tr>
245 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 270 </table>
246 <div class="memitem"> 271 </td>
247 <div class="memproto"> 272 <td class="mlabels-right">
248 <table class="memname"> 273 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
249 <tr> 274 </tr>
250 <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> 275 </table>
251 </tr> 276 </div><div class="memdoc">
252 </table> 277
253 </div> 278 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00395">395</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
254 <div class="memdoc"> 279
255 280 </div>
256 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00221">221</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 281 </div>
257 282 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
258 </div> 283 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
259 </div> 284
260 <hr/><h2>Member Enumeration Documentation</h2> 285 <div class="memitem">
261 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 286 <div class="memproto">
262 <div class="memitem"> 287 <table class="mlabels">
263 <div class="memproto"> 288 <tr>
264 <table class="memname"> 289 <td class="mlabels-left">
265 <tr> 290 <table class="memname">
266 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 291 <tr>
267 </tr> 292 <td class="memname">typedef std::vector&lt;<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>&gt; <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td>
268 </table> 293 </tr>
269 </div> 294 </table>
270 <div class="memdoc"> 295 </td>
271 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 296 <td class="mlabels-right">
272 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 297 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
273 </td></tr> 298 </tr>
274 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 299 </table>
275 </td></tr> 300 </div><div class="memdoc">
276 </table> 301
277 </dd> 302 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
278 </dl> 303
279 304 </div>
280 <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> 305 </div>
281 306 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
282 </div> 307 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
283 </div> 308
284 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 309 <div class="memitem">
285 <a class="anchor" id="a6535abd551acfbbaab381bbe1268cd49"></a> 310 <div class="memproto">
286 <div class="memitem"> 311 <table class="mlabels">
287 <div class="memproto"> 312 <tr>
288 <table class="memname"> 313 <td class="mlabels-left">
289 <tr> 314 <table class="memname">
290 <td class="memname"><a class="el" href="classVamp_1_1PluginHostAdapter.html#a6535abd551acfbbaab381bbe1268cd49">Vamp::PluginHostAdapter::PluginHostAdapter</a> </td> 315 <tr>
316 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
317 </tr>
318 </table>
319 </td>
320 <td class="mlabels-right">
321 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
322 </tr>
323 </table>
324 </div><div class="memdoc">
325
326 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
327
328 </div>
329 </div>
330 <h2 class="groupheader">Member Enumeration Documentation</h2>
331 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
332 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
333
334 <div class="memitem">
335 <div class="memproto">
336 <table class="mlabels">
337 <tr>
338 <td class="mlabels-left">
339 <table class="memname">
340 <tr>
341 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
342 </tr>
343 </table>
344 </td>
345 <td class="mlabels-right">
346 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
347 </tr>
348 </table>
349 </div><div class="memdoc">
350 <table class="fieldtable">
351 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
352 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
353 </table>
354
355 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">152</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
356
357 </div>
358 </div>
359 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
360 <a id="a6535abd551acfbbaab381bbe1268cd49"></a>
361 <h2 class="memtitle"><span class="permalink"><a href="#a6535abd551acfbbaab381bbe1268cd49">&#9670;&nbsp;</a></span>PluginHostAdapter()</h2>
362
363 <div class="memitem">
364 <div class="memproto">
365 <table class="memname">
366 <tr>
367 <td class="memname">Vamp::PluginHostAdapter::PluginHostAdapter </td>
291 <td>(</td> 368 <td>(</td>
292 <td class="paramtype">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td> 369 <td class="paramtype">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td>
293 <td class="paramname"><em>descriptor</em>, </td> 370 <td class="paramname"><em>descriptor</em>, </td>
294 </tr> 371 </tr>
295 <tr> 372 <tr>
302 <td></td> 379 <td></td>
303 <td>)</td> 380 <td>)</td>
304 <td></td><td></td> 381 <td></td><td></td>
305 </tr> 382 </tr>
306 </table> 383 </table>
307 </div> 384 </div><div class="memdoc">
308 <div class="memdoc"> 385
309 386 </div>
310 </div> 387 </div>
311 </div> 388 <a id="aed66c091340aa668d3be89c4b4c24474"></a>
312 <a class="anchor" id="aed66c091340aa668d3be89c4b4c24474"></a> 389 <h2 class="memtitle"><span class="permalink"><a href="#aed66c091340aa668d3be89c4b4c24474">&#9670;&nbsp;</a></span>~PluginHostAdapter()</h2>
313 <div class="memitem"> 390
314 <div class="memproto"> 391 <div class="memitem">
315 <table class="memname"> 392 <div class="memproto">
316 <tr> 393 <table class="mlabels">
317 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginHostAdapter.html#aed66c091340aa668d3be89c4b4c24474">Vamp::PluginHostAdapter::~PluginHostAdapter</a> </td> 394 <tr>
318 <td>(</td> 395 <td class="mlabels-left">
319 <td class="paramname"></td><td>)</td> 396 <table class="memname">
320 <td><code> [virtual]</code></td> 397 <tr>
321 </tr> 398 <td class="memname">virtual Vamp::PluginHostAdapter::~PluginHostAdapter </td>
322 </table> 399 <td>(</td>
323 </div> 400 <td class="paramname"></td><td>)</td>
324 <div class="memdoc"> 401 <td></td>
325 402 </tr>
326 </div> 403 </table>
327 </div> 404 </td>
328 <hr/><h2>Member Function Documentation</h2> 405 <td class="mlabels-right">
329 <a class="anchor" id="a09cbfb7903d28f10d6d556c6cb81c5f6"></a> 406 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
330 <div class="memitem"> 407 </tr>
331 <div class="memproto"> 408 </table>
332 <table class="memname"> 409 </div><div class="memdoc">
333 <tr> 410
334 <td class="memname">static std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginHostAdapter.html#a09cbfb7903d28f10d6d556c6cb81c5f6">Vamp::PluginHostAdapter::getPluginPath</a> </td> 411 </div>
335 <td>(</td> 412 </div>
336 <td class="paramname"></td><td>)</td> 413 <h2 class="groupheader">Member Function Documentation</h2>
337 <td><code> [static]</code></td> 414 <a id="a09cbfb7903d28f10d6d556c6cb81c5f6"></a>
338 </tr> 415 <h2 class="memtitle"><span class="permalink"><a href="#a09cbfb7903d28f10d6d556c6cb81c5f6">&#9670;&nbsp;</a></span>getPluginPath()</h2>
339 </table> 416
340 </div> 417 <div class="memitem">
341 <div class="memdoc"> 418 <div class="memproto">
342 419 <table class="mlabels">
343 </div> 420 <tr>
344 </div> 421 <td class="mlabels-left">
345 <a class="anchor" id="add6a2f1ee7e47bd97fa599cead14b738"></a> 422 <table class="memname">
346 <div class="memitem"> 423 <tr>
347 <div class="memproto"> 424 <td class="memname">static std::vector&lt;std::string&gt; Vamp::PluginHostAdapter::getPluginPath </td>
348 <table class="memname"> 425 <td>(</td>
349 <tr> 426 <td class="paramname"></td><td>)</td>
350 <td class="memname">bool <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738">Vamp::PluginHostAdapter::initialise</a> </td> 427 <td></td>
428 </tr>
429 </table>
430 </td>
431 <td class="mlabels-right">
432 <span class="mlabels"><span class="mlabel">static</span></span> </td>
433 </tr>
434 </table>
435 </div><div class="memdoc">
436
437 </div>
438 </div>
439 <a id="add6a2f1ee7e47bd97fa599cead14b738"></a>
440 <h2 class="memtitle"><span class="permalink"><a href="#add6a2f1ee7e47bd97fa599cead14b738">&#9670;&nbsp;</a></span>initialise()</h2>
441
442 <div class="memitem">
443 <div class="memproto">
444 <table class="mlabels">
445 <tr>
446 <td class="mlabels-left">
447 <table class="memname">
448 <tr>
449 <td class="memname">bool Vamp::PluginHostAdapter::initialise </td>
351 <td>(</td> 450 <td>(</td>
352 <td class="paramtype">size_t&#160;</td> 451 <td class="paramtype">size_t&#160;</td>
353 <td class="paramname"><em>inputChannels</em>, </td> 452 <td class="paramname"><em>inputChannels</em>, </td>
354 </tr> 453 </tr>
355 <tr> 454 <tr>
365 <td class="paramname"><em>blockSize</em>&#160;</td> 464 <td class="paramname"><em>blockSize</em>&#160;</td>
366 </tr> 465 </tr>
367 <tr> 466 <tr>
368 <td></td> 467 <td></td>
369 <td>)</td> 468 <td>)</td>
370 <td></td><td><code> [virtual]</code></td> 469 <td></td><td></td>
371 </tr> 470 </tr>
372 </table> 471 </table>
373 </div> 472 </td>
374 <div class="memdoc"> 473 <td class="mlabels-right">
474 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
475 </tr>
476 </table>
477 </div><div class="memdoc">
375 478
376 <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> 479 <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>
377 <p>The input sample rate should have been already specified at construction time.</p> 480 <p>The input sample rate should have been already specified at construction time.</p>
378 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> 481 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
379 482
380 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> 483 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
381 484
382 </div> 485 </div>
383 </div> 486 </div>
384 <a class="anchor" id="a5d54c5bbd76bc27b7a243827148afeaa"></a> 487 <a id="a5d54c5bbd76bc27b7a243827148afeaa"></a>
385 <div class="memitem"> 488 <h2 class="memtitle"><span class="permalink"><a href="#a5d54c5bbd76bc27b7a243827148afeaa">&#9670;&nbsp;</a></span>reset()</h2>
386 <div class="memproto"> 489
387 <table class="memname"> 490 <div class="memitem">
388 <tr> 491 <div class="memproto">
389 <td class="memname">void <a class="el" href="classVamp_1_1PluginHostAdapter.html#a5d54c5bbd76bc27b7a243827148afeaa">Vamp::PluginHostAdapter::reset</a> </td> 492 <table class="mlabels">
390 <td>(</td> 493 <tr>
391 <td class="paramname"></td><td>)</td> 494 <td class="mlabels-left">
392 <td><code> [virtual]</code></td> 495 <table class="memname">
393 </tr> 496 <tr>
394 </table> 497 <td class="memname">void Vamp::PluginHostAdapter::reset </td>
395 </div> 498 <td>(</td>
396 <div class="memdoc"> 499 <td class="paramname"></td><td>)</td>
500 <td></td>
501 </tr>
502 </table>
503 </td>
504 <td class="mlabels-right">
505 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
506 </tr>
507 </table>
508 </div><div class="memdoc">
397 509
398 <p>Reset the plugin after use, to prepare it for another clean run. </p> 510 <p>Reset the plugin after use, to prepare it for another clean run. </p>
399 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 511 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
400 512
401 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> 513 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
402 514
403 </div> 515 </div>
404 </div> 516 </div>
405 <a class="anchor" id="a8e9d25673367c741631a60cbb36e91d2"></a> 517 <a id="ae1364251d4110ad9538523b3373f8d5e"></a>
406 <div class="memitem"> 518 <h2 class="memtitle"><span class="permalink"><a href="#ae1364251d4110ad9538523b3373f8d5e">&#9670;&nbsp;</a></span>getInputDomain()</h2>
407 <div class="memproto"> 519
408 <table class="memname"> 520 <div class="memitem">
409 <tr> 521 <div class="memproto">
410 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e9d25673367c741631a60cbb36e91d2">Vamp::PluginHostAdapter::getInputDomain</a> </td> 522 <table class="mlabels">
411 <td>(</td> 523 <tr>
412 <td class="paramname"></td><td>)</td> 524 <td class="mlabels-left">
413 <td> const<code> [virtual]</code></td> 525 <table class="memname">
414 </tr> 526 <tr>
415 </table> 527 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> Vamp::PluginHostAdapter::getInputDomain </td>
416 </div> 528 <td>(</td>
417 <div class="memdoc"> 529 <td class="paramname"></td><td>)</td>
530 <td> const</td>
531 </tr>
532 </table>
533 </td>
534 <td class="mlabels-right">
535 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
536 </tr>
537 </table>
538 </div><div class="memdoc">
418 539
419 <p>Get the plugin's required input domain. </p> 540 <p>Get the plugin's required input domain. </p>
420 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" 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> 541 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" 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>
421 <p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. </p> 542 <p>If this is FrequencyDomain, the host will carry out a windowed <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a>. The input data for the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type &ndash; the host will either let the user do so, or will use a Hanning window. </p>
422 543
423 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 544 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
424 545
425 </div> 546 </div>
426 </div> 547 </div>
427 <a class="anchor" id="a98aadddc8403eb46c9d8c5a9d1fdd19e"></a> 548 <a id="adc708325d057516bd92d5ea1c0808dbc"></a>
428 <div class="memitem"> 549 <h2 class="memtitle"><span class="permalink"><a href="#adc708325d057516bd92d5ea1c0808dbc">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
429 <div class="memproto"> 550
430 <table class="memname"> 551 <div class="memitem">
431 <tr> 552 <div class="memproto">
432 <td class="memname">unsigned int <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter::getVampApiVersion</a> </td> 553 <table class="mlabels">
433 <td>(</td> 554 <tr>
434 <td class="paramname"></td><td>)</td> 555 <td class="mlabels-left">
435 <td> const<code> [virtual]</code></td> 556 <table class="memname">
436 </tr> 557 <tr>
437 </table> 558 <td class="memname">unsigned int Vamp::PluginHostAdapter::getVampApiVersion </td>
438 </div> 559 <td>(</td>
439 <div class="memdoc"> 560 <td class="paramname"></td><td>)</td>
561 <td> const</td>
562 </tr>
563 </table>
564 </td>
565 <td class="mlabels-right">
566 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
567 </tr>
568 </table>
569 </div><div class="memdoc">
440 570
441 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 571 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
442 572
443 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase</a>.</p> 573 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">Vamp::PluginBase</a>.</p>
444 574
445 </div> 575 </div>
446 </div> 576 </div>
447 <a class="anchor" id="ab27423a656f878d97d2ad2eba4e76c7a"></a> 577 <a id="a68749b61d8a4e322d7ce6662347817ca"></a>
448 <div class="memitem"> 578 <h2 class="memtitle"><span class="permalink"><a href="#a68749b61d8a4e322d7ce6662347817ca">&#9670;&nbsp;</a></span>getIdentifier()</h2>
449 <div class="memproto"> 579
450 <table class="memname"> 580 <div class="memitem">
451 <tr> 581 <div class="memproto">
452 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#ab27423a656f878d97d2ad2eba4e76c7a">Vamp::PluginHostAdapter::getIdentifier</a> </td> 582 <table class="mlabels">
453 <td>(</td> 583 <tr>
454 <td class="paramname"></td><td>)</td> 584 <td class="mlabels-left">
455 <td> const<code> [virtual]</code></td> 585 <table class="memname">
456 </tr> 586 <tr>
457 </table> 587 <td class="memname">std::string Vamp::PluginHostAdapter::getIdentifier </td>
458 </div> 588 <td>(</td>
459 <div class="memdoc"> 589 <td class="paramname"></td><td>)</td>
590 <td> const</td>
591 </tr>
592 </table>
593 </td>
594 <td class="mlabels-right">
595 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
596 </tr>
597 </table>
598 </div><div class="memdoc">
460 599
461 <p>Get the computer-usable name of the plugin. </p> 600 <p>Get the computer-usable name of the plugin. </p>
462 <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> 601 <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>
463 <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> 602 <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>
464 <p>Example: "zero_crossings" </p> 603 <p>Example: "zero_crossings" </p>
465 604
466 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 605 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
467 606
468 </div> 607 </div>
469 </div> 608 </div>
470 <a class="anchor" id="a45f1d0377e233eeddd1b7cefb48be62a"></a> 609 <a id="a6276b0838a3a9ac155d295cae0e7bb67"></a>
471 <div class="memitem"> 610 <h2 class="memtitle"><span class="permalink"><a href="#a6276b0838a3a9ac155d295cae0e7bb67">&#9670;&nbsp;</a></span>getName()</h2>
472 <div class="memproto"> 611
473 <table class="memname"> 612 <div class="memitem">
474 <tr> 613 <div class="memproto">
475 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#a45f1d0377e233eeddd1b7cefb48be62a">Vamp::PluginHostAdapter::getName</a> </td> 614 <table class="mlabels">
476 <td>(</td> 615 <tr>
477 <td class="paramname"></td><td>)</td> 616 <td class="mlabels-left">
478 <td> const<code> [virtual]</code></td> 617 <table class="memname">
479 </tr> 618 <tr>
480 </table> 619 <td class="memname">std::string Vamp::PluginHostAdapter::getName </td>
481 </div> 620 <td>(</td>
482 <div class="memdoc"> 621 <td class="paramname"></td><td>)</td>
622 <td> const</td>
623 </tr>
624 </table>
625 </td>
626 <td class="mlabels-right">
627 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
628 </tr>
629 </table>
630 </div><div class="memdoc">
483 631
484 <p>Get a human-readable name or title of the plugin. </p> 632 <p>Get a human-readable name or title of the plugin. </p>
485 <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> 633 <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>
486 <p>Example: "Zero Crossings" </p> 634 <p>Example: "Zero Crossings" </p>
487 635
488 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 636 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
489 637
490 </div> 638 </div>
491 </div> 639 </div>
492 <a class="anchor" id="a5eaafcef030e81b90a3e77cf16cf8ae1"></a> 640 <a id="aae795d71594901243de8cda96d871fc8"></a>
493 <div class="memitem"> 641 <h2 class="memtitle"><span class="permalink"><a href="#aae795d71594901243de8cda96d871fc8">&#9670;&nbsp;</a></span>getDescription()</h2>
494 <div class="memproto"> 642
495 <table class="memname"> 643 <div class="memitem">
496 <tr> 644 <div class="memproto">
497 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#a5eaafcef030e81b90a3e77cf16cf8ae1">Vamp::PluginHostAdapter::getDescription</a> </td> 645 <table class="mlabels">
498 <td>(</td> 646 <tr>
499 <td class="paramname"></td><td>)</td> 647 <td class="mlabels-left">
500 <td> const<code> [virtual]</code></td> 648 <table class="memname">
501 </tr> 649 <tr>
502 </table> 650 <td class="memname">std::string Vamp::PluginHostAdapter::getDescription </td>
503 </div> 651 <td>(</td>
504 <div class="memdoc"> 652 <td class="paramname"></td><td>)</td>
653 <td> const</td>
654 </tr>
655 </table>
656 </td>
657 <td class="mlabels-right">
658 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
659 </tr>
660 </table>
661 </div><div class="memdoc">
505 662
506 <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> 663 <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>
507 <p>May be empty if the name has said it all already.</p> 664 <p>May be empty if the name has said it all already.</p>
508 <p>Example: "Detect and count zero crossing points" </p> 665 <p>Example: "Detect and count zero crossing points" </p>
509 666
510 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 667 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
511 668
512 </div> 669 </div>
513 </div> 670 </div>
514 <a class="anchor" id="af572be0b175f5661559006a380a0f3db"></a> 671 <a id="ac906c3a0eef77f545fb4dad2456ee2b4"></a>
515 <div class="memitem"> 672 <h2 class="memtitle"><span class="permalink"><a href="#ac906c3a0eef77f545fb4dad2456ee2b4">&#9670;&nbsp;</a></span>getMaker()</h2>
516 <div class="memproto"> 673
517 <table class="memname"> 674 <div class="memitem">
518 <tr> 675 <div class="memproto">
519 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#af572be0b175f5661559006a380a0f3db">Vamp::PluginHostAdapter::getMaker</a> </td> 676 <table class="mlabels">
520 <td>(</td> 677 <tr>
521 <td class="paramname"></td><td>)</td> 678 <td class="mlabels-left">
522 <td> const<code> [virtual]</code></td> 679 <table class="memname">
523 </tr> 680 <tr>
524 </table> 681 <td class="memname">std::string Vamp::PluginHostAdapter::getMaker </td>
525 </div> 682 <td>(</td>
526 <div class="memdoc"> 683 <td class="paramname"></td><td>)</td>
684 <td> const</td>
685 </tr>
686 </table>
687 </td>
688 <td class="mlabels-right">
689 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
690 </tr>
691 </table>
692 </div><div class="memdoc">
527 693
528 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 694 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
529 <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> 695 <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>
530 696
531 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 697 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
532 698
533 </div> 699 </div>
534 </div> 700 </div>
535 <a class="anchor" id="a6fbd94781867ca46a20368c2a3593c77"></a> 701 <a id="a5e774f5b0e86293714c0506676d4fa62"></a>
536 <div class="memitem"> 702 <h2 class="memtitle"><span class="permalink"><a href="#a5e774f5b0e86293714c0506676d4fa62">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
537 <div class="memproto"> 703
538 <table class="memname"> 704 <div class="memitem">
539 <tr> 705 <div class="memproto">
540 <td class="memname">int <a class="el" href="classVamp_1_1PluginHostAdapter.html#a6fbd94781867ca46a20368c2a3593c77">Vamp::PluginHostAdapter::getPluginVersion</a> </td> 706 <table class="mlabels">
541 <td>(</td> 707 <tr>
542 <td class="paramname"></td><td>)</td> 708 <td class="mlabels-left">
543 <td> const<code> [virtual]</code></td> 709 <table class="memname">
544 </tr> 710 <tr>
545 </table> 711 <td class="memname">int Vamp::PluginHostAdapter::getPluginVersion </td>
546 </div> 712 <td>(</td>
547 <div class="memdoc"> 713 <td class="paramname"></td><td>)</td>
714 <td> const</td>
715 </tr>
716 </table>
717 </td>
718 <td class="mlabels-right">
719 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
720 </tr>
721 </table>
722 </div><div class="memdoc">
548 723
549 <p>Get the version number of the plugin. </p> 724 <p>Get the version number of the plugin. </p>
550 725
551 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 726 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
552 727
553 </div> 728 </div>
554 </div> 729 </div>
555 <a class="anchor" id="ac73c9d6baad04369beee695e99584815"></a> 730 <a id="a6f68665c4c00bb55e4736a091a68d9a9"></a>
556 <div class="memitem"> 731 <h2 class="memtitle"><span class="permalink"><a href="#a6f68665c4c00bb55e4736a091a68d9a9">&#9670;&nbsp;</a></span>getCopyright()</h2>
557 <div class="memproto"> 732
558 <table class="memname"> 733 <div class="memitem">
559 <tr> 734 <div class="memproto">
560 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#ac73c9d6baad04369beee695e99584815">Vamp::PluginHostAdapter::getCopyright</a> </td> 735 <table class="mlabels">
561 <td>(</td> 736 <tr>
562 <td class="paramname"></td><td>)</td> 737 <td class="mlabels-left">
563 <td> const<code> [virtual]</code></td> 738 <table class="memname">
564 </tr> 739 <tr>
565 </table> 740 <td class="memname">std::string Vamp::PluginHostAdapter::getCopyright </td>
566 </div> 741 <td>(</td>
567 <div class="memdoc"> 742 <td class="paramname"></td><td>)</td>
743 <td> const</td>
744 </tr>
745 </table>
746 </td>
747 <td class="mlabels-right">
748 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
749 </tr>
750 </table>
751 </div><div class="memdoc">
568 752
569 <p>Get the copyright statement or licensing summary for the plugin. </p> 753 <p>Get the copyright statement or licensing summary for the plugin. </p>
570 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 754 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
571 755
572 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 756 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
573 757
574 </div> 758 </div>
575 </div> 759 </div>
576 <a class="anchor" id="a602faa0bfaae83e2ca53b36292271a76"></a> 760 <a id="a8f2b1c45be01169414bc86b685f4508e"></a>
577 <div class="memitem"> 761 <h2 class="memtitle"><span class="permalink"><a href="#a8f2b1c45be01169414bc86b685f4508e">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
578 <div class="memproto"> 762
579 <table class="memname"> 763 <div class="memitem">
580 <tr> 764 <div class="memproto">
581 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter::getParameterDescriptors</a> </td> 765 <table class="mlabels">
582 <td>(</td> 766 <tr>
583 <td class="paramname"></td><td>)</td> 767 <td class="mlabels-left">
584 <td> const<code> [virtual]</code></td> 768 <table class="memname">
585 </tr> 769 <tr>
586 </table> 770 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginHostAdapter::getParameterDescriptors </td>
587 </div> 771 <td>(</td>
588 <div class="memdoc"> 772 <td class="paramname"></td><td>)</td>
773 <td> const</td>
774 </tr>
775 </table>
776 </td>
777 <td class="mlabels-right">
778 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
779 </tr>
780 </table>
781 </div><div class="memdoc">
589 782
590 <p>Get the controllable parameters of this plugin. </p> 783 <p>Get the controllable parameters of this plugin. </p>
591 784
592 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 785 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
593 786
594 </div> 787 </div>
595 </div> 788 </div>
596 <a class="anchor" id="af0c46d4f67ca93be7c76f3ea2e6c8efb"></a> 789 <a id="a97149b60fb9d7c4359262ba8f6ff9743"></a>
597 <div class="memitem"> 790 <h2 class="memtitle"><span class="permalink"><a href="#a97149b60fb9d7c4359262ba8f6ff9743">&#9670;&nbsp;</a></span>getParameter()</h2>
598 <div class="memproto"> 791
599 <table class="memname"> 792 <div class="memitem">
600 <tr> 793 <div class="memproto">
601 <td class="memname">float <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter::getParameter</a> </td> 794 <table class="mlabels">
795 <tr>
796 <td class="mlabels-left">
797 <table class="memname">
798 <tr>
799 <td class="memname">float Vamp::PluginHostAdapter::getParameter </td>
602 <td>(</td> 800 <td>(</td>
603 <td class="paramtype">std::string&#160;</td> 801 <td class="paramtype">std::string&#160;</td>
604 <td class="paramname"></td><td>)</td> 802 <td class="paramname"></td><td>)</td>
605 <td> const<code> [virtual]</code></td> 803 <td> const</td>
606 </tr> 804 </tr>
607 </table> 805 </table>
608 </div> 806 </td>
609 <div class="memdoc"> 807 <td class="mlabels-right">
808 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
809 </tr>
810 </table>
811 </div><div class="memdoc">
610 812
611 <p>Get the value of a named parameter. </p> 813 <p>Get the value of a named parameter. </p>
612 <p>The argument is the identifier field from that parameter's descriptor. </p> 814 <p>The argument is the identifier field from that parameter's descriptor. </p>
613 815
614 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 816 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
615 817
616 </div> 818 </div>
617 </div> 819 </div>
618 <a class="anchor" id="a29f75395aa75b9de0228aa11edf9c6d6"></a> 820 <a id="a29f75395aa75b9de0228aa11edf9c6d6"></a>
619 <div class="memitem"> 821 <h2 class="memtitle"><span class="permalink"><a href="#a29f75395aa75b9de0228aa11edf9c6d6">&#9670;&nbsp;</a></span>setParameter()</h2>
620 <div class="memproto"> 822
621 <table class="memname"> 823 <div class="memitem">
622 <tr> 824 <div class="memproto">
623 <td class="memname">void <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter::setParameter</a> </td> 825 <table class="mlabels">
826 <tr>
827 <td class="mlabels-left">
828 <table class="memname">
829 <tr>
830 <td class="memname">void Vamp::PluginHostAdapter::setParameter </td>
624 <td>(</td> 831 <td>(</td>
625 <td class="paramtype">std::string&#160;</td> 832 <td class="paramtype">std::string&#160;</td>
626 <td class="paramname">, </td> 833 <td class="paramname">, </td>
627 </tr> 834 </tr>
628 <tr> 835 <tr>
632 <td class="paramname">&#160;</td> 839 <td class="paramname">&#160;</td>
633 </tr> 840 </tr>
634 <tr> 841 <tr>
635 <td></td> 842 <td></td>
636 <td>)</td> 843 <td>)</td>
637 <td></td><td><code> [virtual]</code></td> 844 <td></td><td></td>
638 </tr> 845 </tr>
639 </table> 846 </table>
640 </div> 847 </td>
641 <div class="memdoc"> 848 <td class="mlabels-right">
849 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
850 </tr>
851 </table>
852 </div><div class="memdoc">
642 853
643 <p>Set a named parameter. </p> 854 <p>Set a named parameter. </p>
644 <p>The first argument is the identifier field from that parameter's descriptor. </p> 855 <p>The first argument is the identifier field from that parameter's descriptor. </p>
645 856
646 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 857 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
647 858
648 </div> 859 </div>
649 </div> 860 </div>
650 <a class="anchor" id="ae0cde5cd625418c1bc470b91f75daafc"></a> 861 <a id="a1e3c40e9b9d8dc876d2e732976950c4b"></a>
651 <div class="memitem"> 862 <h2 class="memtitle"><span class="permalink"><a href="#a1e3c40e9b9d8dc876d2e732976950c4b">&#9670;&nbsp;</a></span>getPrograms()</h2>
652 <div class="memproto"> 863
653 <table class="memname"> 864 <div class="memitem">
654 <tr> 865 <div class="memproto">
655 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter::getPrograms</a> </td> 866 <table class="mlabels">
656 <td>(</td> 867 <tr>
657 <td class="paramname"></td><td>)</td> 868 <td class="mlabels-left">
658 <td> const<code> [virtual]</code></td> 869 <table class="memname">
659 </tr> 870 <tr>
660 </table> 871 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginHostAdapter::getPrograms </td>
661 </div> 872 <td>(</td>
662 <div class="memdoc"> 873 <td class="paramname"></td><td>)</td>
874 <td> const</td>
875 </tr>
876 </table>
877 </td>
878 <td class="mlabels-right">
879 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
880 </tr>
881 </table>
882 </div><div class="memdoc">
663 883
664 <p>Get the program settings available in this plugin. </p> 884 <p>Get the program settings available in this plugin. </p>
665 <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> 885 <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>
666 <p>The programs must have unique names. </p> 886 <p>The programs must have unique names. </p>
667 887
668 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase</a>.</p> 888 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">Vamp::PluginBase</a>.</p>
669 889
670 </div> 890 </div>
671 </div> 891 </div>
672 <a class="anchor" id="a34859eff8ca8d862af39be9636ec1867"></a> 892 <a id="abf984c347c4dac9e4b01123498bfe68f"></a>
673 <div class="memitem"> 893 <h2 class="memtitle"><span class="permalink"><a href="#abf984c347c4dac9e4b01123498bfe68f">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
674 <div class="memproto"> 894
675 <table class="memname"> 895 <div class="memitem">
676 <tr> 896 <div class="memproto">
677 <td class="memname">std::string <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter::getCurrentProgram</a> </td> 897 <table class="mlabels">
678 <td>(</td> 898 <tr>
679 <td class="paramname"></td><td>)</td> 899 <td class="mlabels-left">
680 <td> const<code> [virtual]</code></td> 900 <table class="memname">
681 </tr> 901 <tr>
682 </table> 902 <td class="memname">std::string Vamp::PluginHostAdapter::getCurrentProgram </td>
683 </div> 903 <td>(</td>
684 <div class="memdoc"> 904 <td class="paramname"></td><td>)</td>
905 <td> const</td>
906 </tr>
907 </table>
908 </td>
909 <td class="mlabels-right">
910 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
911 </tr>
912 </table>
913 </div><div class="memdoc">
685 914
686 <p>Get the current program. </p> 915 <p>Get the current program. </p>
687 916
688 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase</a>.</p> 917 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">Vamp::PluginBase</a>.</p>
689 918
690 </div> 919 </div>
691 </div> 920 </div>
692 <a class="anchor" id="a8f5515ab34cc13d9403ccc6b4b788683"></a> 921 <a id="a8f5515ab34cc13d9403ccc6b4b788683"></a>
693 <div class="memitem"> 922 <h2 class="memtitle"><span class="permalink"><a href="#a8f5515ab34cc13d9403ccc6b4b788683">&#9670;&nbsp;</a></span>selectProgram()</h2>
694 <div class="memproto"> 923
695 <table class="memname"> 924 <div class="memitem">
696 <tr> 925 <div class="memproto">
697 <td class="memname">void <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter::selectProgram</a> </td> 926 <table class="mlabels">
927 <tr>
928 <td class="mlabels-left">
929 <table class="memname">
930 <tr>
931 <td class="memname">void Vamp::PluginHostAdapter::selectProgram </td>
698 <td>(</td> 932 <td>(</td>
699 <td class="paramtype">std::string&#160;</td> 933 <td class="paramtype">std::string&#160;</td>
700 <td class="paramname"></td><td>)</td> 934 <td class="paramname"></td><td>)</td>
701 <td><code> [virtual]</code></td> 935 <td></td>
702 </tr> 936 </tr>
703 </table> 937 </table>
704 </div> 938 </td>
705 <div class="memdoc"> 939 <td class="mlabels-right">
940 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
941 </tr>
942 </table>
943 </div><div class="memdoc">
706 944
707 <p>Select a program. </p> 945 <p>Select a program. </p>
708 <p>(If the given program name is not one of the available programs, do nothing.) </p> 946 <p>(If the given program name is not one of the available programs, do nothing.) </p>
709 947
710 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p> 948 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase</a>.</p>
711 949
712 </div> 950 </div>
713 </div> 951 </div>
714 <a class="anchor" id="a859ad5d59402691daed3cf1af1899ebe"></a> 952 <a id="a344c85cc017c97bf4f0f144e7d6e0f42"></a>
715 <div class="memitem"> 953 <h2 class="memtitle"><span class="permalink"><a href="#a344c85cc017c97bf4f0f144e7d6e0f42">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
716 <div class="memproto"> 954
717 <table class="memname"> 955 <div class="memitem">
718 <tr> 956 <div class="memproto">
719 <td class="memname">size_t <a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter::getPreferredStepSize</a> </td> 957 <table class="mlabels">
720 <td>(</td> 958 <tr>
721 <td class="paramname"></td><td>)</td> 959 <td class="mlabels-left">
722 <td> const<code> [virtual]</code></td> 960 <table class="memname">
723 </tr> 961 <tr>
724 </table> 962 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredStepSize </td>
725 </div> 963 <td>(</td>
726 <div class="memdoc"> 964 <td class="paramname"></td><td>)</td>
727 965 <td> const</td>
728 <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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function) for the plugin. </p> 966 </tr>
729 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a>.</p> 967 </table>
730 <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_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" title="Initialise a plugin to prepare it for use with the given number of input channels, step size (window increment, in sample frames) and block size (window size, in sample frames).">initialise()</a> call. </p> 968 </td>
731 969 <td class="mlabels-right">
732 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin</a>.</p> 970 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
733 971 </tr>
734 </div> 972 </table>
735 </div> 973 </div><div class="memdoc">
736 <a class="anchor" id="ad5e0ea8042bdec4dd18428991117e07a"></a> 974
737 <div class="memitem"> 975 <p>Get the preferred step size (window increment &ndash; the distance in sample frames between the start frames of consecutive blocks passed to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
738 <div class="memproto"> 976 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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>
739 <table class="memname"> 977 <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_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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>
740 <tr> 978
741 <td class="memname">size_t <a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter::getPreferredBlockSize</a> </td> 979 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">Vamp::Plugin</a>.</p>
742 <td>(</td> 980
743 <td class="paramname"></td><td>)</td> 981 </div>
744 <td> const<code> [virtual]</code></td> 982 </div>
745 </tr> 983 <a id="a9ee8ecc8406f633c68e9aa1516700332"></a>
746 </table> 984 <h2 class="memtitle"><span class="permalink"><a href="#a9ee8ecc8406f633c68e9aa1516700332">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
747 </div> 985
748 <div class="memdoc"> 986 <div class="memitem">
749 987 <div class="memproto">
750 <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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> function). </p> 988 <table class="mlabels">
751 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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> 989 <tr>
752 <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_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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> 990 <td class="mlabels-left">
753 991 <table class="memname">
754 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin</a>.</p> 992 <tr>
755 993 <td class="memname">size_t Vamp::PluginHostAdapter::getPreferredBlockSize </td>
756 </div> 994 <td>(</td>
757 </div> 995 <td class="paramname"></td><td>)</td>
758 <a class="anchor" id="a67d1198c0e58d3f0076d0eda599ff28d"></a> 996 <td> const</td>
759 <div class="memitem"> 997 </tr>
760 <div class="memproto"> 998 </table>
761 <table class="memname"> 999 </td>
762 <tr> 1000 <td class="mlabels-right">
763 <td class="memname">size_t <a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter::getMinChannelCount</a> </td> 1001 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
764 <td>(</td> 1002 </tr>
765 <td class="paramname"></td><td>)</td> 1003 </table>
766 <td> const<code> [virtual]</code></td> 1004 </div><div class="memdoc">
767 </tr> 1005
768 </table> 1006 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a> function). </p>
769 </div> 1007 <p>This should be called before <a class="el" href="classVamp_1_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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>
770 <div class="memdoc"> 1008 <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_1PluginHostAdapter.html#add6a2f1ee7e47bd97fa599cead14b738" 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>
1009
1010 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">Vamp::Plugin</a>.</p>
1011
1012 </div>
1013 </div>
1014 <a id="a8e7f62e03adea0321080839f6ef6c77b"></a>
1015 <h2 class="memtitle"><span class="permalink"><a href="#a8e7f62e03adea0321080839f6ef6c77b">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
1016
1017 <div class="memitem">
1018 <div class="memproto">
1019 <table class="mlabels">
1020 <tr>
1021 <td class="mlabels-left">
1022 <table class="memname">
1023 <tr>
1024 <td class="memname">size_t Vamp::PluginHostAdapter::getMinChannelCount </td>
1025 <td>(</td>
1026 <td class="paramname"></td><td>)</td>
1027 <td> const</td>
1028 </tr>
1029 </table>
1030 </td>
1031 <td class="mlabels-right">
1032 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1033 </tr>
1034 </table>
1035 </div><div class="memdoc">
771 1036
772 <p>Get the minimum supported number of input channels. </p> 1037 <p>Get the minimum supported number of input channels. </p>
773 1038
774 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin</a>.</p> 1039 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">Vamp::Plugin</a>.</p>
775 1040
776 </div> 1041 </div>
777 </div> 1042 </div>
778 <a class="anchor" id="a25091905e97e39d515d8ffc1a9f2b9e0"></a> 1043 <a id="a626ad6e35eb0f4ed93bc3c6d976cdca4"></a>
779 <div class="memitem"> 1044 <h2 class="memtitle"><span class="permalink"><a href="#a626ad6e35eb0f4ed93bc3c6d976cdca4">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
780 <div class="memproto"> 1045
781 <table class="memname"> 1046 <div class="memitem">
782 <tr> 1047 <div class="memproto">
783 <td class="memname">size_t <a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter::getMaxChannelCount</a> </td> 1048 <table class="mlabels">
784 <td>(</td> 1049 <tr>
785 <td class="paramname"></td><td>)</td> 1050 <td class="mlabels-left">
786 <td> const<code> [virtual]</code></td> 1051 <table class="memname">
787 </tr> 1052 <tr>
788 </table> 1053 <td class="memname">size_t Vamp::PluginHostAdapter::getMaxChannelCount </td>
789 </div> 1054 <td>(</td>
790 <div class="memdoc"> 1055 <td class="paramname"></td><td>)</td>
1056 <td> const</td>
1057 </tr>
1058 </table>
1059 </td>
1060 <td class="mlabels-right">
1061 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1062 </tr>
1063 </table>
1064 </div><div class="memdoc">
791 1065
792 <p>Get the maximum supported number of input channels. </p> 1066 <p>Get the maximum supported number of input channels. </p>
793 1067
794 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin</a>.</p> 1068 <p>Reimplemented from <a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">Vamp::Plugin</a>.</p>
795 1069
796 </div> 1070 </div>
797 </div> 1071 </div>
798 <a class="anchor" id="a9649a113da0252fe8bd9fc731b047ae0"></a> 1072 <a id="ad799e6317c4caf1a1c55b172ed6cc1fc"></a>
799 <div class="memitem"> 1073 <h2 class="memtitle"><span class="permalink"><a href="#ad799e6317c4caf1a1c55b172ed6cc1fc">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
800 <div class="memproto"> 1074
801 <table class="memname"> 1075 <div class="memitem">
802 <tr> 1076 <div class="memproto">
803 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a9649a113da0252fe8bd9fc731b047ae0">Vamp::PluginHostAdapter::getOutputDescriptors</a> </td> 1077 <table class="mlabels">
804 <td>(</td> 1078 <tr>
805 <td class="paramname"></td><td>)</td> 1079 <td class="mlabels-left">
806 <td> const<code> [virtual]</code></td> 1080 <table class="memname">
807 </tr> 1081 <tr>
808 </table> 1082 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> Vamp::PluginHostAdapter::getOutputDescriptors </td>
809 </div> 1083 <td>(</td>
810 <div class="memdoc"> 1084 <td class="paramname"></td><td>)</td>
1085 <td> const</td>
1086 </tr>
1087 </table>
1088 </td>
1089 <td class="mlabels-right">
1090 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1091 </tr>
1092 </table>
1093 </div><div class="memdoc">
811 1094
812 <p>Get the outputs of this plugin. </p> 1095 <p>Get the outputs of this plugin. </p>
813 <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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data.">process()</a> call. </p> 1096 <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_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd" title="Process a single block of input data. ">process()</a> call. </p>
814 1097
815 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 1098 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
816 1099
817 </div> 1100 </div>
818 </div> 1101 </div>
819 <a class="anchor" id="a38fe1080b343ba10e5d8a4b30c87cbdd"></a> 1102 <a id="a38fe1080b343ba10e5d8a4b30c87cbdd"></a>
820 <div class="memitem"> 1103 <h2 class="memtitle"><span class="permalink"><a href="#a38fe1080b343ba10e5d8a4b30c87cbdd">&#9670;&nbsp;</a></span>process()</h2>
821 <div class="memproto"> 1104
822 <table class="memname"> 1105 <div class="memitem">
823 <tr> 1106 <div class="memproto">
824 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a38fe1080b343ba10e5d8a4b30c87cbdd">Vamp::PluginHostAdapter::process</a> </td> 1107 <table class="mlabels">
1108 <tr>
1109 <td class="mlabels-left">
1110 <table class="memname">
1111 <tr>
1112 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::process </td>
825 <td>(</td> 1113 <td>(</td>
826 <td class="paramtype">const float *const *&#160;</td> 1114 <td class="paramtype">const float *const *&#160;</td>
827 <td class="paramname"><em>inputBuffers</em>, </td> 1115 <td class="paramname"><em>inputBuffers</em>, </td>
828 </tr> 1116 </tr>
829 <tr> 1117 <tr>
833 <td class="paramname"><em>timestamp</em>&#160;</td> 1121 <td class="paramname"><em>timestamp</em>&#160;</td>
834 </tr> 1122 </tr>
835 <tr> 1123 <tr>
836 <td></td> 1124 <td></td>
837 <td>)</td> 1125 <td>)</td>
838 <td></td><td><code> [virtual]</code></td> 1126 <td></td><td></td>
839 </tr> 1127 </tr>
840 </table> 1128 </table>
841 </div> 1129 </td>
842 <div class="memdoc"> 1130 <td class="mlabels-right">
1131 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1132 </tr>
1133 </table>
1134 </div><div class="memdoc">
843 1135
844 <p>Process a single block of input data. </p> 1136 <p>Process a single block of input data. </p>
845 <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> 1137 <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>
846 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors.">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p> 1138 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> input window (i.e. the very first block passed to process might contain the <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
847 <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> 1139 <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>
848 1140
849 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 1141 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
850 1142
851 </div> 1143 </div>
852 </div> 1144 </div>
853 <a class="anchor" id="a984a4c11f3fbdcfd90e4837b1619a5ab"></a> 1145 <a id="a984a4c11f3fbdcfd90e4837b1619a5ab"></a>
854 <div class="memitem"> 1146 <h2 class="memtitle"><span class="permalink"><a href="#a984a4c11f3fbdcfd90e4837b1619a5ab">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
855 <div class="memproto"> 1147
856 <table class="memname"> 1148 <div class="memitem">
857 <tr> 1149 <div class="memproto">
858 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a984a4c11f3fbdcfd90e4837b1619a5ab">Vamp::PluginHostAdapter::getRemainingFeatures</a> </td> 1150 <table class="mlabels">
859 <td>(</td> 1151 <tr>
860 <td class="paramname"></td><td>)</td> 1152 <td class="mlabels-left">
861 <td><code> [virtual]</code></td> 1153 <table class="memname">
862 </tr> 1154 <tr>
863 </table> 1155 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> Vamp::PluginHostAdapter::getRemainingFeatures </td>
864 </div> 1156 <td>(</td>
865 <div class="memdoc"> 1157 <td class="paramname"></td><td>)</td>
1158 <td></td>
1159 </tr>
1160 </table>
1161 </td>
1162 <td class="mlabels-right">
1163 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
1164 </tr>
1165 </table>
1166 </div><div class="memdoc">
866 1167
867 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 1168 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
868 1169
869 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 1170 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
870 1171
871 </div> 1172 </div>
872 </div> 1173 </div>
873 <a class="anchor" id="aee417a4c9ba9dbb63777c963d5f9452a"></a> 1174 <a id="aee417a4c9ba9dbb63777c963d5f9452a"></a>
874 <div class="memitem"> 1175 <h2 class="memtitle"><span class="permalink"><a href="#aee417a4c9ba9dbb63777c963d5f9452a">&#9670;&nbsp;</a></span>convertFeatures()</h2>
875 <div class="memproto"> 1176
876 <table class="memname"> 1177 <div class="memitem">
877 <tr> 1178 <div class="memproto">
878 <td class="memname">void <a class="el" href="classVamp_1_1PluginHostAdapter.html#aee417a4c9ba9dbb63777c963d5f9452a">Vamp::PluginHostAdapter::convertFeatures</a> </td> 1179 <table class="mlabels">
1180 <tr>
1181 <td class="mlabels-left">
1182 <table class="memname">
1183 <tr>
1184 <td class="memname">void Vamp::PluginHostAdapter::convertFeatures </td>
879 <td>(</td> 1185 <td>(</td>
880 <td class="paramtype"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *&#160;</td> 1186 <td class="paramtype"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *&#160;</td>
881 <td class="paramname">, </td> 1187 <td class="paramname">, </td>
882 </tr> 1188 </tr>
883 <tr> 1189 <tr>
887 <td class="paramname">&#160;</td> 1193 <td class="paramname">&#160;</td>
888 </tr> 1194 </tr>
889 <tr> 1195 <tr>
890 <td></td> 1196 <td></td>
891 <td>)</td> 1197 <td>)</td>
892 <td></td><td><code> [protected]</code></td> 1198 <td></td><td></td>
893 </tr> 1199 </tr>
894 </table> 1200 </table>
895 </div> 1201 </td>
896 <div class="memdoc"> 1202 <td class="mlabels-right">
897 1203 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
898 </div> 1204 </tr>
899 </div> 1205 </table>
900 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 1206 </div><div class="memdoc">
901 <div class="memitem"> 1207
902 <div class="memproto"> 1208 </div>
903 <table class="memname"> 1209 </div>
904 <tr> 1210 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
905 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 1211 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
906 <td>(</td> 1212
907 <td class="paramname"></td><td>)</td> 1213 <div class="memitem">
908 <td> const<code> [inline, virtual, inherited]</code></td> 1214 <div class="memproto">
909 </tr> 1215 <table class="mlabels">
910 </table> 1216 <tr>
911 </div> 1217 <td class="mlabels-left">
912 <div class="memdoc"> 1218 <table class="memname">
913 1219 <tr>
914 <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> 1220 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
1221 <td>(</td>
1222 <td class="paramname"></td><td>)</td>
1223 <td> const</td>
1224 </tr>
1225 </table>
1226 </td>
1227 <td class="mlabels-right">
1228 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1229 </tr>
1230 </table>
1231 </div><div class="memdoc">
1232
1233 <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>
915 <p>Do not reimplement this function in your subclass. </p> 1234 <p>Do not reimplement this function in your subclass. </p>
916 1235
917 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1236 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
918 1237
919 <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> 1238 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00438">438</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
920 1239
921 </div> 1240 </div>
922 </div> 1241 </div>
923 <hr/><h2>Member Data Documentation</h2> 1242 <h2 class="groupheader">Member Data Documentation</h2>
924 <a class="anchor" id="a0c9f252aca8ac298e30cadd0de032ec2"></a> 1243 <a id="a0c9f252aca8ac298e30cadd0de032ec2"></a>
925 <div class="memitem"> 1244 <h2 class="memtitle"><span class="permalink"><a href="#a0c9f252aca8ac298e30cadd0de032ec2">&#9670;&nbsp;</a></span>m_descriptor</h2>
926 <div class="memproto"> 1245
927 <table class="memname"> 1246 <div class="memitem">
928 <tr> 1247 <div class="memproto">
929 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginHostAdapter.html#a0c9f252aca8ac298e30cadd0de032ec2">Vamp::PluginHostAdapter::m_descriptor</a><code> [protected]</code></td> 1248 <table class="mlabels">
930 </tr> 1249 <tr>
931 </table> 1250 <td class="mlabels-left">
932 </div> 1251 <table class="memname">
933 <div class="memdoc"> 1252 <tr>
934 1253 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginHostAdapter::m_descriptor</td>
935 <p>Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00113">113</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p> 1254 </tr>
936 1255 </table>
937 </div> 1256 </td>
938 </div> 1257 <td class="mlabels-right">
939 <a class="anchor" id="a02ebd03b226b4a467cad747ce77e79ee"></a> 1258 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
940 <div class="memitem"> 1259 </tr>
941 <div class="memproto"> 1260 </table>
942 <table class="memname"> 1261 </div><div class="memdoc">
943 <tr> 1262
944 <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> <a class="el" href="classVamp_1_1PluginHostAdapter.html#a02ebd03b226b4a467cad747ce77e79ee">Vamp::PluginHostAdapter::m_handle</a><code> [protected]</code></td> 1263 <p class="definition">Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00113">113</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p>
945 </tr> 1264
946 </table> 1265 </div>
947 </div> 1266 </div>
948 <div class="memdoc"> 1267 <a id="a02ebd03b226b4a467cad747ce77e79ee"></a>
949 1268 <h2 class="memtitle"><span class="permalink"><a href="#a02ebd03b226b4a467cad747ce77e79ee">&#9670;&nbsp;</a></span>m_handle</h2>
950 <p>Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00114">114</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p> 1269
951 1270 <div class="memitem">
952 </div> 1271 <div class="memproto">
953 </div> 1272 <table class="mlabels">
954 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1273 <tr>
955 <div class="memitem"> 1274 <td class="mlabels-left">
956 <div class="memproto"> 1275 <table class="memname">
957 <table class="memname"> 1276 <tr>
958 <tr> 1277 <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> Vamp::PluginHostAdapter::m_handle</td>
959 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1278 </tr>
960 </tr> 1279 </table>
961 </table> 1280 </td>
962 </div> 1281 <td class="mlabels-right">
963 <div class="memdoc"> 1282 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
964 1283 </tr>
965 <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> 1284 </table>
966 1285 </div><div class="memdoc">
967 <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> 1286
1287 <p class="definition">Definition at line <a class="el" href="PluginHostAdapter_8h_source.html#l00114">114</a> of file <a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a>.</p>
1288
1289 </div>
1290 </div>
1291 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1292 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1293
1294 <div class="memitem">
1295 <div class="memproto">
1296 <table class="mlabels">
1297 <tr>
1298 <td class="mlabels-left">
1299 <table class="memname">
1300 <tr>
1301 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1302 </tr>
1303 </table>
1304 </td>
1305 <td class="mlabels-right">
1306 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1307 </tr>
1308 </table>
1309 </div><div class="memdoc">
1310
1311 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">444</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
1312
1313 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
968 1314
969 </div> 1315 </div>
970 </div> 1316 </div>
971 <hr/>The documentation for this class was generated from the following file:<ul> 1317 <hr/>The documentation for this class was generated from the following file:<ul>
972 <li><a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a></li> 1318 <li><a class="el" href="PluginHostAdapter_8h_source.html">PluginHostAdapter.h</a></li>
973 </ul> 1319 </ul>
974 </div><!-- contents --> 1320 </div><!-- contents -->
975 </div> 1321 </div><!-- doc-content -->
976 <div id="nav-path" class="navpath"> 1322 <!-- start footer part -->
977 <ul> 1323 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
978 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> 1324 <ul>
979 <li class="navelem"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a> </li> 1325 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></li>
980 1326 <li class="footer">Generated by
981 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by
982 <a href="http://www.doxygen.org/index.html"> 1327 <a href="http://www.doxygen.org/index.html">
983 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1328 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
984 </ul> 1329 </ul>
985 </div> 1330 </div>
986
987
988 </body> 1331 </body>
989 </html> 1332 </html>