Mercurial > hg > vamp-docs

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: AmplitudeFollower Class Reference</title> 8 <title>VampPluginSDK: AmplitudeFollower 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('classAmplitudeFollower.html',''); 58 $(document).ready(function(){initNavTree('classAmplitudeFollower.html','');});
73 </script> 59 </script>
74 <div id="doc-content"> 60 <div id="doc-content">
75 <div class="header"> 61 <div class="header">
76 <div class="summary"> 62 <div class="summary">
77 <a href="#pub-types">Public Types</a> &#124; 63 <a href="#pub-types">Public Types</a> &#124;
78 <a href="#pub-methods">Public Member Functions</a> &#124; 64 <a href="#pub-methods">Public Member Functions</a> &#124;
79 <a href="#pro-attribs">Protected Attributes</a> </div> 65 <a href="#pro-attribs">Protected Attributes</a> &#124;
66 <a href="classAmplitudeFollower-members.html">List of all members</a> </div>
80 <div class="headertitle"> 67 <div class="headertitle">
81 <div class="title">AmplitudeFollower Class Reference</div> </div> 68 <div class="title">AmplitudeFollower Class Reference</div> </div>
82 </div><!--header--> 69 </div><!--header-->
83 <div class="contents"> 70 <div class="contents">
84 71
89 <div class="dynheader"> 76 <div class="dynheader">
90 Inheritance diagram for AmplitudeFollower:</div> 77 Inheritance diagram for AmplitudeFollower:</div>
91 <div class="dyncontent"> 78 <div class="dyncontent">
92 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div> 79 <div class="center"><img src="classAmplitudeFollower__inherit__graph.png" border="0" usemap="#AmplitudeFollower_inherit__map" alt="Inheritance graph"/></div>
93 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map"> 80 <map name="AmplitudeFollower_inherit__map" id="AmplitudeFollower_inherit__map">
94 <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="21,81,112,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="7,6,125,31"/></map> 81 <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="20,79,115,104"/>
82 <area shape="rect" id="node3" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="6,5,129,31"/>
83 </map>
95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> 84 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
96
97 <p><a href="classAmplitudeFollower-members.html">List of all members.</a></p>
98 <table class="memberdecls"> 85 <table class="memberdecls">
99 <tr><td colspan="2"><h2><a name="pub-types"></a> 86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
100 Public Types</h2></td></tr> 87 Public Types</h2></td></tr>
101 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>, 88 <tr class="memitem:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> { <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a>,
102 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> 89 <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a>
103 }</td></tr> 90 }</td></tr>
104 <tr class="memitem:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 91 <tr class="separator:a39cb7649d6dcc20e4cb1640cd55907bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 &lt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a></td></tr> 92 <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>
93 <tr class="separator:a30f531b8fb69fac41a24e3d2a6a08ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr> 94 <tr class="memitem:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a></td></tr>
107 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <br class="typebreak"/> 95 <tr class="separator:a0730bc72c87fa02eb8d2854b233f7be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr> 96 <tr class="memitem:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a></td></tr>
109 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> 97 <tr class="separator:a448fb57dc245d47923ec9eeaf9856c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 &lt; <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr> 98 <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>
99 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr> 100 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
112 <tr><td colspan="2"><h2><a name="pub-methods"></a> 101 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 </table><table class="memberdecls">
103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113 Public Member Functions</h2></td></tr> 104 Public Member Functions</h2></td></tr>
114 <tr class="memitem:a29eaeffc353da2614ae508abcd0ab63f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower</a> (float inputSampleRate)</td></tr> 105 <tr class="memitem:a29eaeffc353da2614ae508abcd0ab63f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower</a> (float inputSampleRate)</td></tr>
115 <tr class="memdesc:a29eaeffc353da2614ae508abcd0ab63f"><td class="mdescLeft">&#160;</td><td class="mdescRight">An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. <a href="#a29eaeffc353da2614ae508abcd0ab63f"></a><br/></td></tr> 106 <tr class="memdesc:a29eaeffc353da2614ae508abcd0ab63f"><td class="mdescLeft">&#160;</td><td class="mdescRight">An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. <a href="#a29eaeffc353da2614ae508abcd0ab63f">More...</a><br /></td></tr>
107 <tr class="separator:a29eaeffc353da2614ae508abcd0ab63f"><td class="memSeparator" colspan="2">&#160;</td></tr>
116 <tr class="memitem:aa78f98539ad3a1b08691a99b32035b2d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a> ()</td></tr> 108 <tr class="memitem:aa78f98539ad3a1b08691a99b32035b2d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">~AmplitudeFollower</a> ()</td></tr>
109 <tr class="separator:aa78f98539ad3a1b08691a99b32035b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <tr class="memitem:aeb727e44ee8ad1aceb90964d20f8d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 110 <tr class="memitem:aeb727e44ee8ad1aceb90964d20f8d90d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
118 <tr class="memdesc:aeb727e44ee8ad1aceb90964d20f8d90d"><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="#aeb727e44ee8ad1aceb90964d20f8d90d"></a><br/></td></tr> 111 <tr class="memdesc:aeb727e44ee8ad1aceb90964d20f8d90d"><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="#aeb727e44ee8ad1aceb90964d20f8d90d">More...</a><br /></td></tr>
112 <tr class="separator:aeb727e44ee8ad1aceb90964d20f8d90d"><td class="memSeparator" colspan="2">&#160;</td></tr>
119 <tr class="memitem:acebd835e80e84669df078fbd7591d8f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">reset</a> ()</td></tr> 113 <tr class="memitem:acebd835e80e84669df078fbd7591d8f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">reset</a> ()</td></tr>
120 <tr class="memdesc:acebd835e80e84669df078fbd7591d8f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#acebd835e80e84669df078fbd7591d8f7"></a><br/></td></tr> 114 <tr class="memdesc:acebd835e80e84669df078fbd7591d8f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#acebd835e80e84669df078fbd7591d8f7">More...</a><br /></td></tr>
121 <tr class="memitem:afc07a389b5f922b944b0350fd232d2eb"><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="classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb">getInputDomain</a> () const </td></tr> 115 <tr class="separator:acebd835e80e84669df078fbd7591d8f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
122 <tr class="memdesc:afc07a389b5f922b944b0350fd232d2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#afc07a389b5f922b944b0350fd232d2eb"></a><br/></td></tr> 116 <tr class="memitem:aa11a470900da2b800b3ab118ae81f69e"><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="classAmplitudeFollower.html#aa11a470900da2b800b3ab118ae81f69e">getInputDomain</a> () const</td></tr>
123 <tr class="memitem:afe7576af95c8fcc7f5bad42eec9f9f29"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">getIdentifier</a> () const </td></tr> 117 <tr class="memdesc:aa11a470900da2b800b3ab118ae81f69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#aa11a470900da2b800b3ab118ae81f69e">More...</a><br /></td></tr>
124 <tr class="memdesc:afe7576af95c8fcc7f5bad42eec9f9f29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#afe7576af95c8fcc7f5bad42eec9f9f29"></a><br/></td></tr> 118 <tr class="separator:aa11a470900da2b800b3ab118ae81f69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 <tr class="memitem:a7cfed00bc9d96ba6c709b69ab6a40594"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">getName</a> () const </td></tr> 119 <tr class="memitem:ad77b59b8e8bc0f415edab073f2e5edef"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ad77b59b8e8bc0f415edab073f2e5edef">getIdentifier</a> () const</td></tr>
126 <tr class="memdesc:a7cfed00bc9d96ba6c709b69ab6a40594"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a7cfed00bc9d96ba6c709b69ab6a40594"></a><br/></td></tr> 120 <tr class="memdesc:ad77b59b8e8bc0f415edab073f2e5edef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad77b59b8e8bc0f415edab073f2e5edef">More...</a><br /></td></tr>
127 <tr class="memitem:a6f0f2fea1fdb4b51e688edfe859d5062"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">getDescription</a> () const </td></tr> 121 <tr class="separator:ad77b59b8e8bc0f415edab073f2e5edef"><td class="memSeparator" colspan="2">&#160;</td></tr>
128 <tr class="memdesc:a6f0f2fea1fdb4b51e688edfe859d5062"><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="#a6f0f2fea1fdb4b51e688edfe859d5062"></a><br/></td></tr> 122 <tr class="memitem:a4a4ea5c0b2e30b420646aa78571176c2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a4a4ea5c0b2e30b420646aa78571176c2">getName</a> () const</td></tr>
129 <tr class="memitem:a44fc43838f203f58bc2ce6e3cb2b03dd"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">getMaker</a> () const </td></tr> 123 <tr class="memdesc:a4a4ea5c0b2e30b420646aa78571176c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a4a4ea5c0b2e30b420646aa78571176c2">More...</a><br /></td></tr>
130 <tr class="memdesc:a44fc43838f203f58bc2ce6e3cb2b03dd"><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="#a44fc43838f203f58bc2ce6e3cb2b03dd"></a><br/></td></tr> 124 <tr class="separator:a4a4ea5c0b2e30b420646aa78571176c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:a8a5d7a834eb996d517c51f84b2a72250"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">getPluginVersion</a> () const </td></tr> 125 <tr class="memitem:aad780ea62291ef94925d6f4d1cc3f4ac"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aad780ea62291ef94925d6f4d1cc3f4ac">getDescription</a> () const</td></tr>
132 <tr class="memdesc:a8a5d7a834eb996d517c51f84b2a72250"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a8a5d7a834eb996d517c51f84b2a72250"></a><br/></td></tr> 126 <tr class="memdesc:aad780ea62291ef94925d6f4d1cc3f4ac"><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="#aad780ea62291ef94925d6f4d1cc3f4ac">More...</a><br /></td></tr>
133 <tr class="memitem:a0c197fc90f30d91cb4403115c83c9134"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">getCopyright</a> () const </td></tr> 127 <tr class="separator:aad780ea62291ef94925d6f4d1cc3f4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
134 <tr class="memdesc:a0c197fc90f30d91cb4403115c83c9134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a0c197fc90f30d91cb4403115c83c9134"></a><br/></td></tr> 128 <tr class="memitem:ac7a9db3ec7daa0e9bd83106bbf641777"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac7a9db3ec7daa0e9bd83106bbf641777">getMaker</a> () const</td></tr>
135 <tr class="memitem:a043e3c3db77d76267cd8069e1485bf26"><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="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26">getOutputDescriptors</a> () const </td></tr> 129 <tr class="memdesc:ac7a9db3ec7daa0e9bd83106bbf641777"><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="#ac7a9db3ec7daa0e9bd83106bbf641777">More...</a><br /></td></tr>
136 <tr class="memdesc:a043e3c3db77d76267cd8069e1485bf26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a043e3c3db77d76267cd8069e1485bf26"></a><br/></td></tr> 130 <tr class="separator:ac7a9db3ec7daa0e9bd83106bbf641777"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:a9df01323a09e117bc12354ebe9244edf"><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="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">getParameterDescriptors</a> () const </td></tr> 131 <tr class="memitem:ad84e40327cb36e470790af9619e8e80e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ad84e40327cb36e470790af9619e8e80e">getPluginVersion</a> () const</td></tr>
138 <tr class="memdesc:a9df01323a09e117bc12354ebe9244edf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a9df01323a09e117bc12354ebe9244edf"></a><br/></td></tr> 132 <tr class="memdesc:ad84e40327cb36e470790af9619e8e80e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad84e40327cb36e470790af9619e8e80e">More...</a><br /></td></tr>
139 <tr class="memitem:ab278c4b6f2ca23248dc94ad775273f39"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">getParameter</a> (std::string paramid) const </td></tr> 133 <tr class="separator:ad84e40327cb36e470790af9619e8e80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memdesc:ab278c4b6f2ca23248dc94ad775273f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#ab278c4b6f2ca23248dc94ad775273f39"></a><br/></td></tr> 134 <tr class="memitem:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#acd61ab359d1b7a5514fb2e1bc191f95a">getCopyright</a> () const</td></tr>
135 <tr class="memdesc:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#acd61ab359d1b7a5514fb2e1bc191f95a">More...</a><br /></td></tr>
136 <tr class="separator:acd61ab359d1b7a5514fb2e1bc191f95a"><td class="memSeparator" colspan="2">&#160;</td></tr>
137 <tr class="memitem:a3e7f3c93c66f161e9b37e7f2aff1fe60"><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="classAmplitudeFollower.html#a3e7f3c93c66f161e9b37e7f2aff1fe60">getOutputDescriptors</a> () const</td></tr>
138 <tr class="memdesc:a3e7f3c93c66f161e9b37e7f2aff1fe60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a3e7f3c93c66f161e9b37e7f2aff1fe60">More...</a><br /></td></tr>
139 <tr class="separator:a3e7f3c93c66f161e9b37e7f2aff1fe60"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a4a707648d17d03a66b110b73b99e821b"><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="classAmplitudeFollower.html#a4a707648d17d03a66b110b73b99e821b">getParameterDescriptors</a> () const</td></tr>
141 <tr class="memdesc:a4a707648d17d03a66b110b73b99e821b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a4a707648d17d03a66b110b73b99e821b">More...</a><br /></td></tr>
142 <tr class="separator:a4a707648d17d03a66b110b73b99e821b"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a93f32b68462f46af5265327a69479c38"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a93f32b68462f46af5265327a69479c38">getParameter</a> (std::string paramid) const</td></tr>
144 <tr class="memdesc:a93f32b68462f46af5265327a69479c38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a93f32b68462f46af5265327a69479c38">More...</a><br /></td></tr>
145 <tr class="separator:a93f32b68462f46af5265327a69479c38"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:ae1fc37ece4d20e40f3066a3361a99340"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">setParameter</a> (std::string paramid, float newval)</td></tr> 146 <tr class="memitem:ae1fc37ece4d20e40f3066a3361a99340"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">setParameter</a> (std::string paramid, float newval)</td></tr>
142 <tr class="memdesc:ae1fc37ece4d20e40f3066a3361a99340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340"></a><br/></td></tr> 147 <tr class="memdesc:ae1fc37ece4d20e40f3066a3361a99340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#ae1fc37ece4d20e40f3066a3361a99340">More...</a><br /></td></tr>
148 <tr class="separator:ae1fc37ece4d20e40f3066a3361a99340"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a48d0f95cac31ffd190cff89b50a2a5bd"><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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr> 149 <tr class="memitem:a48d0f95cac31ffd190cff89b50a2a5bd"><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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
144 <tr class="memdesc:a48d0f95cac31ffd190cff89b50a2a5bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd"></a><br/></td></tr> 150 <tr class="memdesc:a48d0f95cac31ffd190cff89b50a2a5bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#a48d0f95cac31ffd190cff89b50a2a5bd">More...</a><br /></td></tr>
151 <tr class="separator:a48d0f95cac31ffd190cff89b50a2a5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:a368606f643b88e0df0823d85e36f030c"><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="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">getRemainingFeatures</a> ()</td></tr> 152 <tr class="memitem:a368606f643b88e0df0823d85e36f030c"><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="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">getRemainingFeatures</a> ()</td></tr>
146 <tr class="memdesc:a368606f643b88e0df0823d85e36f030c"><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="#a368606f643b88e0df0823d85e36f030c"></a><br/></td></tr> 153 <tr class="memdesc:a368606f643b88e0df0823d85e36f030c"><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="#a368606f643b88e0df0823d85e36f030c">More...</a><br /></td></tr>
147 <tr class="memitem:aa529adf83f87a603954eb31407602aac"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a> () const </td></tr> 154 <tr class="separator:a368606f643b88e0df0823d85e36f030c"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memdesc:aa529adf83f87a603954eb31407602aac"><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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). <a href="#aa529adf83f87a603954eb31407602aac"></a><br/></td></tr> 155 <tr class="memitem:ae3b9c32b12796ece152388babad7cc7d"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ae3b9c32b12796ece152388babad7cc7d">getPreferredBlockSize</a> () const</td></tr>
149 <tr class="memitem:a514c716c22f81c055f19b56c3f882567"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a> () const </td></tr> 156 <tr class="memdesc:ae3b9c32b12796ece152388babad7cc7d"><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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data. ">process()</a> function). <a href="#ae3b9c32b12796ece152388babad7cc7d">More...</a><br /></td></tr>
150 <tr class="memdesc:a514c716c22f81c055f19b56c3f882567"><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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. <a href="#a514c716c22f81c055f19b56c3f882567"></a><br/></td></tr> 157 <tr class="separator:ae3b9c32b12796ece152388babad7cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:a267b42e866df3cf0d190893e8096f525"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a> () const </td></tr> 158 <tr class="memitem:a33eaf9a265bc3a055e156452112456c2"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a33eaf9a265bc3a055e156452112456c2">getPreferredStepSize</a> () const</td></tr>
152 <tr class="memdesc:a267b42e866df3cf0d190893e8096f525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#a267b42e866df3cf0d190893e8096f525"></a><br/></td></tr> 159 <tr class="memdesc:a33eaf9a265bc3a055e156452112456c2"><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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data. ">process()</a> function) for the plugin. <a href="#a33eaf9a265bc3a055e156452112456c2">More...</a><br /></td></tr>
153 <tr class="memitem:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a> () const </td></tr> 160 <tr class="separator:a33eaf9a265bc3a055e156452112456c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memdesc:a2c5ab12b6fa4847cb244bd1e9cb3ae5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a><br/></td></tr> 161 <tr class="memitem:ab74f7634c6ac6e3da115667808a79c30"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#ab74f7634c6ac6e3da115667808a79c30">getMinChannelCount</a> () const</td></tr>
155 <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> 162 <tr class="memdesc:ab74f7634c6ac6e3da115667808a79c30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum supported number of input channels. <a href="#ab74f7634c6ac6e3da115667808a79c30">More...</a><br /></td></tr>
156 <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> 163 <tr class="separator:ab74f7634c6ac6e3da115667808a79c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:a8fd2c48291c64b790f0efb8948508dcf"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a> () const </td></tr> 164 <tr class="memitem:a0bff9464bc8c117470136c396b2405dd"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html#a0bff9464bc8c117470136c396b2405dd">getMaxChannelCount</a> () const</td></tr>
158 <tr class="memdesc:a8fd2c48291c64b790f0efb8948508dcf"><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="#a8fd2c48291c64b790f0efb8948508dcf"></a><br/></td></tr> 165 <tr class="memdesc:a0bff9464bc8c117470136c396b2405dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum supported number of input channels. <a href="#a0bff9464bc8c117470136c396b2405dd">More...</a><br /></td></tr>
159 <tr class="memitem:abb307c60bdb981d5f5af50c3c4ae84af"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a> () const </td></tr> 166 <tr class="separator:a0bff9464bc8c117470136c396b2405dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memdesc:abb307c60bdb981d5f5af50c3c4ae84af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#abb307c60bdb981d5f5af50c3c4ae84af"></a><br/></td></tr> 167 <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>
161 <tr class="memitem:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a> () const </td></tr> 168 <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>
162 <tr class="memdesc:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> 169 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memitem:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">getVampApiVersion</a> () const</td></tr>
171 <tr class="memdesc:ab4aa9c3e6f6dd9addbc095463c9fb772"><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="#ab4aa9c3e6f6dd9addbc095463c9fb772">More...</a><br /></td></tr>
172 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <tr class="memitem:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">getPrograms</a> () const</td></tr>
174 <tr class="memdesc:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the program settings available in this plugin. <a href="#aaf6febff0ab4daf4a5089c98a67f4df8">More...</a><br /></td></tr>
175 <tr class="separator:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <tr class="memitem:aac38c5dc6e87208616122897518ca3d5"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">getCurrentProgram</a> () const</td></tr>
177 <tr class="memdesc:aac38c5dc6e87208616122897518ca3d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#aac38c5dc6e87208616122897518ca3d5">More...</a><br /></td></tr>
178 <tr class="separator:aac38c5dc6e87208616122897518ca3d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr> 179 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
164 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> 180 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353">More...</a><br /></td></tr>
165 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 181 <tr class="separator:aadd3a547ef140bae200473a9518e3353"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 </table><table class="memberdecls">
183 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
166 Protected Attributes</h2></td></tr> 184 Protected Attributes</h2></td></tr>
167 <tr class="memitem:a959c2647fd3c5feea2591e3618774027"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a></td></tr> 185 <tr class="memitem:a959c2647fd3c5feea2591e3618774027"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">m_stepSize</a></td></tr>
186 <tr class="separator:a959c2647fd3c5feea2591e3618774027"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:ac95e8d2f334821c6c92c706bae29695a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a></td></tr> 187 <tr class="memitem:ac95e8d2f334821c6c92c706bae29695a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">m_previn</a></td></tr>
188 <tr class="separator:ac95e8d2f334821c6c92c706bae29695a"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:a1cb205b08cfe2ce94a4af05b18f72876"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a></td></tr> 189 <tr class="memitem:a1cb205b08cfe2ce94a4af05b18f72876"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">m_clampcoef</a></td></tr>
190 <tr class="separator:a1cb205b08cfe2ce94a4af05b18f72876"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memitem:aceecd3b3879f32eb4a2e597c32c41cfc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a></td></tr> 191 <tr class="memitem:aceecd3b3879f32eb4a2e597c32c41cfc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">m_relaxcoef</a></td></tr>
192 <tr class="separator:aceecd3b3879f32eb4a2e597c32c41cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <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> 193 <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>
172 </table> 194 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 195 </table>
196 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
174 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p> 197 <div class="textblock"><p>Example plugin implementing the SuperCollider amplitude follower function. </p>
175 198
176 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00047">47</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 199 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00047">47</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
177 </div><hr/><h2>Member Typedef Documentation</h2> 200 </div><h2 class="groupheader">Member Typedef Documentation</h2>
178 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 201 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
179 <div class="memitem"> 202 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
180 <div class="memproto"> 203
181 <table class="memname"> 204 <div class="memitem">
182 <tr> 205 <div class="memproto">
183 <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> 206 <table class="mlabels">
184 </tr> 207 <tr>
185 </table> 208 <td class="mlabels-left">
186 </div> 209 <table class="memname">
187 <div class="memdoc"> 210 <tr>
188 211 <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>
189 <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> 212 </tr>
190 213 </table>
191 </div> 214 </td>
192 </div> 215 <td class="mlabels-right">
193 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 216 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
194 <div class="memitem"> 217 </tr>
195 <div class="memproto"> 218 </table>
196 <table class="memname"> 219 </div><div class="memdoc">
197 <tr> 220
198 <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> 221 <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>
199 </tr> 222
200 </table> 223 </div>
201 </div> 224 </div>
202 <div class="memdoc"> 225 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
203 226 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
204 <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> 227
205 228 <div class="memitem">
206 </div> 229 <div class="memproto">
207 </div> 230 <table class="mlabels">
208 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 231 <tr>
209 <div class="memitem"> 232 <td class="mlabels-left">
210 <div class="memproto"> 233 <table class="memname">
211 <table class="memname"> 234 <tr>
212 <tr> 235 <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>
213 <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> 236 </tr>
214 </tr> 237 </table>
215 </table> 238 </td>
216 </div> 239 <td class="mlabels-right">
217 <div class="memdoc"> 240 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
218 241 </tr>
219 <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> 242 </table>
220 243 </div><div class="memdoc">
221 </div> 244
222 </div> 245 <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>
223 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 246
224 <div class="memitem"> 247 </div>
225 <div class="memproto"> 248 </div>
226 <table class="memname"> 249 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
227 <tr> 250 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
228 <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> 251
229 </tr> 252 <div class="memitem">
230 </table> 253 <div class="memproto">
231 </div> 254 <table class="mlabels">
232 <div class="memdoc"> 255 <tr>
233 256 <td class="mlabels-left">
234 <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> 257 <table class="memname">
235 258 <tr>
236 </div> 259 <td class="memname">typedef std::map&lt;int, <a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a>&gt; <a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">Vamp::Plugin::FeatureSet</a></td>
237 </div> 260 </tr>
238 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 261 </table>
239 <div class="memitem"> 262 </td>
240 <div class="memproto"> 263 <td class="mlabels-right">
241 <table class="memname"> 264 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
242 <tr> 265 </tr>
243 <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> 266 </table>
244 </tr> 267 </div><div class="memdoc">
245 </table> 268
246 </div> 269 <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>
247 <div class="memdoc"> 270
248 271 </div>
249 <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> 272 </div>
250 273 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
251 </div> 274 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
252 </div> 275
253 <hr/><h2>Member Enumeration Documentation</h2> 276 <div class="memitem">
254 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 277 <div class="memproto">
255 <div class="memitem"> 278 <table class="mlabels">
256 <div class="memproto"> 279 <tr>
257 <table class="memname"> 280 <td class="mlabels-left">
258 <tr> 281 <table class="memname">
259 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 282 <tr>
260 </tr> 283 <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>
261 </table> 284 </tr>
262 </div> 285 </table>
263 <div class="memdoc"> 286 </td>
264 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 287 <td class="mlabels-right">
265 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 288 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
266 </td></tr> 289 </tr>
267 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 290 </table>
268 </td></tr> 291 </div><div class="memdoc">
269 </table> 292
270 </dd> 293 <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>
271 </dl> 294
272 295 </div>
273 <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> 296 </div>
274 297 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
275 </div> 298 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
276 </div> 299
277 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 300 <div class="memitem">
278 <a class="anchor" id="a29eaeffc353da2614ae508abcd0ab63f"></a> 301 <div class="memproto">
279 <div class="memitem"> 302 <table class="mlabels">
280 <div class="memproto"> 303 <tr>
281 <table class="memname"> 304 <td class="mlabels-left">
282 <tr> 305 <table class="memname">
283 <td class="memname"><a class="el" href="classAmplitudeFollower.html#a29eaeffc353da2614ae508abcd0ab63f">AmplitudeFollower::AmplitudeFollower</a> </td> 306 <tr>
307 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
308 </tr>
309 </table>
310 </td>
311 <td class="mlabels-right">
312 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
313 </tr>
314 </table>
315 </div><div class="memdoc">
316
317 <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>
318
319 </div>
320 </div>
321 <h2 class="groupheader">Member Enumeration Documentation</h2>
322 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
323 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
324
325 <div class="memitem">
326 <div class="memproto">
327 <table class="mlabels">
328 <tr>
329 <td class="mlabels-left">
330 <table class="memname">
331 <tr>
332 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
333 </tr>
334 </table>
335 </td>
336 <td class="mlabels-right">
337 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
338 </tr>
339 </table>
340 </div><div class="memdoc">
341 <table class="fieldtable">
342 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
343 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
344 </table>
345
346 <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>
347
348 </div>
349 </div>
350 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
351 <a id="a29eaeffc353da2614ae508abcd0ab63f"></a>
352 <h2 class="memtitle"><span class="permalink"><a href="#a29eaeffc353da2614ae508abcd0ab63f">&#9670;&nbsp;</a></span>AmplitudeFollower()</h2>
353
354 <div class="memitem">
355 <div class="memproto">
356 <table class="memname">
357 <tr>
358 <td class="memname">AmplitudeFollower::AmplitudeFollower </td>
284 <td>(</td> 359 <td>(</td>
285 <td class="paramtype">float&#160;</td> 360 <td class="paramtype">float&#160;</td>
286 <td class="paramname"><em>inputSampleRate</em></td><td>)</td> 361 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
287 <td></td> 362 <td></td>
288 </tr> 363 </tr>
289 </table> 364 </table>
290 </div> 365 </div><div class="memdoc">
291 <div class="memdoc">
292 366
293 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p> 367 <p>An implementation of SuperCollider's amplitude-follower algorithm as a simple <a class="el" href="namespaceVamp.html">Vamp</a> plugin. </p>
294 368
295 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00055">55</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 369 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
296 370
297 </div> 371 </div>
298 </div> 372 </div>
299 <a class="anchor" id="aa78f98539ad3a1b08691a99b32035b2d"></a> 373 <a id="aa78f98539ad3a1b08691a99b32035b2d"></a>
300 <div class="memitem"> 374 <h2 class="memtitle"><span class="permalink"><a href="#aa78f98539ad3a1b08691a99b32035b2d">&#9670;&nbsp;</a></span>~AmplitudeFollower()</h2>
301 <div class="memproto"> 375
302 <table class="memname"> 376 <div class="memitem">
303 <tr> 377 <div class="memproto">
304 <td class="memname"><a class="el" href="classAmplitudeFollower.html#aa78f98539ad3a1b08691a99b32035b2d">AmplitudeFollower::~AmplitudeFollower</a> </td> 378 <table class="mlabels">
305 <td>(</td> 379 <tr>
306 <td class="paramname"></td><td>)</td> 380 <td class="mlabels-left">
307 <td><code> [virtual]</code></td> 381 <table class="memname">
308 </tr> 382 <tr>
309 </table> 383 <td class="memname">AmplitudeFollower::~AmplitudeFollower </td>
310 </div> 384 <td>(</td>
311 <div class="memdoc"> 385 <td class="paramname"></td><td>)</td>
312 386 <td></td>
313 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00064">64</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 387 </tr>
314 388 </table>
315 </div> 389 </td>
316 </div> 390 <td class="mlabels-right">
317 <hr/><h2>Member Function Documentation</h2> 391 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
318 <a class="anchor" id="aeb727e44ee8ad1aceb90964d20f8d90d"></a> 392 </tr>
319 <div class="memitem"> 393 </table>
320 <div class="memproto"> 394 </div><div class="memdoc">
321 <table class="memname"> 395
322 <tr> 396 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00065">65</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
323 <td class="memname">bool <a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d">AmplitudeFollower::initialise</a> </td> 397
398 </div>
399 </div>
400 <h2 class="groupheader">Member Function Documentation</h2>
401 <a id="aeb727e44ee8ad1aceb90964d20f8d90d"></a>
402 <h2 class="memtitle"><span class="permalink"><a href="#aeb727e44ee8ad1aceb90964d20f8d90d">&#9670;&nbsp;</a></span>initialise()</h2>
403
404 <div class="memitem">
405 <div class="memproto">
406 <table class="mlabels">
407 <tr>
408 <td class="mlabels-left">
409 <table class="memname">
410 <tr>
411 <td class="memname">bool AmplitudeFollower::initialise </td>
324 <td>(</td> 412 <td>(</td>
325 <td class="paramtype">size_t&#160;</td> 413 <td class="paramtype">size_t&#160;</td>
326 <td class="paramname"><em>inputChannels</em>, </td> 414 <td class="paramname"><em>inputChannels</em>, </td>
327 </tr> 415 </tr>
328 <tr> 416 <tr>
338 <td class="paramname"><em>blockSize</em>&#160;</td> 426 <td class="paramname"><em>blockSize</em>&#160;</td>
339 </tr> 427 </tr>
340 <tr> 428 <tr>
341 <td></td> 429 <td></td>
342 <td>)</td> 430 <td>)</td>
343 <td></td><td><code> [virtual]</code></td> 431 <td></td><td></td>
344 </tr> 432 </tr>
345 </table> 433 </table>
346 </div> 434 </td>
347 <div class="memdoc"> 435 <td class="mlabels-right">
436 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
437 </tr>
438 </table>
439 </div><div class="memdoc">
348 440
349 <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> 441 <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>
350 <p>The input sample rate should have been already specified at construction time.</p> 442 <p>The input sample rate should have been already specified at construction time.</p>
351 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> 443 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
352 444
353 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> 445 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
354 446
355 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">105</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 447 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">106</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
356 448
357 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>.</p> 449 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">Vamp::Plugin::getMaxChannelCount()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">Vamp::Plugin::getMinChannelCount()</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>.</p>
358 450
359 </div> 451 </div>
360 </div> 452 </div>
361 <a class="anchor" id="acebd835e80e84669df078fbd7591d8f7"></a> 453 <a id="acebd835e80e84669df078fbd7591d8f7"></a>
362 <div class="memitem"> 454 <h2 class="memtitle"><span class="permalink"><a href="#acebd835e80e84669df078fbd7591d8f7">&#9670;&nbsp;</a></span>reset()</h2>
363 <div class="memproto"> 455
364 <table class="memname"> 456 <div class="memitem">
365 <tr> 457 <div class="memproto">
366 <td class="memname">void <a class="el" href="classAmplitudeFollower.html#acebd835e80e84669df078fbd7591d8f7">AmplitudeFollower::reset</a> </td> 458 <table class="mlabels">
367 <td>(</td> 459 <tr>
368 <td class="paramname"></td><td>)</td> 460 <td class="mlabels-left">
369 <td><code> [virtual]</code></td> 461 <table class="memname">
370 </tr> 462 <tr>
371 </table> 463 <td class="memname">void AmplitudeFollower::reset </td>
372 </div> 464 <td>(</td>
373 <div class="memdoc"> 465 <td class="paramname"></td><td>)</td>
466 <td></td>
467 </tr>
468 </table>
469 </td>
470 <td class="mlabels-right">
471 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
472 </tr>
473 </table>
474 </div><div class="memdoc">
374 475
375 <p>Reset the plugin after use, to prepare it for another clean run. </p> 476 <p>Reset the plugin after use, to prepare it for another clean run. </p>
376 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 477 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
377 478
378 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> 479 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
379 480
380 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">122</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 481 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00123">123</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
381 482
382 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p> 483 <p class="reference">References <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>.</p>
383 484
384 </div> 485 </div>
385 </div> 486 </div>
386 <a class="anchor" id="afc07a389b5f922b944b0350fd232d2eb"></a> 487 <a id="aa11a470900da2b800b3ab118ae81f69e"></a>
387 <div class="memitem"> 488 <h2 class="memtitle"><span class="permalink"><a href="#aa11a470900da2b800b3ab118ae81f69e">&#9670;&nbsp;</a></span>getInputDomain()</h2>
388 <div class="memproto"> 489
389 <table class="memname"> 490 <div class="memitem">
390 <tr> 491 <div class="memproto">
391 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classAmplitudeFollower.html#afc07a389b5f922b944b0350fd232d2eb">AmplitudeFollower::getInputDomain</a> </td> 492 <table class="mlabels">
392 <td>(</td> 493 <tr>
393 <td class="paramname"></td><td>)</td> 494 <td class="mlabels-left">
394 <td> const<code> [inline, virtual]</code></td> 495 <table class="memname">
395 </tr> 496 <tr>
396 </table> 497 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> AmplitudeFollower::getInputDomain </td>
397 </div> 498 <td>(</td>
398 <div class="memdoc"> 499 <td class="paramname"></td><td>)</td>
500 <td> const</td>
501 </tr>
502 </table>
503 </td>
504 <td class="mlabels-right">
505 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
506 </tr>
507 </table>
508 </div><div class="memdoc">
399 509
400 <p>Get the plugin's required input domain. </p> 510 <p>Get the plugin's required input domain. </p>
401 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" 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> 511 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" 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>
402 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type -- the host will either let the user do so, or will use a Hanning window. </p> 512 <p>If this is FrequencyDomain, the host will carry out a windowed FFT of size equal to the negotiated block size on the data before passing the frequency bin data in to <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a>. The input data for the FFT will be rotated so as to place the origin in the centre of the block. The plugin does not get to choose the window type &ndash; the host will either let the user do so, or will use a Hanning window. </p>
403 513
404 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 514 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
405 515
406 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 516 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00056">56</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
407 517
408 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p> 518 <p class="reference">References <a class="el" href="AmplitudeFollower_8cpp_source.html#l00100">getCopyright()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00082">getDescription()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00070">getIdentifier()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00088">getMaker()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00076">getName()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00149">getParameterDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00094">getPluginVersion()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00244">getRemainingFeatures()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
409 519
410 </div> 520 </div>
411 </div> 521 </div>
412 <a class="anchor" id="afe7576af95c8fcc7f5bad42eec9f9f29"></a> 522 <a id="ad77b59b8e8bc0f415edab073f2e5edef"></a>
413 <div class="memitem"> 523 <h2 class="memtitle"><span class="permalink"><a href="#ad77b59b8e8bc0f415edab073f2e5edef">&#9670;&nbsp;</a></span>getIdentifier()</h2>
414 <div class="memproto"> 524
415 <table class="memname"> 525 <div class="memitem">
416 <tr> 526 <div class="memproto">
417 <td class="memname">string <a class="el" href="classAmplitudeFollower.html#afe7576af95c8fcc7f5bad42eec9f9f29">AmplitudeFollower::getIdentifier</a> </td> 527 <table class="mlabels">
418 <td>(</td> 528 <tr>
419 <td class="paramname"></td><td>)</td> 529 <td class="mlabels-left">
420 <td> const<code> [virtual]</code></td> 530 <table class="memname">
421 </tr> 531 <tr>
422 </table> 532 <td class="memname">string AmplitudeFollower::getIdentifier </td>
423 </div> 533 <td>(</td>
424 <div class="memdoc"> 534 <td class="paramname"></td><td>)</td>
535 <td> const</td>
536 </tr>
537 </table>
538 </td>
539 <td class="mlabels-right">
540 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
541 </tr>
542 </table>
543 </div><div class="memdoc">
425 544
426 <p>Get the computer-usable name of the plugin. </p> 545 <p>Get the computer-usable name of the plugin. </p>
427 <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> 546 <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>
428 <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> 547 <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>
429 <p>Example: "zero_crossings" </p> 548 <p>Example: "zero_crossings" </p>
430 549
431 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 550 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
432 551
433 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00069">69</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 552 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00070">70</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
434 553
435 </div> 554 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
436 </div> 555
437 <a class="anchor" id="a7cfed00bc9d96ba6c709b69ab6a40594"></a> 556 </div>
438 <div class="memitem"> 557 </div>
439 <div class="memproto"> 558 <a id="a4a4ea5c0b2e30b420646aa78571176c2"></a>
440 <table class="memname"> 559 <h2 class="memtitle"><span class="permalink"><a href="#a4a4ea5c0b2e30b420646aa78571176c2">&#9670;&nbsp;</a></span>getName()</h2>
441 <tr> 560
442 <td class="memname">string <a class="el" href="classAmplitudeFollower.html#a7cfed00bc9d96ba6c709b69ab6a40594">AmplitudeFollower::getName</a> </td> 561 <div class="memitem">
443 <td>(</td> 562 <div class="memproto">
444 <td class="paramname"></td><td>)</td> 563 <table class="mlabels">
445 <td> const<code> [virtual]</code></td> 564 <tr>
446 </tr> 565 <td class="mlabels-left">
447 </table> 566 <table class="memname">
448 </div> 567 <tr>
449 <div class="memdoc"> 568 <td class="memname">string AmplitudeFollower::getName </td>
569 <td>(</td>
570 <td class="paramname"></td><td>)</td>
571 <td> const</td>
572 </tr>
573 </table>
574 </td>
575 <td class="mlabels-right">
576 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
577 </tr>
578 </table>
579 </div><div class="memdoc">
450 580
451 <p>Get a human-readable name or title of the plugin. </p> 581 <p>Get a human-readable name or title of the plugin. </p>
452 <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> 582 <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>
453 <p>Example: "Zero Crossings" </p> 583 <p>Example: "Zero Crossings" </p>
454 584
455 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 585 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
456 586
457 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00075">75</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 587 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00076">76</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
458 588
459 </div> 589 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
460 </div> 590
461 <a class="anchor" id="a6f0f2fea1fdb4b51e688edfe859d5062"></a> 591 </div>
462 <div class="memitem"> 592 </div>
463 <div class="memproto"> 593 <a id="aad780ea62291ef94925d6f4d1cc3f4ac"></a>
464 <table class="memname"> 594 <h2 class="memtitle"><span class="permalink"><a href="#aad780ea62291ef94925d6f4d1cc3f4ac">&#9670;&nbsp;</a></span>getDescription()</h2>
465 <tr> 595
466 <td class="memname">string <a class="el" href="classAmplitudeFollower.html#a6f0f2fea1fdb4b51e688edfe859d5062">AmplitudeFollower::getDescription</a> </td> 596 <div class="memitem">
467 <td>(</td> 597 <div class="memproto">
468 <td class="paramname"></td><td>)</td> 598 <table class="mlabels">
469 <td> const<code> [virtual]</code></td> 599 <tr>
470 </tr> 600 <td class="mlabels-left">
471 </table> 601 <table class="memname">
472 </div> 602 <tr>
473 <div class="memdoc"> 603 <td class="memname">string AmplitudeFollower::getDescription </td>
604 <td>(</td>
605 <td class="paramname"></td><td>)</td>
606 <td> const</td>
607 </tr>
608 </table>
609 </td>
610 <td class="mlabels-right">
611 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
612 </tr>
613 </table>
614 </div><div class="memdoc">
474 615
475 <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> 616 <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>
476 <p>May be empty if the name has said it all already.</p> 617 <p>May be empty if the name has said it all already.</p>
477 <p>Example: "Detect and count zero crossing points" </p> 618 <p>Example: "Detect and count zero crossing points" </p>
478 619
479 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 620 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
480 621
481 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00081">81</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 622 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00082">82</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
482 623
483 </div> 624 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
484 </div> 625
485 <a class="anchor" id="a44fc43838f203f58bc2ce6e3cb2b03dd"></a> 626 </div>
486 <div class="memitem"> 627 </div>
487 <div class="memproto"> 628 <a id="ac7a9db3ec7daa0e9bd83106bbf641777"></a>
488 <table class="memname"> 629 <h2 class="memtitle"><span class="permalink"><a href="#ac7a9db3ec7daa0e9bd83106bbf641777">&#9670;&nbsp;</a></span>getMaker()</h2>
489 <tr> 630
490 <td class="memname">string <a class="el" href="classAmplitudeFollower.html#a44fc43838f203f58bc2ce6e3cb2b03dd">AmplitudeFollower::getMaker</a> </td> 631 <div class="memitem">
491 <td>(</td> 632 <div class="memproto">
492 <td class="paramname"></td><td>)</td> 633 <table class="mlabels">
493 <td> const<code> [virtual]</code></td> 634 <tr>
494 </tr> 635 <td class="mlabels-left">
495 </table> 636 <table class="memname">
496 </div> 637 <tr>
497 <div class="memdoc"> 638 <td class="memname">string AmplitudeFollower::getMaker </td>
639 <td>(</td>
640 <td class="paramname"></td><td>)</td>
641 <td> const</td>
642 </tr>
643 </table>
644 </td>
645 <td class="mlabels-right">
646 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
647 </tr>
648 </table>
649 </div><div class="memdoc">
498 650
499 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 651 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
500 <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> 652 <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>
501 653
502 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 654 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
503 655
504 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00087">87</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 656 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00088">88</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
505 657
506 </div> 658 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
507 </div> 659
508 <a class="anchor" id="a8a5d7a834eb996d517c51f84b2a72250"></a> 660 </div>
509 <div class="memitem"> 661 </div>
510 <div class="memproto"> 662 <a id="ad84e40327cb36e470790af9619e8e80e"></a>
511 <table class="memname"> 663 <h2 class="memtitle"><span class="permalink"><a href="#ad84e40327cb36e470790af9619e8e80e">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
512 <tr> 664
513 <td class="memname">int <a class="el" href="classAmplitudeFollower.html#a8a5d7a834eb996d517c51f84b2a72250">AmplitudeFollower::getPluginVersion</a> </td> 665 <div class="memitem">
514 <td>(</td> 666 <div class="memproto">
515 <td class="paramname"></td><td>)</td> 667 <table class="mlabels">
516 <td> const<code> [virtual]</code></td> 668 <tr>
517 </tr> 669 <td class="mlabels-left">
518 </table> 670 <table class="memname">
519 </div> 671 <tr>
520 <div class="memdoc"> 672 <td class="memname">int AmplitudeFollower::getPluginVersion </td>
673 <td>(</td>
674 <td class="paramname"></td><td>)</td>
675 <td> const</td>
676 </tr>
677 </table>
678 </td>
679 <td class="mlabels-right">
680 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
681 </tr>
682 </table>
683 </div><div class="memdoc">
521 684
522 <p>Get the version number of the plugin. </p> 685 <p>Get the version number of the plugin. </p>
523 686
524 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 687 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
525 688
526 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00093">93</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 689 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00094">94</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
527 690
528 </div> 691 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
529 </div> 692
530 <a class="anchor" id="a0c197fc90f30d91cb4403115c83c9134"></a> 693 </div>
531 <div class="memitem"> 694 </div>
532 <div class="memproto"> 695 <a id="acd61ab359d1b7a5514fb2e1bc191f95a"></a>
533 <table class="memname"> 696 <h2 class="memtitle"><span class="permalink"><a href="#acd61ab359d1b7a5514fb2e1bc191f95a">&#9670;&nbsp;</a></span>getCopyright()</h2>
534 <tr> 697
535 <td class="memname">string <a class="el" href="classAmplitudeFollower.html#a0c197fc90f30d91cb4403115c83c9134">AmplitudeFollower::getCopyright</a> </td> 698 <div class="memitem">
536 <td>(</td> 699 <div class="memproto">
537 <td class="paramname"></td><td>)</td> 700 <table class="mlabels">
538 <td> const<code> [virtual]</code></td> 701 <tr>
539 </tr> 702 <td class="mlabels-left">
540 </table> 703 <table class="memname">
541 </div> 704 <tr>
542 <div class="memdoc"> 705 <td class="memname">string AmplitudeFollower::getCopyright </td>
706 <td>(</td>
707 <td class="paramname"></td><td>)</td>
708 <td> const</td>
709 </tr>
710 </table>
711 </td>
712 <td class="mlabels-right">
713 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
714 </tr>
715 </table>
716 </div><div class="memdoc">
543 717
544 <p>Get the copyright statement or licensing summary for the plugin. </p> 718 <p>Get the copyright statement or licensing summary for the plugin. </p>
545 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 719 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
546 720
547 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 721 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
548 722
549 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00099">99</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 723 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00100">100</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
550 724
551 </div> 725 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
552 </div> 726
553 <a class="anchor" id="a043e3c3db77d76267cd8069e1485bf26"></a> 727 </div>
554 <div class="memitem"> 728 </div>
555 <div class="memproto"> 729 <a id="a3e7f3c93c66f161e9b37e7f2aff1fe60"></a>
556 <table class="memname"> 730 <h2 class="memtitle"><span class="permalink"><a href="#a3e7f3c93c66f161e9b37e7f2aff1fe60">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
557 <tr> 731
558 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> <a class="el" href="classAmplitudeFollower.html#a043e3c3db77d76267cd8069e1485bf26">AmplitudeFollower::getOutputDescriptors</a> </td> 732 <div class="memitem">
559 <td>(</td> 733 <div class="memproto">
560 <td class="paramname"></td><td>)</td> 734 <table class="mlabels">
561 <td> const<code> [virtual]</code></td> 735 <tr>
562 </tr> 736 <td class="mlabels-left">
563 </table> 737 <table class="memname">
564 </div> 738 <tr>
565 <div class="memdoc"> 739 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">AmplitudeFollower::OutputList</a> AmplitudeFollower::getOutputDescriptors </td>
740 <td>(</td>
741 <td class="paramname"></td><td>)</td>
742 <td> const</td>
743 </tr>
744 </table>
745 </td>
746 <td class="mlabels-right">
747 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
748 </tr>
749 </table>
750 </div><div class="memdoc">
566 751
567 <p>Get the outputs of this plugin. </p> 752 <p>Get the outputs of this plugin. </p>
568 <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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data.">process()</a> call. </p> 753 <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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a> call. </p>
569 754
570 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 755 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
571 756
572 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">128</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 757 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">129</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
573 758
574 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>.</p> 759 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">Vamp::Plugin::OutputDescriptor::binCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">Vamp::Plugin::OutputDescriptor::description</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">Vamp::Plugin::OutputDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">Vamp::Plugin::OutputDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">Vamp::Plugin::OutputDescriptor::name</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00290">Vamp::Plugin::OutputDescriptor::OneSamplePerStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>.</p>
575 760
576 </div> 761 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
577 </div> 762
578 <a class="anchor" id="a9df01323a09e117bc12354ebe9244edf"></a> 763 </div>
579 <div class="memitem"> 764 </div>
580 <div class="memproto"> 765 <a id="a4a707648d17d03a66b110b73b99e821b"></a>
581 <table class="memname"> 766 <h2 class="memtitle"><span class="permalink"><a href="#a4a707648d17d03a66b110b73b99e821b">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
582 <tr> 767
583 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower::getParameterDescriptors</a> </td> 768 <div class="memitem">
584 <td>(</td> 769 <div class="memproto">
585 <td class="paramname"></td><td>)</td> 770 <table class="mlabels">
586 <td> const<code> [virtual]</code></td> 771 <tr>
587 </tr> 772 <td class="mlabels-left">
588 </table> 773 <table class="memname">
589 </div> 774 <tr>
590 <div class="memdoc"> 775 <td class="memname"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">AmplitudeFollower::ParameterList</a> AmplitudeFollower::getParameterDescriptors </td>
776 <td>(</td>
777 <td class="paramname"></td><td>)</td>
778 <td> const</td>
779 </tr>
780 </table>
781 </td>
782 <td class="mlabels-right">
783 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
784 </tr>
785 </table>
786 </div><div class="memdoc">
591 787
592 <p>Get the controllable parameters of this plugin. </p> 788 <p>Get the controllable parameters of this plugin. </p>
593 789
594 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase</a>.</p> 790 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">Vamp::PluginBase</a>.</p>
595 791
596 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">148</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 792 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00149">149</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
597 793
598 <p>References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p> 794 <p class="reference">References <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00167">Vamp::PluginBase::ParameterDescriptor::defaultValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00144">Vamp::PluginBase::ParameterDescriptor::description</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00133">Vamp::PluginBase::ParameterDescriptor::identifier</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00173">Vamp::PluginBase::ParameterDescriptor::isQuantized</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00159">Vamp::PluginBase::ParameterDescriptor::maxValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00154">Vamp::PluginBase::ParameterDescriptor::minValue</a>, <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00138">Vamp::PluginBase::ParameterDescriptor::name</a>, and <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00149">Vamp::PluginBase::ParameterDescriptor::unit</a>.</p>
599 795
600 </div> 796 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
601 </div> 797
602 <a class="anchor" id="ab278c4b6f2ca23248dc94ad775273f39"></a> 798 </div>
603 <div class="memitem"> 799 </div>
604 <div class="memproto"> 800 <a id="a93f32b68462f46af5265327a69479c38"></a>
605 <table class="memname"> 801 <h2 class="memtitle"><span class="permalink"><a href="#a93f32b68462f46af5265327a69479c38">&#9670;&nbsp;</a></span>getParameter()</h2>
606 <tr> 802
607 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower::getParameter</a> </td> 803 <div class="memitem">
804 <div class="memproto">
805 <table class="mlabels">
806 <tr>
807 <td class="mlabels-left">
808 <table class="memname">
809 <tr>
810 <td class="memname">float AmplitudeFollower::getParameter </td>
608 <td>(</td> 811 <td>(</td>
609 <td class="paramtype">std::string&#160;</td> 812 <td class="paramtype">std::string&#160;</td>
610 <td class="paramname"></td><td>)</td> 813 <td class="paramname"></td><td>)</td>
611 <td> const<code> [virtual]</code></td> 814 <td> const</td>
612 </tr> 815 </tr>
613 </table> 816 </table>
614 </div> 817 </td>
615 <div class="memdoc"> 818 <td class="mlabels-right">
819 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
820 </tr>
821 </table>
822 </div><div class="memdoc">
616 823
617 <p>Get the value of a named parameter. </p> 824 <p>Get the value of a named parameter. </p>
618 <p>The argument is the identifier field from that parameter's descriptor. </p> 825 <p>The argument is the identifier field from that parameter's descriptor. </p>
619 826
620 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase</a>.</p> 827 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">Vamp::PluginBase</a>.</p>
621 828
622 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">188</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 829 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">189</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
623 830
624 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p> 831 <p class="reference">References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p>
625 832
626 </div> 833 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
627 </div> 834
628 <a class="anchor" id="ae1fc37ece4d20e40f3066a3361a99340"></a> 835 </div>
629 <div class="memitem"> 836 </div>
630 <div class="memproto"> 837 <a id="ae1fc37ece4d20e40f3066a3361a99340"></a>
631 <table class="memname"> 838 <h2 class="memtitle"><span class="permalink"><a href="#ae1fc37ece4d20e40f3066a3361a99340">&#9670;&nbsp;</a></span>setParameter()</h2>
632 <tr> 839
633 <td class="memname">void <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower::setParameter</a> </td> 840 <div class="memitem">
841 <div class="memproto">
842 <table class="mlabels">
843 <tr>
844 <td class="mlabels-left">
845 <table class="memname">
846 <tr>
847 <td class="memname">void AmplitudeFollower::setParameter </td>
634 <td>(</td> 848 <td>(</td>
635 <td class="paramtype">std::string&#160;</td> 849 <td class="paramtype">std::string&#160;</td>
636 <td class="paramname">, </td> 850 <td class="paramname">, </td>
637 </tr> 851 </tr>
638 <tr> 852 <tr>
642 <td class="paramname">&#160;</td> 856 <td class="paramname">&#160;</td>
643 </tr> 857 </tr>
644 <tr> 858 <tr>
645 <td></td> 859 <td></td>
646 <td>)</td> 860 <td>)</td>
647 <td></td><td><code> [virtual]</code></td> 861 <td></td><td></td>
648 </tr> 862 </tr>
649 </table> 863 </table>
650 </div> 864 </td>
651 <div class="memdoc"> 865 <td class="mlabels-right">
866 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
867 </tr>
868 </table>
869 </div><div class="memdoc">
652 870
653 <p>Set a named parameter. </p> 871 <p>Set a named parameter. </p>
654 <p>The first argument is the identifier field from that parameter's descriptor. </p> 872 <p>The first argument is the identifier field from that parameter's descriptor. </p>
655 873
656 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p> 874 <p>Reimplemented from <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase</a>.</p>
657 875
658 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">179</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 876 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">180</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
659 877
660 <p>References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p> 878 <p class="reference">References <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, and <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>.</p>
661 879
662 </div> 880 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
663 </div> 881
664 <a class="anchor" id="a48d0f95cac31ffd190cff89b50a2a5bd"></a> 882 </div>
665 <div class="memitem"> 883 </div>
666 <div class="memproto"> 884 <a id="a48d0f95cac31ffd190cff89b50a2a5bd"></a>
667 <table class="memname"> 885 <h2 class="memtitle"><span class="permalink"><a href="#a48d0f95cac31ffd190cff89b50a2a5bd">&#9670;&nbsp;</a></span>process()</h2>
668 <tr> 886
669 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd">AmplitudeFollower::process</a> </td> 887 <div class="memitem">
888 <div class="memproto">
889 <table class="mlabels">
890 <tr>
891 <td class="mlabels-left">
892 <table class="memname">
893 <tr>
894 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::process </td>
670 <td>(</td> 895 <td>(</td>
671 <td class="paramtype">const float *const *&#160;</td> 896 <td class="paramtype">const float *const *&#160;</td>
672 <td class="paramname"><em>inputBuffers</em>, </td> 897 <td class="paramname"><em>inputBuffers</em>, </td>
673 </tr> 898 </tr>
674 <tr> 899 <tr>
678 <td class="paramname"><em>timestamp</em>&#160;</td> 903 <td class="paramname"><em>timestamp</em>&#160;</td>
679 </tr> 904 </tr>
680 <tr> 905 <tr>
681 <td></td> 906 <td></td>
682 <td>)</td> 907 <td>)</td>
683 <td></td><td><code> [virtual]</code></td> 908 <td></td><td></td>
684 </tr> 909 </tr>
685 </table> 910 </table>
686 </div> 911 </td>
687 <div class="memdoc"> 912 <td class="mlabels-right">
913 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
914 </tr>
915 </table>
916 </div><div class="memdoc">
688 917
689 <p>Process a single block of input data. </p> 918 <p>Process a single block of input data. </p>
690 <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> 919 <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>
691 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p> 920 <p>If the plugin's inputDomain is FrequencyDomain, inputBuffers will point to one array of floats per input channel, and each of these arrays will contain blockSize/2+1 consecutive pairs of real and imaginary component floats corresponding to bins 0..(blockSize/2) of the FFT output. That is, bin 0 (the first pair of floats) contains the DC output, up to bin blockSize/2 which contains the Nyquist-frequency output. There will therefore be blockSize+2 floats per channel in total. The timestamp will be the real time in seconds of the centre of the FFT input window (i.e. the very first block passed to process might contain the FFT of half a block of zero samples and the first half-block of the actual data, with a timestamp of zero).</p>
692 <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> 921 <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>
693 922
694 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 923 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
695 924
696 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">200</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 925 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">201</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
697 926
698 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p> 927 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00079">m_clampcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00078">m_previn</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00080">m_relaxcoef</a>, <a class="el" href="AmplitudeFollower_8h_source.html#l00077">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">Vamp::Plugin::Feature::values</a>.</p>
699 928
700 </div> 929 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
701 </div> 930
702 <a class="anchor" id="a368606f643b88e0df0823d85e36f030c"></a> 931 </div>
703 <div class="memitem"> 932 </div>
704 <div class="memproto"> 933 <a id="a368606f643b88e0df0823d85e36f030c"></a>
705 <table class="memname"> 934 <h2 class="memtitle"><span class="permalink"><a href="#a368606f643b88e0df0823d85e36f030c">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
706 <tr> 935
707 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> <a class="el" href="classAmplitudeFollower.html#a368606f643b88e0df0823d85e36f030c">AmplitudeFollower::getRemainingFeatures</a> </td> 936 <div class="memitem">
708 <td>(</td> 937 <div class="memproto">
709 <td class="paramname"></td><td>)</td> 938 <table class="mlabels">
710 <td><code> [virtual]</code></td> 939 <tr>
711 </tr> 940 <td class="mlabels-left">
712 </table> 941 <table class="memname">
713 </div> 942 <tr>
714 <div class="memdoc"> 943 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">AmplitudeFollower::FeatureSet</a> AmplitudeFollower::getRemainingFeatures </td>
944 <td>(</td>
945 <td class="paramname"></td><td>)</td>
946 <td></td>
947 </tr>
948 </table>
949 </td>
950 <td class="mlabels-right">
951 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
952 </tr>
953 </table>
954 </div><div class="memdoc">
715 955
716 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 956 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
717 957
718 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 958 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
719 959
720 <p>Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00243">243</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p> 960 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8cpp_source.html#l00244">244</a> of file <a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a>.</p>
721 961
722 </div> 962 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8h_source.html#l00056">getInputDomain()</a>.</p>
723 </div> 963
724 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a> 964 </div>
725 <div class="memitem"> 965 </div>
726 <div class="memproto"> 966 <a id="ae3b9c32b12796ece152388babad7cc7d"></a>
727 <table class="memname"> 967 <h2 class="memtitle"><span class="permalink"><a href="#ae3b9c32b12796ece152388babad7cc7d">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
728 <tr> 968
729 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin::getPreferredBlockSize</a> </td> 969 <div class="memitem">
730 <td>(</td> 970 <div class="memproto">
731 <td class="paramname"></td><td>)</td> 971 <table class="mlabels">
732 <td> const<code> [inline, virtual, inherited]</code></td> 972 <tr>
733 </tr> 973 <td class="mlabels-left">
734 </table> 974 <table class="memname">
735 </div> 975 <tr>
736 <div class="memdoc"> 976 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
737 977 <td>(</td>
738 <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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function). </p> 978 <td class="paramname"></td><td>)</td>
739 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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> 979 <td> const</td>
740 <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_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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> 980 </tr>
741 981 </table>
742 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a21e45180b19873f9ab69fe7a4e184a03">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a4cf40d09d02022b1962ff17bb0324ea5">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#ad5e0ea8042bdec4dd18428991117e07a">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2c62a656313a819650656643a867ad01">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a68b8569b71504a0478caf990dbe30683">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a410c0b47c6c849d7ed9b726b84402ad0">PercussionOnsetDetector</a>.</p> 982 </td>
743 983 <td class="mlabels-right">
744 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 984 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
745 985 </tr>
746 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 986 </table>
747 987 </div><div class="memdoc">
748 </div> 988
749 </div> 989 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a> function). </p>
750 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a> 990 <p>This should be called before <a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" 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>
751 <div class="memitem"> 991 <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="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" 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>
752 <div class="memproto"> 992
753 <table class="memname"> 993 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a39dd1770dd0a737ff295d70082d86fd3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#a030b94dc3af4228a518f860952148bdd">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a9ee8ecc8406f633c68e9aa1516700332">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a94f855a2cf674ccc2e7315484f706d68">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#a9a2706b057bb269531f5c2797c42ddf4">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abacdc27486aab9b37d1a51e35e6a9444">PercussionOnsetDetector</a>.</p>
754 <tr> 994
755 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin::getPreferredStepSize</a> </td> 995 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00179">179</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
756 <td>(</td> 996
757 <td class="paramname"></td><td>)</td> 997 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
758 <td> const<code> [inline, virtual, inherited]</code></td> 998
759 </tr> 999 </div>
760 </table> 1000 </div>
761 </div> 1001 <a id="a33eaf9a265bc3a055e156452112456c2"></a>
762 <div class="memdoc"> 1002 <h2 class="memtitle"><span class="permalink"><a href="#a33eaf9a265bc3a055e156452112456c2">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
763 1003
764 <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_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> function) for the plugin. </p> 1004 <div class="memitem">
765 <p>This should be called before <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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> 1005 <div class="memproto">
766 <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_1Plugin.html#af26212cf5fc511b603a8b48034247822" 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> 1006 <table class="mlabels">
767 1007 <tr>
768 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ad979af9f1cbf2eeb16f4eaedb4a4f565">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a859ad5d59402691daed3cf1af1899ebe">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a2e66d009df69c951001e5d2786973d60">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a0137d93d7019bacc31104836fb4d352e">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ad450bb7e7df559ae3d68dfbfb085676f">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a733824891e11c306a7a678534b89b968">PercussionOnsetDetector</a>.</p> 1008 <td class="mlabels-left">
769 1009 <table class="memname">
770 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 1010 <tr>
771 1011 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
772 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1012 <td>(</td>
773 1013 <td class="paramname"></td><td>)</td>
774 </div> 1014 <td> const</td>
775 </div> 1015 </tr>
776 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a> 1016 </table>
777 <div class="memitem"> 1017 </td>
778 <div class="memproto"> 1018 <td class="mlabels-right">
779 <table class="memname"> 1019 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
780 <tr> 1020 </tr>
781 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin::getMinChannelCount</a> </td> 1021 </table>
782 <td>(</td> 1022 </div><div class="memdoc">
783 <td class="paramname"></td><td>)</td> 1023
784 <td> const<code> [inline, virtual, inherited]</code></td> 1024 <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="classAmplitudeFollower.html#a48d0f95cac31ffd190cff89b50a2a5bd" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
785 </tr> 1025 <p>This should be called before <a class="el" href="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" 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>
786 </table> 1026 <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="classAmplitudeFollower.html#aeb727e44ee8ad1aceb90964d20f8d90d" 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>
787 </div> 1027
788 <div class="memdoc"> 1028 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html#ac7b43a08f1b1f42ed871fd6962c570f4">Vamp::HostExt::PluginInputDomainAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a344c85cc017c97bf4f0f144e7d6e0f42">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#acb6b82c61ebac4610a8b92f94cd50682">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#adf2ea98d6eeb0435c0c8d7cdc29fed7c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classFixedTempoEstimator.html#ac7c25bbeeef013210f4ab808ad12b659">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a0ad851545302fc87e8226104584667a0">PercussionOnsetDetector</a>.</p>
1029
1030 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00194">194</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
1031
1032 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
1033
1034 </div>
1035 </div>
1036 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
1037 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
1038
1039 <div class="memitem">
1040 <div class="memproto">
1041 <table class="mlabels">
1042 <tr>
1043 <td class="mlabels-left">
1044 <table class="memname">
1045 <tr>
1046 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
1047 <td>(</td>
1048 <td class="paramname"></td><td>)</td>
1049 <td> const</td>
1050 </tr>
1051 </table>
1052 </td>
1053 <td class="mlabels-right">
1054 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1055 </tr>
1056 </table>
1057 </div><div class="memdoc">
789 1058
790 <p>Get the minimum supported number of input channels. </p> 1059 <p>Get the minimum supported number of input channels. </p>
791 1060
792 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a67d1198c0e58d3f0076d0eda599ff28d">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a2b28f1cf37d46a514f1e1411a6037bf8">Vamp::HostExt::PluginWrapper</a>.</p> 1061 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8e7f62e03adea0321080839f6ef6c77b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#abc0a4e6ce0ae9de39c40725de1f30d2f">Vamp::HostExt::PluginWrapper</a>.</p>
793 1062
794 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 1063 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
795 1064
796 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1065 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
797 1066
798 </div> 1067 </div>
799 </div> 1068 </div>
800 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a> 1069 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
801 <div class="memitem"> 1070 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
802 <div class="memproto"> 1071
803 <table class="memname"> 1072 <div class="memitem">
804 <tr> 1073 <div class="memproto">
805 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin::getMaxChannelCount</a> </td> 1074 <table class="mlabels">
806 <td>(</td> 1075 <tr>
807 <td class="paramname"></td><td>)</td> 1076 <td class="mlabels-left">
808 <td> const<code> [inline, virtual, inherited]</code></td> 1077 <table class="memname">
809 </tr> 1078 <tr>
810 </table> 1079 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
811 </div> 1080 <td>(</td>
812 <div class="memdoc"> 1081 <td class="paramname"></td><td>)</td>
1082 <td> const</td>
1083 </tr>
1084 </table>
1085 </td>
1086 <td class="mlabels-right">
1087 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1088 </tr>
1089 </table>
1090 </div><div class="memdoc">
813 1091
814 <p>Get the maximum supported number of input channels. </p> 1092 <p>Get the maximum supported number of input channels. </p>
815 1093
816 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a25091905e97e39d515d8ffc1a9f2b9e0">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a985eb21f1827bfbc3950d6871b107a58">Vamp::HostExt::PluginWrapper</a>.</p> 1094 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a626ad6e35eb0f4ed93bc3c6d976cdca4">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#acfed040cd91e797ee89d077db22b4a97">Vamp::HostExt::PluginWrapper</a>.</p>
817 1095
818 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> 1096 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
819 1097
820 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00265">runPlugin()</a>.</p> 1098 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00677">FixedTempoEstimator::initialise()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00113">PercussionOnsetDetector::initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">ZeroCrossing::initialise()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00092">PowerSpectrum::initialise()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
821 1099
822 </div> 1100 </div>
823 </div> 1101 </div>
824 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 1102 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
825 <div class="memitem"> 1103 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
826 <div class="memproto"> 1104
827 <table class="memname"> 1105 <div class="memitem">
828 <tr> 1106 <div class="memproto">
829 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 1107 <table class="mlabels">
830 <td>(</td> 1108 <tr>
831 <td class="paramname"></td><td>)</td> 1109 <td class="mlabels-left">
832 <td> const<code> [inline, virtual, inherited]</code></td> 1110 <table class="memname">
833 </tr> 1111 <tr>
834 </table> 1112 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
835 </div> 1113 <td>(</td>
836 <div class="memdoc"> 1114 <td class="paramname"></td><td>)</td>
837 1115 <td> const</td>
838 <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> 1116 </tr>
1117 </table>
1118 </td>
1119 <td class="mlabels-right">
1120 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1121 </tr>
1122 </table>
1123 </div><div class="memdoc">
1124
1125 <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 PluginBase. </p>
839 <p>Do not reimplement this function in your subclass. </p> 1126 <p>Do not reimplement this function in your subclass. </p>
840 1127
841 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1128 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
842 1129
843 <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> 1130 <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>
844 1131
845 </div> 1132 </div>
846 </div> 1133 </div>
847 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a> 1134 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
848 <div class="memitem"> 1135 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
849 <div class="memproto"> 1136
850 <table class="memname"> 1137 <div class="memitem">
851 <tr> 1138 <div class="memproto">
852 <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td> 1139 <table class="mlabels">
853 <td>(</td> 1140 <tr>
854 <td class="paramname"></td><td>)</td> 1141 <td class="mlabels-left">
855 <td> const<code> [inline, virtual, inherited]</code></td> 1142 <table class="memname">
856 </tr> 1143 <tr>
857 </table> 1144 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
858 </div> 1145 <td>(</td>
859 <div class="memdoc"> 1146 <td class="paramname"></td><td>)</td>
1147 <td> const</td>
1148 </tr>
1149 </table>
1150 </td>
1151 <td class="mlabels-right">
1152 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1153 </tr>
1154 </table>
1155 </div><div class="memdoc">
860 1156
861 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 1157 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
862 1158
863 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a98aadddc8403eb46c9d8c5a9d1fdd19e">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a74147fda6b44ff2169bd4a1eea0d46ff">Vamp::HostExt::PluginWrapper</a>.</p> 1159 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#adc708325d057516bd92d5ea1c0808dbc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#afa79272f991fb720ddd09784be1b3cb8">Vamp::HostExt::PluginWrapper</a>.</p>
864 1160
865 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1161 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
866 1162
867 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 1163 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
868 1164
869 </div> 1165 </div>
870 </div> 1166 </div>
871 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a> 1167 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
872 <div class="memitem"> 1168 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
873 <div class="memproto"> 1169
874 <table class="memname"> 1170 <div class="memitem">
875 <tr> 1171 <div class="memproto">
876 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> <a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">Vamp::PluginBase::getPrograms</a> </td> 1172 <table class="mlabels">
877 <td>(</td> 1173 <tr>
878 <td class="paramname"></td><td>)</td> 1174 <td class="mlabels-left">
879 <td> const<code> [inline, virtual, inherited]</code></td> 1175 <table class="memname">
880 </tr> 1176 <tr>
881 </table> 1177 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
882 </div> 1178 <td>(</td>
883 <div class="memdoc"> 1179 <td class="paramname"></td><td>)</td>
1180 <td> const</td>
1181 </tr>
1182 </table>
1183 </td>
1184 <td class="mlabels-right">
1185 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1186 </tr>
1187 </table>
1188 </div><div class="memdoc">
884 1189
885 <p>Get the program settings available in this plugin. </p> 1190 <p>Get the program settings available in this plugin. </p>
886 <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> 1191 <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>
887 <p>The programs must have unique names. </p> 1192 <p>The programs must have unique names. </p>
888 1193
889 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ae0cde5cd625418c1bc470b91f75daafc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a131fbe1df81215020b9aa8cecef4c802">Vamp::HostExt::PluginWrapper</a>.</p> 1194 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a1e3c40e9b9d8dc876d2e732976950c4b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa0b72ea17766266d20539f293ccae7c8">Vamp::HostExt::PluginWrapper</a>.</p>
890 1195
891 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00233">233</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1196 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
892 1197
893 </div> 1198 </div>
894 </div> 1199 </div>
895 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a> 1200 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
896 <div class="memitem"> 1201 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
897 <div class="memproto"> 1202
898 <table class="memname"> 1203 <div class="memitem">
899 <tr> 1204 <div class="memproto">
900 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td> 1205 <table class="mlabels">
901 <td>(</td> 1206 <tr>
902 <td class="paramname"></td><td>)</td> 1207 <td class="mlabels-left">
903 <td> const<code> [inline, virtual, inherited]</code></td> 1208 <table class="memname">
904 </tr> 1209 <tr>
905 </table> 1210 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
906 </div> 1211 <td>(</td>
907 <div class="memdoc"> 1212 <td class="paramname"></td><td>)</td>
1213 <td> const</td>
1214 </tr>
1215 </table>
1216 </td>
1217 <td class="mlabels-right">
1218 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1219 </tr>
1220 </table>
1221 </div><div class="memdoc">
908 1222
909 <p>Get the current program. </p> 1223 <p>Get the current program. </p>
910 1224
911 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a34859eff8ca8d862af39be9636ec1867">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a7a312dd42d161064b70afd7ff24c0651">Vamp::HostExt::PluginWrapper</a>.</p> 1225 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#abf984c347c4dac9e4b01123498bfe68f">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a3936fe2c4b3c960dd244849a7c3320ad">Vamp::HostExt::PluginWrapper</a>.</p>
912 1226
913 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00238">238</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1227 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
914 1228
915 </div> 1229 </div>
916 </div> 1230 </div>
917 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a> 1231 <a id="aadd3a547ef140bae200473a9518e3353"></a>
918 <div class="memitem"> 1232 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
919 <div class="memproto"> 1233
920 <table class="memname"> 1234 <div class="memitem">
921 <tr> 1235 <div class="memproto">
922 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td> 1236 <table class="mlabels">
1237 <tr>
1238 <td class="mlabels-left">
1239 <table class="memname">
1240 <tr>
1241 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
923 <td>(</td> 1242 <td>(</td>
924 <td class="paramtype">std::string&#160;</td> 1243 <td class="paramtype">std::string&#160;</td>
925 <td class="paramname"></td><td>)</td> 1244 <td class="paramname"></td><td>)</td>
926 <td><code> [inline, virtual, inherited]</code></td> 1245 <td></td>
927 </tr> 1246 </tr>
928 </table> 1247 </table>
929 </div> 1248 </td>
930 <div class="memdoc"> 1249 <td class="mlabels-right">
1250 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1251 </tr>
1252 </table>
1253 </div><div class="memdoc">
931 1254
932 <p>Select a program. </p> 1255 <p>Select a program. </p>
933 <p>(If the given program name is not one of the available programs, do nothing.) </p> 1256 <p>(If the given program name is not one of the available programs, do nothing.) </p>
934 1257
935 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p> 1258 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
936 1259
937 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00244">244</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1260 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
938 1261
939 </div> 1262 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
940 </div> 1263
941 <hr/><h2>Member Data Documentation</h2> 1264 </div>
942 <a class="anchor" id="a959c2647fd3c5feea2591e3618774027"></a> 1265 </div>
943 <div class="memitem"> 1266 <h2 class="groupheader">Member Data Documentation</h2>
944 <div class="memproto"> 1267 <a id="a959c2647fd3c5feea2591e3618774027"></a>
945 <table class="memname"> 1268 <h2 class="memtitle"><span class="permalink"><a href="#a959c2647fd3c5feea2591e3618774027">&#9670;&nbsp;</a></span>m_stepSize</h2>
946 <tr> 1269
947 <td class="memname">size_t <a class="el" href="classAmplitudeFollower.html#a959c2647fd3c5feea2591e3618774027">AmplitudeFollower::m_stepSize</a><code> [protected]</code></td> 1270 <div class="memitem">
948 </tr> 1271 <div class="memproto">
949 </table> 1272 <table class="mlabels">
950 </div> 1273 <tr>
951 <div class="memdoc"> 1274 <td class="mlabels-left">
952 1275 <table class="memname">
953 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00077">77</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 1276 <tr>
954 1277 <td class="memname">size_t AmplitudeFollower::m_stepSize</td>
955 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>.</p> 1278 </tr>
956 1279 </table>
957 </div> 1280 </td>
958 </div> 1281 <td class="mlabels-right">
959 <a class="anchor" id="ac95e8d2f334821c6c92c706bae29695a"></a> 1282 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
960 <div class="memitem"> 1283 </tr>
961 <div class="memproto"> 1284 </table>
962 <table class="memname"> 1285 </div><div class="memdoc">
963 <tr> 1286
964 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#ac95e8d2f334821c6c92c706bae29695a">AmplitudeFollower::m_previn</a><code> [protected]</code></td> 1287 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00077">77</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
965 </tr> 1288
966 </table> 1289 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>.</p>
967 </div> 1290
968 <div class="memdoc"> 1291 </div>
969 1292 </div>
970 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00078">78</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 1293 <a id="ac95e8d2f334821c6c92c706bae29695a"></a>
971 1294 <h2 class="memtitle"><span class="permalink"><a href="#ac95e8d2f334821c6c92c706bae29695a">&#9670;&nbsp;</a></span>m_previn</h2>
972 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00122">reset()</a>.</p> 1295
973 1296 <div class="memitem">
974 </div> 1297 <div class="memproto">
975 </div> 1298 <table class="mlabels">
976 <a class="anchor" id="a1cb205b08cfe2ce94a4af05b18f72876"></a> 1299 <tr>
977 <div class="memitem"> 1300 <td class="mlabels-left">
978 <div class="memproto"> 1301 <table class="memname">
979 <table class="memname"> 1302 <tr>
980 <tr> 1303 <td class="memname">float AmplitudeFollower::m_previn</td>
981 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#a1cb205b08cfe2ce94a4af05b18f72876">AmplitudeFollower::m_clampcoef</a><code> [protected]</code></td> 1304 </tr>
982 </tr> 1305 </table>
983 </table> 1306 </td>
984 </div> 1307 <td class="mlabels-right">
985 <div class="memdoc"> 1308 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
986 1309 </tr>
987 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00079">79</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 1310 </table>
988 1311 </div><div class="memdoc">
989 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p> 1312
990 1313 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00078">78</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
991 </div> 1314
992 </div> 1315 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00123">reset()</a>.</p>
993 <a class="anchor" id="aceecd3b3879f32eb4a2e597c32c41cfc"></a> 1316
994 <div class="memitem"> 1317 </div>
995 <div class="memproto"> 1318 </div>
996 <table class="memname"> 1319 <a id="a1cb205b08cfe2ce94a4af05b18f72876"></a>
997 <tr> 1320 <h2 class="memtitle"><span class="permalink"><a href="#a1cb205b08cfe2ce94a4af05b18f72876">&#9670;&nbsp;</a></span>m_clampcoef</h2>
998 <td class="memname">float <a class="el" href="classAmplitudeFollower.html#aceecd3b3879f32eb4a2e597c32c41cfc">AmplitudeFollower::m_relaxcoef</a><code> [protected]</code></td> 1321
999 </tr> 1322 <div class="memitem">
1000 </table> 1323 <div class="memproto">
1001 </div> 1324 <table class="mlabels">
1002 <div class="memdoc"> 1325 <tr>
1003 1326 <td class="mlabels-left">
1004 <p>Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00080">80</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p> 1327 <table class="memname">
1005 1328 <tr>
1006 <p>Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00188">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00179">setParameter()</a>.</p> 1329 <td class="memname">float AmplitudeFollower::m_clampcoef</td>
1007 1330 </tr>
1008 </div> 1331 </table>
1009 </div> 1332 </td>
1010 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1333 <td class="mlabels-right">
1011 <div class="memitem"> 1334 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
1012 <div class="memproto"> 1335 </tr>
1013 <table class="memname"> 1336 </table>
1014 <tr> 1337 </div><div class="memdoc">
1015 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1338
1016 </tr> 1339 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00079">79</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
1017 </table> 1340
1018 </div> 1341 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>.</p>
1019 <div class="memdoc"> 1342
1020 1343 </div>
1021 <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> 1344 </div>
1022 1345 <a id="aceecd3b3879f32eb4a2e597c32c41cfc"></a>
1023 <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">initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p> 1346 <h2 class="memtitle"><span class="permalink"><a href="#aceecd3b3879f32eb4a2e597c32c41cfc">&#9670;&nbsp;</a></span>m_relaxcoef</h2>
1347
1348 <div class="memitem">
1349 <div class="memproto">
1350 <table class="mlabels">
1351 <tr>
1352 <td class="mlabels-left">
1353 <table class="memname">
1354 <tr>
1355 <td class="memname">float AmplitudeFollower::m_relaxcoef</td>
1356 </tr>
1357 </table>
1358 </td>
1359 <td class="mlabels-right">
1360 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
1361 </tr>
1362 </table>
1363 </div><div class="memdoc">
1364
1365 <p class="definition">Definition at line <a class="el" href="AmplitudeFollower_8h_source.html#l00080">80</a> of file <a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>.</p>
1366
1367 <p class="reference">Referenced by <a class="el" href="AmplitudeFollower_8cpp_source.html#l00189">getParameter()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">initialise()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">process()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00180">setParameter()</a>.</p>
1368
1369 </div>
1370 </div>
1371 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1372 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1373
1374 <div class="memitem">
1375 <div class="memproto">
1376 <table class="mlabels">
1377 <tr>
1378 <td class="mlabels-left">
1379 <table class="memname">
1380 <tr>
1381 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1382 </tr>
1383 </table>
1384 </td>
1385 <td class="mlabels-right">
1386 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1387 </tr>
1388 </table>
1389 </div><div class="memdoc">
1390
1391 <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>
1392
1393 <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">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>
1024 1394
1025 </div> 1395 </div>
1026 </div> 1396 </div>
1027 <hr/>The documentation for this class was generated from the following files:<ul> 1397 <hr/>The documentation for this class was generated from the following files:<ul>
1028 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li> 1398 <li><a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a></li>
1029 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li> 1399 <li><a class="el" href="AmplitudeFollower_8cpp_source.html">AmplitudeFollower.cpp</a></li>
1030 </ul> 1400 </ul>
1031 </div><!-- contents --> 1401 </div><!-- contents -->
1032 </div> 1402 </div><!-- doc-content -->
1033 <div id="nav-path" class="navpath"> 1403 <!-- start footer part -->
1034 <ul> 1404 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1035 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> </li> 1405 <ul>
1036 1406 <li class="navelem"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a></li>
1037 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by 1407 <li class="footer">Generated by
1038 <a href="http://www.doxygen.org/index.html"> 1408 <a href="http://www.doxygen.org/index.html">
1039 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1409 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
1040 </ul> 1410 </ul>
1041 </div> 1411 </div>
1042
1043
1044 </body> 1412 </body>
1045 </html> 1413 </html>