Mercurial > hg > vamp-docs

comparison code-docs/classSpectralCentroid.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: SpectralCentroid Class Reference</title> 8 <title>VampPluginSDK: SpectralCentroid 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('classSpectralCentroid.html',''); 58 $(document).ready(function(){initNavTree('classSpectralCentroid.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="classSpectralCentroid-members.html">List of all members</a> </div>
80 <div class="headertitle"> 67 <div class="headertitle">
81 <div class="title">SpectralCentroid Class Reference</div> </div> 68 <div class="title">SpectralCentroid 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 SpectralCentroid:</div> 77 Inheritance diagram for SpectralCentroid:</div>
91 <div class="dyncontent"> 78 <div class="dyncontent">
92 <div class="center"><img src="classSpectralCentroid__inherit__graph.png" border="0" usemap="#SpectralCentroid_inherit__map" alt="Inheritance graph"/></div> 79 <div class="center"><img src="classSpectralCentroid__inherit__graph.png" border="0" usemap="#SpectralCentroid_inherit__map" alt="Inheritance graph"/></div>
93 <map name="SpectralCentroid_inherit__map" id="SpectralCentroid_inherit__map"> 80 <map name="SpectralCentroid_inherit__map" id="SpectralCentroid_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="18,81,109,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="5,6,123,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="19,79,114,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="5,5,128,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="classSpectralCentroid-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:a2cd801ad72f262eceb95ab0d22e7dbcd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a2cd801ad72f262eceb95ab0d22e7dbcd">SpectralCentroid</a> (float inputSampleRate)</td></tr> 105 <tr class="memitem:a2cd801ad72f262eceb95ab0d22e7dbcd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a2cd801ad72f262eceb95ab0d22e7dbcd">SpectralCentroid</a> (float inputSampleRate)</td></tr>
106 <tr class="separator:a2cd801ad72f262eceb95ab0d22e7dbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 <tr class="memitem:a483e0d6757bc3dcf61e8066f764f45c6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a483e0d6757bc3dcf61e8066f764f45c6">~SpectralCentroid</a> ()</td></tr> 107 <tr class="memitem:a483e0d6757bc3dcf61e8066f764f45c6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a483e0d6757bc3dcf61e8066f764f45c6">~SpectralCentroid</a> ()</td></tr>
108 <tr class="separator:a483e0d6757bc3dcf61e8066f764f45c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
116 <tr class="memitem:aab1ae16f5c68e2b319668f447908cedb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 109 <tr class="memitem:aab1ae16f5c68e2b319668f447908cedb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
117 <tr class="memdesc:aab1ae16f5c68e2b319668f447908cedb"><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="#aab1ae16f5c68e2b319668f447908cedb"></a><br/></td></tr> 110 <tr class="memdesc:aab1ae16f5c68e2b319668f447908cedb"><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="#aab1ae16f5c68e2b319668f447908cedb">More...</a><br /></td></tr>
111 <tr class="separator:aab1ae16f5c68e2b319668f447908cedb"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memitem:a9b5f5581691ff8f46bb7674d8d74395c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a9b5f5581691ff8f46bb7674d8d74395c">reset</a> ()</td></tr> 112 <tr class="memitem:a9b5f5581691ff8f46bb7674d8d74395c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a9b5f5581691ff8f46bb7674d8d74395c">reset</a> ()</td></tr>
119 <tr class="memdesc:a9b5f5581691ff8f46bb7674d8d74395c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9b5f5581691ff8f46bb7674d8d74395c"></a><br/></td></tr> 113 <tr class="memdesc:a9b5f5581691ff8f46bb7674d8d74395c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9b5f5581691ff8f46bb7674d8d74395c">More...</a><br /></td></tr>
120 <tr class="memitem:a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"><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="classSpectralCentroid.html#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469">getInputDomain</a> () const </td></tr> 114 <tr class="separator:a9b5f5581691ff8f46bb7674d8d74395c"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <tr class="memdesc:a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a><br/></td></tr> 115 <tr class="memitem:a4c75fd6c00f79f8074f84644b4929052"><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="classSpectralCentroid.html#a4c75fd6c00f79f8074f84644b4929052">getInputDomain</a> () const</td></tr>
122 <tr class="memitem:a1b2c4c8440c024c4c635fcef5697949f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a1b2c4c8440c024c4c635fcef5697949f">getIdentifier</a> () const </td></tr> 116 <tr class="memdesc:a4c75fd6c00f79f8074f84644b4929052"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a4c75fd6c00f79f8074f84644b4929052">More...</a><br /></td></tr>
123 <tr class="memdesc:a1b2c4c8440c024c4c635fcef5697949f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a1b2c4c8440c024c4c635fcef5697949f"></a><br/></td></tr> 117 <tr class="separator:a4c75fd6c00f79f8074f84644b4929052"><td class="memSeparator" colspan="2">&#160;</td></tr>
124 <tr class="memitem:ab7e6a620fea568af431be3cfd9dd5a41"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#ab7e6a620fea568af431be3cfd9dd5a41">getName</a> () const </td></tr> 118 <tr class="memitem:a4992d03772a228015ee2f8174f1bf06e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a4992d03772a228015ee2f8174f1bf06e">getIdentifier</a> () const</td></tr>
125 <tr class="memdesc:ab7e6a620fea568af431be3cfd9dd5a41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#ab7e6a620fea568af431be3cfd9dd5a41"></a><br/></td></tr> 119 <tr class="memdesc:a4992d03772a228015ee2f8174f1bf06e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#a4992d03772a228015ee2f8174f1bf06e">More...</a><br /></td></tr>
126 <tr class="memitem:a8fbb74a46283057d9a0b0e4718ee943c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a8fbb74a46283057d9a0b0e4718ee943c">getDescription</a> () const </td></tr> 120 <tr class="separator:a4992d03772a228015ee2f8174f1bf06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
127 <tr class="memdesc:a8fbb74a46283057d9a0b0e4718ee943c"><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="#a8fbb74a46283057d9a0b0e4718ee943c"></a><br/></td></tr> 121 <tr class="memitem:aa6236ae7400468b8d23d57f8bbb917a9"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#aa6236ae7400468b8d23d57f8bbb917a9">getName</a> () const</td></tr>
128 <tr class="memitem:ac01ff858bf67e2e93ad5d24a6ba8c8c8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#ac01ff858bf67e2e93ad5d24a6ba8c8c8">getMaker</a> () const </td></tr> 122 <tr class="memdesc:aa6236ae7400468b8d23d57f8bbb917a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#aa6236ae7400468b8d23d57f8bbb917a9">More...</a><br /></td></tr>
129 <tr class="memdesc:ac01ff858bf67e2e93ad5d24a6ba8c8c8"><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="#ac01ff858bf67e2e93ad5d24a6ba8c8c8"></a><br/></td></tr> 123 <tr class="separator:aa6236ae7400468b8d23d57f8bbb917a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:af64622e66bf678ac2b0b58aa832ca2b3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#af64622e66bf678ac2b0b58aa832ca2b3">getPluginVersion</a> () const </td></tr> 124 <tr class="memitem:ac4a840f9b3c92e0acbcc7d262e841b59"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#ac4a840f9b3c92e0acbcc7d262e841b59">getDescription</a> () const</td></tr>
131 <tr class="memdesc:af64622e66bf678ac2b0b58aa832ca2b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#af64622e66bf678ac2b0b58aa832ca2b3"></a><br/></td></tr> 125 <tr class="memdesc:ac4a840f9b3c92e0acbcc7d262e841b59"><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="#ac4a840f9b3c92e0acbcc7d262e841b59">More...</a><br /></td></tr>
132 <tr class="memitem:a925747d513d598e0fa21ed0ed6520980"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a925747d513d598e0fa21ed0ed6520980">getCopyright</a> () const </td></tr> 126 <tr class="separator:ac4a840f9b3c92e0acbcc7d262e841b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memdesc:a925747d513d598e0fa21ed0ed6520980"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#a925747d513d598e0fa21ed0ed6520980"></a><br/></td></tr> 127 <tr class="memitem:a9bab5a013a818e286eb4894f9874fee1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a9bab5a013a818e286eb4894f9874fee1">getMaker</a> () const</td></tr>
134 <tr class="memitem:a894ca9740927102bb80b56b5e9e95877"><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="classSpectralCentroid.html#a894ca9740927102bb80b56b5e9e95877">getOutputDescriptors</a> () const </td></tr> 128 <tr class="memdesc:a9bab5a013a818e286eb4894f9874fee1"><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="#a9bab5a013a818e286eb4894f9874fee1">More...</a><br /></td></tr>
135 <tr class="memdesc:a894ca9740927102bb80b56b5e9e95877"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#a894ca9740927102bb80b56b5e9e95877"></a><br/></td></tr> 129 <tr class="separator:a9bab5a013a818e286eb4894f9874fee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:a0056cd5e0615ce8766d52c0b7a92280e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a0056cd5e0615ce8766d52c0b7a92280e">getPluginVersion</a> () const</td></tr>
131 <tr class="memdesc:a0056cd5e0615ce8766d52c0b7a92280e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a0056cd5e0615ce8766d52c0b7a92280e">More...</a><br /></td></tr>
132 <tr class="separator:a0056cd5e0615ce8766d52c0b7a92280e"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:afbf8f44c5724cfc7b2b12102389f10b5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#afbf8f44c5724cfc7b2b12102389f10b5">getCopyright</a> () const</td></tr>
134 <tr class="memdesc:afbf8f44c5724cfc7b2b12102389f10b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#afbf8f44c5724cfc7b2b12102389f10b5">More...</a><br /></td></tr>
135 <tr class="separator:afbf8f44c5724cfc7b2b12102389f10b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:af77b30128e071e99d0dd374a3b2fe928"><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="classSpectralCentroid.html#af77b30128e071e99d0dd374a3b2fe928">getOutputDescriptors</a> () const</td></tr>
137 <tr class="memdesc:af77b30128e071e99d0dd374a3b2fe928"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#af77b30128e071e99d0dd374a3b2fe928">More...</a><br /></td></tr>
138 <tr class="separator:af77b30128e071e99d0dd374a3b2fe928"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:aca96c70e7e75c9e4a7db38485018914c"><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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr> 139 <tr class="memitem:aca96c70e7e75c9e4a7db38485018914c"><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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
137 <tr class="memdesc:aca96c70e7e75c9e4a7db38485018914c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#aca96c70e7e75c9e4a7db38485018914c"></a><br/></td></tr> 140 <tr class="memdesc:aca96c70e7e75c9e4a7db38485018914c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#aca96c70e7e75c9e4a7db38485018914c">More...</a><br /></td></tr>
141 <tr class="separator:aca96c70e7e75c9e4a7db38485018914c"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a83ba39f0870a2f86837605a958dfab1a"><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="classSpectralCentroid.html#a83ba39f0870a2f86837605a958dfab1a">getRemainingFeatures</a> ()</td></tr> 142 <tr class="memitem:a83ba39f0870a2f86837605a958dfab1a"><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="classSpectralCentroid.html#a83ba39f0870a2f86837605a958dfab1a">getRemainingFeatures</a> ()</td></tr>
139 <tr class="memdesc:a83ba39f0870a2f86837605a958dfab1a"><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="#a83ba39f0870a2f86837605a958dfab1a"></a><br/></td></tr> 143 <tr class="memdesc:a83ba39f0870a2f86837605a958dfab1a"><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="#a83ba39f0870a2f86837605a958dfab1a">More...</a><br /></td></tr>
140 <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> 144 <tr class="separator:a83ba39f0870a2f86837605a958dfab1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <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> 145 <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>
142 <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> 146 <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>
143 <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> 147 <tr class="separator:ae3b9c32b12796ece152388babad7cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <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> 148 <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>
145 <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> 149 <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>
146 <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> 150 <tr class="separator:a33eaf9a265bc3a055e156452112456c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <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> 151 <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>
148 <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> 152 <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>
149 <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> 153 <tr class="separator:ab74f7634c6ac6e3da115667808a79c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <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> 154 <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>
151 <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> 155 <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>
152 <tr class="memitem:aac3e49b3b66cacfbb768dfdf07444f21"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a> () const </td></tr> 156 <tr class="separator:a0bff9464bc8c117470136c396b2405dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memdesc:aac3e49b3b66cacfbb768dfdf07444f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#aac3e49b3b66cacfbb768dfdf07444f21"></a><br/></td></tr> 157 <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>
154 <tr class="memitem:a97ababcd45348ceec998d0f8e0f38bf7"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a> (std::string) const </td></tr> 158 <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>
155 <tr class="memdesc:a97ababcd45348ceec998d0f8e0f38bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#a97ababcd45348ceec998d0f8e0f38bf7"></a><br/></td></tr> 159 <tr class="separator:a530123068767a8728c568ffccfe3e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <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>
161 <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>
162 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:a0c24ff6a43c681198dc9497287a26e3a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">getParameterDescriptors</a> () const</td></tr>
164 <tr class="memdesc:a0c24ff6a43c681198dc9497287a26e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a0c24ff6a43c681198dc9497287a26e3a">More...</a><br /></td></tr>
165 <tr class="separator:a0c24ff6a43c681198dc9497287a26e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="memitem:aa813d61077080ec95487d2a0227cc51b"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">getParameter</a> (std::string) const</td></tr>
167 <tr class="memdesc:aa813d61077080ec95487d2a0227cc51b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of a named parameter. <a href="#aa813d61077080ec95487d2a0227cc51b">More...</a><br /></td></tr>
168 <tr class="separator:aa813d61077080ec95487d2a0227cc51b"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr> 169 <tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
157 <tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366"></a><br/></td></tr> 170 <tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366">More...</a><br /></td></tr>
158 <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> 171 <tr class="separator:a6c718ce822f7b73b98940d59dcaa9366"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <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> 172 <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>
160 <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> 173 <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>
161 <tr class="memdesc:a24e77eccf1bdfbbca3c79bb25e8799b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#a24e77eccf1bdfbbca3c79bb25e8799b3"></a><br/></td></tr> 174 <tr class="separator:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <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>
176 <tr class="memdesc:aac38c5dc6e87208616122897518ca3d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program. <a href="#aac38c5dc6e87208616122897518ca3d5">More...</a><br /></td></tr>
177 <tr class="separator:aac38c5dc6e87208616122897518ca3d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <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> 178 <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>
163 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353"></a><br/></td></tr> 179 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft">&#160;</td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353">More...</a><br /></td></tr>
164 <tr><td colspan="2"><h2><a name="pro-attribs"></a> 180 <tr class="separator:aadd3a547ef140bae200473a9518e3353"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 </table><table class="memberdecls">
182 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
165 Protected Attributes</h2></td></tr> 183 Protected Attributes</h2></td></tr>
166 <tr class="memitem:a49805a090ba58477da4adbefea4392a7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a49805a090ba58477da4adbefea4392a7">m_stepSize</a></td></tr> 184 <tr class="memitem:a49805a090ba58477da4adbefea4392a7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a49805a090ba58477da4adbefea4392a7">m_stepSize</a></td></tr>
185 <tr class="separator:a49805a090ba58477da4adbefea4392a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:a262f583d71b442bb2d80023e7c85aa4e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a262f583d71b442bb2d80023e7c85aa4e">m_blockSize</a></td></tr> 186 <tr class="memitem:a262f583d71b442bb2d80023e7c85aa4e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpectralCentroid.html#a262f583d71b442bb2d80023e7c85aa4e">m_blockSize</a></td></tr>
187 <tr class="separator:a262f583d71b442bb2d80023e7c85aa4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <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> 188 <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>
169 </table> 189 <tr class="separator:a59b9dd82a4f4eb946cd0474cc81abc23"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 190 </table>
191 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
171 <div class="textblock"><p>Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. </p> 192 <div class="textblock"><p>Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio. </p>
172 193
173 <p>Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00047">47</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p> 194 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00047">47</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p>
174 </div><hr/><h2>Member Typedef Documentation</h2> 195 </div><h2 class="groupheader">Member Typedef Documentation</h2>
175 <a class="anchor" id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a> 196 <a id="a30f531b8fb69fac41a24e3d2a6a08ed9"></a>
176 <div class="memitem"> 197 <h2 class="memtitle"><span class="permalink"><a href="#a30f531b8fb69fac41a24e3d2a6a08ed9">&#9670;&nbsp;</a></span>OutputList</h2>
177 <div class="memproto"> 198
178 <table class="memname"> 199 <div class="memitem">
179 <tr> 200 <div class="memproto">
180 <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> 201 <table class="mlabels">
181 </tr> 202 <tr>
182 </table> 203 <td class="mlabels-left">
183 </div> 204 <table class="memname">
184 <div class="memdoc"> 205 <tr>
185 206 <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>
186 <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> 207 </tr>
187 208 </table>
188 </div> 209 </td>
189 </div> 210 <td class="mlabels-right">
190 <a class="anchor" id="a0730bc72c87fa02eb8d2854b233f7be1"></a> 211 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
191 <div class="memitem"> 212 </tr>
192 <div class="memproto"> 213 </table>
193 <table class="memname"> 214 </div><div class="memdoc">
194 <tr> 215
195 <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> 216 <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>
196 </tr> 217
197 </table> 218 </div>
198 </div> 219 </div>
199 <div class="memdoc"> 220 <a id="a0730bc72c87fa02eb8d2854b233f7be1"></a>
200 221 <h2 class="memtitle"><span class="permalink"><a href="#a0730bc72c87fa02eb8d2854b233f7be1">&#9670;&nbsp;</a></span>FeatureList</h2>
201 <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> 222
202 223 <div class="memitem">
203 </div> 224 <div class="memproto">
204 </div> 225 <table class="mlabels">
205 <a class="anchor" id="a448fb57dc245d47923ec9eeaf9856c5f"></a> 226 <tr>
206 <div class="memitem"> 227 <td class="mlabels-left">
207 <div class="memproto"> 228 <table class="memname">
208 <table class="memname"> 229 <tr>
209 <tr> 230 <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>
210 <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> 231 </tr>
211 </tr> 232 </table>
212 </table> 233 </td>
213 </div> 234 <td class="mlabels-right">
214 <div class="memdoc"> 235 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
215 236 </tr>
216 <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> 237 </table>
217 238 </div><div class="memdoc">
218 </div> 239
219 </div> 240 <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>
220 <a class="anchor" id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a> 241
221 <div class="memitem"> 242 </div>
222 <div class="memproto"> 243 </div>
223 <table class="memname"> 244 <a id="a448fb57dc245d47923ec9eeaf9856c5f"></a>
224 <tr> 245 <h2 class="memtitle"><span class="permalink"><a href="#a448fb57dc245d47923ec9eeaf9856c5f">&#9670;&nbsp;</a></span>FeatureSet</h2>
225 <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> 246
226 </tr> 247 <div class="memitem">
227 </table> 248 <div class="memproto">
228 </div> 249 <table class="mlabels">
229 <div class="memdoc"> 250 <tr>
230 251 <td class="mlabels-left">
231 <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> 252 <table class="memname">
232 253 <tr>
233 </div> 254 <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>
234 </div> 255 </tr>
235 <a class="anchor" id="a7f66f00437b21e5f694fe02356b12f20"></a> 256 </table>
236 <div class="memitem"> 257 </td>
237 <div class="memproto"> 258 <td class="mlabels-right">
238 <table class="memname"> 259 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
239 <tr> 260 </tr>
240 <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> 261 </table>
241 </tr> 262 </div><div class="memdoc">
242 </table> 263
243 </div> 264 <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>
244 <div class="memdoc"> 265
245 266 </div>
246 <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> 267 </div>
247 268 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
248 </div> 269 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">&#9670;&nbsp;</a></span>ParameterList</h2>
249 </div> 270
250 <hr/><h2>Member Enumeration Documentation</h2> 271 <div class="memitem">
251 <a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bc"></a> 272 <div class="memproto">
252 <div class="memitem"> 273 <table class="mlabels">
253 <div class="memproto"> 274 <tr>
254 <table class="memname"> 275 <td class="mlabels-left">
255 <tr> 276 <table class="memname">
256 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a><code> [inherited]</code></td> 277 <tr>
257 </tr> 278 <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>
258 </table> 279 </tr>
259 </div> 280 </table>
260 <div class="memdoc"> 281 </td>
261 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 282 <td class="mlabels-right">
262 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain</em>&nbsp;</td><td> 283 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
263 </td></tr> 284 </tr>
264 <tr><td valign="top"><em><a class="anchor" id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain</em>&nbsp;</td><td> 285 </table>
265 </td></tr> 286 </div><div class="memdoc">
266 </table> 287
267 </dd> 288 <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>
268 </dl> 289
269 290 </div>
270 <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> 291 </div>
271 292 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
272 </div> 293 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">&#9670;&nbsp;</a></span>ProgramList</h2>
273 </div> 294
274 <hr/><h2>Constructor &amp; Destructor Documentation</h2> 295 <div class="memitem">
275 <a class="anchor" id="a2cd801ad72f262eceb95ab0d22e7dbcd"></a> 296 <div class="memproto">
276 <div class="memitem"> 297 <table class="mlabels">
277 <div class="memproto"> 298 <tr>
278 <table class="memname"> 299 <td class="mlabels-left">
279 <tr> 300 <table class="memname">
280 <td class="memname"><a class="el" href="classSpectralCentroid.html#a2cd801ad72f262eceb95ab0d22e7dbcd">SpectralCentroid::SpectralCentroid</a> </td> 301 <tr>
302 <td class="memname">typedef std::vector&lt;std::string&gt; <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
303 </tr>
304 </table>
305 </td>
306 <td class="mlabels-right">
307 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
308 </tr>
309 </table>
310 </div><div class="memdoc">
311
312 <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>
313
314 </div>
315 </div>
316 <h2 class="groupheader">Member Enumeration Documentation</h2>
317 <a id="a39cb7649d6dcc20e4cb1640cd55907bc"></a>
318 <h2 class="memtitle"><span class="permalink"><a href="#a39cb7649d6dcc20e4cb1640cd55907bc">&#9670;&nbsp;</a></span>InputDomain</h2>
319
320 <div class="memitem">
321 <div class="memproto">
322 <table class="mlabels">
323 <tr>
324 <td class="mlabels-left">
325 <table class="memname">
326 <tr>
327 <td class="memname">enum <a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">Vamp::Plugin::InputDomain</a></td>
328 </tr>
329 </table>
330 </td>
331 <td class="mlabels-right">
332 <span class="mlabels"><span class="mlabel">inherited</span></span> </td>
333 </tr>
334 </table>
335 </div><div class="memdoc">
336 <table class="fieldtable">
337 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff"></a>TimeDomain&#160;</td><td class="fielddoc"></td></tr>
338 <tr><td class="fieldname"><a id="a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53"></a>FrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
339 </table>
340
341 <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>
342
343 </div>
344 </div>
345 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
346 <a id="a2cd801ad72f262eceb95ab0d22e7dbcd"></a>
347 <h2 class="memtitle"><span class="permalink"><a href="#a2cd801ad72f262eceb95ab0d22e7dbcd">&#9670;&nbsp;</a></span>SpectralCentroid()</h2>
348
349 <div class="memitem">
350 <div class="memproto">
351 <table class="memname">
352 <tr>
353 <td class="memname">SpectralCentroid::SpectralCentroid </td>
281 <td>(</td> 354 <td>(</td>
282 <td class="paramtype">float&#160;</td> 355 <td class="paramtype">float&#160;</td>
283 <td class="paramname"><em>inputSampleRate</em></td><td>)</td> 356 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
284 <td></td> 357 <td></td>
285 </tr> 358 </tr>
286 </table> 359 </table>
287 </div> 360 </div><div class="memdoc">
288 <div class="memdoc"> 361
289 362 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00056">56</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
290 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00056">56</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 363
291 364 </div>
292 </div> 365 </div>
293 </div> 366 <a id="a483e0d6757bc3dcf61e8066f764f45c6"></a>
294 <a class="anchor" id="a483e0d6757bc3dcf61e8066f764f45c6"></a> 367 <h2 class="memtitle"><span class="permalink"><a href="#a483e0d6757bc3dcf61e8066f764f45c6">&#9670;&nbsp;</a></span>~SpectralCentroid()</h2>
295 <div class="memitem"> 368
296 <div class="memproto"> 369 <div class="memitem">
297 <table class="memname"> 370 <div class="memproto">
298 <tr> 371 <table class="mlabels">
299 <td class="memname"><a class="el" href="classSpectralCentroid.html#a483e0d6757bc3dcf61e8066f764f45c6">SpectralCentroid::~SpectralCentroid</a> </td> 372 <tr>
300 <td>(</td> 373 <td class="mlabels-left">
301 <td class="paramname"></td><td>)</td> 374 <table class="memname">
302 <td><code> [virtual]</code></td> 375 <tr>
303 </tr> 376 <td class="memname">SpectralCentroid::~SpectralCentroid </td>
304 </table> 377 <td>(</td>
305 </div> 378 <td class="paramname"></td><td>)</td>
306 <div class="memdoc"> 379 <td></td>
307 380 </tr>
308 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00063">63</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 381 </table>
309 382 </td>
310 </div> 383 <td class="mlabels-right">
311 </div> 384 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
312 <hr/><h2>Member Function Documentation</h2> 385 </tr>
313 <a class="anchor" id="aab1ae16f5c68e2b319668f447908cedb"></a> 386 </table>
314 <div class="memitem"> 387 </div><div class="memdoc">
315 <div class="memproto"> 388
316 <table class="memname"> 389 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00063">63</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
317 <tr> 390
318 <td class="memname">bool <a class="el" href="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb">SpectralCentroid::initialise</a> </td> 391 </div>
392 </div>
393 <h2 class="groupheader">Member Function Documentation</h2>
394 <a id="aab1ae16f5c68e2b319668f447908cedb"></a>
395 <h2 class="memtitle"><span class="permalink"><a href="#aab1ae16f5c68e2b319668f447908cedb">&#9670;&nbsp;</a></span>initialise()</h2>
396
397 <div class="memitem">
398 <div class="memproto">
399 <table class="mlabels">
400 <tr>
401 <td class="mlabels-left">
402 <table class="memname">
403 <tr>
404 <td class="memname">bool SpectralCentroid::initialise </td>
319 <td>(</td> 405 <td>(</td>
320 <td class="paramtype">size_t&#160;</td> 406 <td class="paramtype">size_t&#160;</td>
321 <td class="paramname"><em>inputChannels</em>, </td> 407 <td class="paramname"><em>inputChannels</em>, </td>
322 </tr> 408 </tr>
323 <tr> 409 <tr>
333 <td class="paramname"><em>blockSize</em>&#160;</td> 419 <td class="paramname"><em>blockSize</em>&#160;</td>
334 </tr> 420 </tr>
335 <tr> 421 <tr>
336 <td></td> 422 <td></td>
337 <td>)</td> 423 <td>)</td>
338 <td></td><td><code> [virtual]</code></td> 424 <td></td><td></td>
339 </tr> 425 </tr>
340 </table> 426 </table>
341 </div> 427 </td>
342 <div class="memdoc"> 428 <td class="mlabels-right">
429 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
430 </tr>
431 </table>
432 </div><div class="memdoc">
343 433
344 <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> 434 <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>
345 <p>The input sample rate should have been already specified at construction time.</p> 435 <p>The input sample rate should have been already specified at construction time.</p>
346 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p> 436 <p>Return true for successful initialisation, false if the number of input channels, step size and/or block size cannot be supported. </p>
347 437
348 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p> 438 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">Vamp::Plugin</a>.</p>
349 439
350 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">104</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 440 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">104</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
351 441
352 <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="SpectralCentroid_8h_source.html#l00074">m_blockSize</a>, and <a class="el" href="SpectralCentroid_8h_source.html#l00073">m_stepSize</a>.</p> 442 <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="SpectralCentroid_8h_source.html#l00074">m_blockSize</a>, and <a class="el" href="SpectralCentroid_8h_source.html#l00073">m_stepSize</a>.</p>
353 443
354 </div> 444 </div>
355 </div> 445 </div>
356 <a class="anchor" id="a9b5f5581691ff8f46bb7674d8d74395c"></a> 446 <a id="a9b5f5581691ff8f46bb7674d8d74395c"></a>
357 <div class="memitem"> 447 <h2 class="memtitle"><span class="permalink"><a href="#a9b5f5581691ff8f46bb7674d8d74395c">&#9670;&nbsp;</a></span>reset()</h2>
358 <div class="memproto"> 448
359 <table class="memname"> 449 <div class="memitem">
360 <tr> 450 <div class="memproto">
361 <td class="memname">void <a class="el" href="classSpectralCentroid.html#a9b5f5581691ff8f46bb7674d8d74395c">SpectralCentroid::reset</a> </td> 451 <table class="mlabels">
362 <td>(</td> 452 <tr>
363 <td class="paramname"></td><td>)</td> 453 <td class="mlabels-left">
364 <td><code> [virtual]</code></td> 454 <table class="memname">
365 </tr> 455 <tr>
366 </table> 456 <td class="memname">void SpectralCentroid::reset </td>
367 </div> 457 <td>(</td>
368 <div class="memdoc"> 458 <td class="paramname"></td><td>)</td>
459 <td></td>
460 </tr>
461 </table>
462 </td>
463 <td class="mlabels-right">
464 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
465 </tr>
466 </table>
467 </div><div class="memdoc">
369 468
370 <p>Reset the plugin after use, to prepare it for another clean run. </p> 469 <p>Reset the plugin after use, to prepare it for another clean run. </p>
371 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p> 470 <p>Not called for the first initialisation (i.e. initialise must also do a reset). </p>
372 471
373 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p> 472 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">Vamp::Plugin</a>.</p>
374 473
375 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00116">116</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 474 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00116">116</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
376 475
377 </div> 476 </div>
378 </div> 477 </div>
379 <a class="anchor" id="a0ec2cb74c1c5f6e57d0bd9dcf7c8f469"></a> 478 <a id="a4c75fd6c00f79f8074f84644b4929052"></a>
380 <div class="memitem"> 479 <h2 class="memtitle"><span class="permalink"><a href="#a4c75fd6c00f79f8074f84644b4929052">&#9670;&nbsp;</a></span>getInputDomain()</h2>
381 <div class="memproto"> 480
382 <table class="memname"> 481 <div class="memitem">
383 <tr> 482 <div class="memproto">
384 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classSpectralCentroid.html#a0ec2cb74c1c5f6e57d0bd9dcf7c8f469">SpectralCentroid::getInputDomain</a> </td> 483 <table class="mlabels">
385 <td>(</td> 484 <tr>
386 <td class="paramname"></td><td>)</td> 485 <td class="mlabels-left">
387 <td> const<code> [inline, virtual]</code></td> 486 <table class="memname">
388 </tr> 487 <tr>
389 </table> 488 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> SpectralCentroid::getInputDomain </td>
390 </div> 489 <td>(</td>
391 <div class="memdoc"> 490 <td class="paramname"></td><td>)</td>
491 <td> const</td>
492 </tr>
493 </table>
494 </td>
495 <td class="mlabels-right">
496 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
497 </tr>
498 </table>
499 </div><div class="memdoc">
392 500
393 <p>Get the plugin's required input domain. </p> 501 <p>Get the plugin's required input domain. </p>
394 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" 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> 502 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" 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>
395 <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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" 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> 503 <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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" 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>
396 504
397 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 505 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
398 506
399 <p>Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00056">56</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p> 507 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00056">56</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p>
400 508
401 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>.</p> 509 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::FrequencyDomain</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00098">getCopyright()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00080">getDescription()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00068">getIdentifier()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00086">getMaker()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00074">getName()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00092">getPluginVersion()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00192">getRemainingFeatures()</a>, and <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">process()</a>.</p>
402 510
403 </div> 511 </div>
404 </div> 512 </div>
405 <a class="anchor" id="a1b2c4c8440c024c4c635fcef5697949f"></a> 513 <a id="a4992d03772a228015ee2f8174f1bf06e"></a>
406 <div class="memitem"> 514 <h2 class="memtitle"><span class="permalink"><a href="#a4992d03772a228015ee2f8174f1bf06e">&#9670;&nbsp;</a></span>getIdentifier()</h2>
407 <div class="memproto"> 515
408 <table class="memname"> 516 <div class="memitem">
409 <tr> 517 <div class="memproto">
410 <td class="memname">string <a class="el" href="classSpectralCentroid.html#a1b2c4c8440c024c4c635fcef5697949f">SpectralCentroid::getIdentifier</a> </td> 518 <table class="mlabels">
411 <td>(</td> 519 <tr>
412 <td class="paramname"></td><td>)</td> 520 <td class="mlabels-left">
413 <td> const<code> [virtual]</code></td> 521 <table class="memname">
414 </tr> 522 <tr>
415 </table> 523 <td class="memname">string SpectralCentroid::getIdentifier </td>
416 </div> 524 <td>(</td>
417 <div class="memdoc"> 525 <td class="paramname"></td><td>)</td>
526 <td> const</td>
527 </tr>
528 </table>
529 </td>
530 <td class="mlabels-right">
531 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
532 </tr>
533 </table>
534 </div><div class="memdoc">
418 535
419 <p>Get the computer-usable name of the plugin. </p> 536 <p>Get the computer-usable name of the plugin. </p>
420 <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> 537 <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>
421 <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> 538 <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>
422 <p>Example: "zero_crossings" </p> 539 <p>Example: "zero_crossings" </p>
423 540
424 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 541 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
425 542
426 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00068">68</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 543 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00068">68</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
427 544
428 </div> 545 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
429 </div> 546
430 <a class="anchor" id="ab7e6a620fea568af431be3cfd9dd5a41"></a> 547 </div>
431 <div class="memitem"> 548 </div>
432 <div class="memproto"> 549 <a id="aa6236ae7400468b8d23d57f8bbb917a9"></a>
433 <table class="memname"> 550 <h2 class="memtitle"><span class="permalink"><a href="#aa6236ae7400468b8d23d57f8bbb917a9">&#9670;&nbsp;</a></span>getName()</h2>
434 <tr> 551
435 <td class="memname">string <a class="el" href="classSpectralCentroid.html#ab7e6a620fea568af431be3cfd9dd5a41">SpectralCentroid::getName</a> </td> 552 <div class="memitem">
436 <td>(</td> 553 <div class="memproto">
437 <td class="paramname"></td><td>)</td> 554 <table class="mlabels">
438 <td> const<code> [virtual]</code></td> 555 <tr>
439 </tr> 556 <td class="mlabels-left">
440 </table> 557 <table class="memname">
441 </div> 558 <tr>
442 <div class="memdoc"> 559 <td class="memname">string SpectralCentroid::getName </td>
560 <td>(</td>
561 <td class="paramname"></td><td>)</td>
562 <td> const</td>
563 </tr>
564 </table>
565 </td>
566 <td class="mlabels-right">
567 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
568 </tr>
569 </table>
570 </div><div class="memdoc">
443 571
444 <p>Get a human-readable name or title of the plugin. </p> 572 <p>Get a human-readable name or title of the plugin. </p>
445 <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> 573 <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>
446 <p>Example: "Zero Crossings" </p> 574 <p>Example: "Zero Crossings" </p>
447 575
448 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 576 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
449 577
450 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00074">74</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 578 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00074">74</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
451 579
452 </div> 580 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
453 </div> 581
454 <a class="anchor" id="a8fbb74a46283057d9a0b0e4718ee943c"></a> 582 </div>
455 <div class="memitem"> 583 </div>
456 <div class="memproto"> 584 <a id="ac4a840f9b3c92e0acbcc7d262e841b59"></a>
457 <table class="memname"> 585 <h2 class="memtitle"><span class="permalink"><a href="#ac4a840f9b3c92e0acbcc7d262e841b59">&#9670;&nbsp;</a></span>getDescription()</h2>
458 <tr> 586
459 <td class="memname">string <a class="el" href="classSpectralCentroid.html#a8fbb74a46283057d9a0b0e4718ee943c">SpectralCentroid::getDescription</a> </td> 587 <div class="memitem">
460 <td>(</td> 588 <div class="memproto">
461 <td class="paramname"></td><td>)</td> 589 <table class="mlabels">
462 <td> const<code> [virtual]</code></td> 590 <tr>
463 </tr> 591 <td class="mlabels-left">
464 </table> 592 <table class="memname">
465 </div> 593 <tr>
466 <div class="memdoc"> 594 <td class="memname">string SpectralCentroid::getDescription </td>
595 <td>(</td>
596 <td class="paramname"></td><td>)</td>
597 <td> const</td>
598 </tr>
599 </table>
600 </td>
601 <td class="mlabels-right">
602 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
603 </tr>
604 </table>
605 </div><div class="memdoc">
467 606
468 <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> 607 <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>
469 <p>May be empty if the name has said it all already.</p> 608 <p>May be empty if the name has said it all already.</p>
470 <p>Example: "Detect and count zero crossing points" </p> 609 <p>Example: "Detect and count zero crossing points" </p>
471 610
472 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 611 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
473 612
474 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00080">80</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 613 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00080">80</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
475 614
476 </div> 615 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
477 </div> 616
478 <a class="anchor" id="ac01ff858bf67e2e93ad5d24a6ba8c8c8"></a> 617 </div>
479 <div class="memitem"> 618 </div>
480 <div class="memproto"> 619 <a id="a9bab5a013a818e286eb4894f9874fee1"></a>
481 <table class="memname"> 620 <h2 class="memtitle"><span class="permalink"><a href="#a9bab5a013a818e286eb4894f9874fee1">&#9670;&nbsp;</a></span>getMaker()</h2>
482 <tr> 621
483 <td class="memname">string <a class="el" href="classSpectralCentroid.html#ac01ff858bf67e2e93ad5d24a6ba8c8c8">SpectralCentroid::getMaker</a> </td> 622 <div class="memitem">
484 <td>(</td> 623 <div class="memproto">
485 <td class="paramname"></td><td>)</td> 624 <table class="mlabels">
486 <td> const<code> [virtual]</code></td> 625 <tr>
487 </tr> 626 <td class="mlabels-left">
488 </table> 627 <table class="memname">
489 </div> 628 <tr>
490 <div class="memdoc"> 629 <td class="memname">string SpectralCentroid::getMaker </td>
630 <td>(</td>
631 <td class="paramname"></td><td>)</td>
632 <td> const</td>
633 </tr>
634 </table>
635 </td>
636 <td class="mlabels-right">
637 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
638 </tr>
639 </table>
640 </div><div class="memdoc">
491 641
492 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 642 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
493 <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> 643 <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>
494 644
495 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 645 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
496 646
497 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00086">86</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 647 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00086">86</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
498 648
499 </div> 649 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
500 </div> 650
501 <a class="anchor" id="af64622e66bf678ac2b0b58aa832ca2b3"></a> 651 </div>
502 <div class="memitem"> 652 </div>
503 <div class="memproto"> 653 <a id="a0056cd5e0615ce8766d52c0b7a92280e"></a>
504 <table class="memname"> 654 <h2 class="memtitle"><span class="permalink"><a href="#a0056cd5e0615ce8766d52c0b7a92280e">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
505 <tr> 655
506 <td class="memname">int <a class="el" href="classSpectralCentroid.html#af64622e66bf678ac2b0b58aa832ca2b3">SpectralCentroid::getPluginVersion</a> </td> 656 <div class="memitem">
507 <td>(</td> 657 <div class="memproto">
508 <td class="paramname"></td><td>)</td> 658 <table class="mlabels">
509 <td> const<code> [virtual]</code></td> 659 <tr>
510 </tr> 660 <td class="mlabels-left">
511 </table> 661 <table class="memname">
512 </div> 662 <tr>
513 <div class="memdoc"> 663 <td class="memname">int SpectralCentroid::getPluginVersion </td>
664 <td>(</td>
665 <td class="paramname"></td><td>)</td>
666 <td> const</td>
667 </tr>
668 </table>
669 </td>
670 <td class="mlabels-right">
671 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
672 </tr>
673 </table>
674 </div><div class="memdoc">
514 675
515 <p>Get the version number of the plugin. </p> 676 <p>Get the version number of the plugin. </p>
516 677
517 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 678 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
518 679
519 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00092">92</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 680 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00092">92</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
520 681
521 </div> 682 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
522 </div> 683
523 <a class="anchor" id="a925747d513d598e0fa21ed0ed6520980"></a> 684 </div>
524 <div class="memitem"> 685 </div>
525 <div class="memproto"> 686 <a id="afbf8f44c5724cfc7b2b12102389f10b5"></a>
526 <table class="memname"> 687 <h2 class="memtitle"><span class="permalink"><a href="#afbf8f44c5724cfc7b2b12102389f10b5">&#9670;&nbsp;</a></span>getCopyright()</h2>
527 <tr> 688
528 <td class="memname">string <a class="el" href="classSpectralCentroid.html#a925747d513d598e0fa21ed0ed6520980">SpectralCentroid::getCopyright</a> </td> 689 <div class="memitem">
529 <td>(</td> 690 <div class="memproto">
530 <td class="paramname"></td><td>)</td> 691 <table class="mlabels">
531 <td> const<code> [virtual]</code></td> 692 <tr>
532 </tr> 693 <td class="mlabels-left">
533 </table> 694 <table class="memname">
534 </div> 695 <tr>
535 <div class="memdoc"> 696 <td class="memname">string SpectralCentroid::getCopyright </td>
697 <td>(</td>
698 <td class="paramname"></td><td>)</td>
699 <td> const</td>
700 </tr>
701 </table>
702 </td>
703 <td class="mlabels-right">
704 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
705 </tr>
706 </table>
707 </div><div class="memdoc">
536 708
537 <p>Get the copyright statement or licensing summary for the plugin. </p> 709 <p>Get the copyright statement or licensing summary for the plugin. </p>
538 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 710 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
539 711
540 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 712 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
541 713
542 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00098">98</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 714 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00098">98</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
543 715
544 </div> 716 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
545 </div> 717
546 <a class="anchor" id="a894ca9740927102bb80b56b5e9e95877"></a> 718 </div>
547 <div class="memitem"> 719 </div>
548 <div class="memproto"> 720 <a id="af77b30128e071e99d0dd374a3b2fe928"></a>
549 <table class="memname"> 721 <h2 class="memtitle"><span class="permalink"><a href="#af77b30128e071e99d0dd374a3b2fe928">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
550 <tr> 722
551 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">SpectralCentroid::OutputList</a> <a class="el" href="classSpectralCentroid.html#a894ca9740927102bb80b56b5e9e95877">SpectralCentroid::getOutputDescriptors</a> </td> 723 <div class="memitem">
552 <td>(</td> 724 <div class="memproto">
553 <td class="paramname"></td><td>)</td> 725 <table class="mlabels">
554 <td> const<code> [virtual]</code></td> 726 <tr>
555 </tr> 727 <td class="mlabels-left">
556 </table> 728 <table class="memname">
557 </div> 729 <tr>
558 <div class="memdoc"> 730 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">SpectralCentroid::OutputList</a> SpectralCentroid::getOutputDescriptors </td>
731 <td>(</td>
732 <td class="paramname"></td><td>)</td>
733 <td> const</td>
734 </tr>
735 </table>
736 </td>
737 <td class="mlabels-right">
738 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
739 </tr>
740 </table>
741 </div><div class="memdoc">
559 742
560 <p>Get the outputs of this plugin. </p> 743 <p>Get the outputs of this plugin. </p>
561 <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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" title="Process a single block of input data.">process()</a> call. </p> 744 <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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" title="Process a single block of input data. ">process()</a> call. </p>
562 745
563 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 746 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
564 747
565 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">121</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 748 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">121</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
566 749
567 <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> 750 <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>
568 751
569 </div> 752 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
570 </div> 753
571 <a class="anchor" id="aca96c70e7e75c9e4a7db38485018914c"></a> 754 </div>
572 <div class="memitem"> 755 </div>
573 <div class="memproto"> 756 <a id="aca96c70e7e75c9e4a7db38485018914c"></a>
574 <table class="memname"> 757 <h2 class="memtitle"><span class="permalink"><a href="#aca96c70e7e75c9e4a7db38485018914c">&#9670;&nbsp;</a></span>process()</h2>
575 <tr> 758
576 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> <a class="el" href="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c">SpectralCentroid::process</a> </td> 759 <div class="memitem">
760 <div class="memproto">
761 <table class="mlabels">
762 <tr>
763 <td class="mlabels-left">
764 <table class="memname">
765 <tr>
766 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::process </td>
577 <td>(</td> 767 <td>(</td>
578 <td class="paramtype">const float *const *&#160;</td> 768 <td class="paramtype">const float *const *&#160;</td>
579 <td class="paramname"><em>inputBuffers</em>, </td> 769 <td class="paramname"><em>inputBuffers</em>, </td>
580 </tr> 770 </tr>
581 <tr> 771 <tr>
585 <td class="paramname"><em>timestamp</em>&#160;</td> 775 <td class="paramname"><em>timestamp</em>&#160;</td>
586 </tr> 776 </tr>
587 <tr> 777 <tr>
588 <td></td> 778 <td></td>
589 <td>)</td> 779 <td>)</td>
590 <td></td><td><code> [virtual]</code></td> 780 <td></td><td></td>
591 </tr> 781 </tr>
592 </table> 782 </table>
593 </div> 783 </td>
594 <div class="memdoc"> 784 <td class="mlabels-right">
785 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
786 </tr>
787 </table>
788 </div><div class="memdoc">
595 789
596 <p>Process a single block of input data. </p> 790 <p>Process a single block of input data. </p>
597 <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> 791 <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>
598 <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> 792 <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>
599 <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> 793 <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>
600 794
601 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 795 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
602 796
603 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">146</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 797 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">146</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
604 798
605 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="SpectralCentroid_8h_source.html#l00074">m_blockSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="SpectralCentroid_8h_source.html#l00073">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p> 799 <p class="reference">References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="SpectralCentroid_8h_source.html#l00074">m_blockSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="SpectralCentroid_8h_source.html#l00073">m_stepSize</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">Vamp::Plugin::Feature::values</a>.</p>
606 800
607 </div> 801 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
608 </div> 802
609 <a class="anchor" id="a83ba39f0870a2f86837605a958dfab1a"></a> 803 </div>
610 <div class="memitem"> 804 </div>
611 <div class="memproto"> 805 <a id="a83ba39f0870a2f86837605a958dfab1a"></a>
612 <table class="memname"> 806 <h2 class="memtitle"><span class="permalink"><a href="#a83ba39f0870a2f86837605a958dfab1a">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
613 <tr> 807
614 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> <a class="el" href="classSpectralCentroid.html#a83ba39f0870a2f86837605a958dfab1a">SpectralCentroid::getRemainingFeatures</a> </td> 808 <div class="memitem">
615 <td>(</td> 809 <div class="memproto">
616 <td class="paramname"></td><td>)</td> 810 <table class="mlabels">
617 <td><code> [virtual]</code></td> 811 <tr>
618 </tr> 812 <td class="mlabels-left">
619 </table> 813 <table class="memname">
620 </div> 814 <tr>
621 <div class="memdoc"> 815 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">SpectralCentroid::FeatureSet</a> SpectralCentroid::getRemainingFeatures </td>
816 <td>(</td>
817 <td class="paramname"></td><td>)</td>
818 <td></td>
819 </tr>
820 </table>
821 </td>
822 <td class="mlabels-right">
823 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
824 </tr>
825 </table>
826 </div><div class="memdoc">
622 827
623 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 828 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
624 829
625 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 830 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
626 831
627 <p>Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00192">192</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p> 832 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8cpp_source.html#l00192">192</a> of file <a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a>.</p>
628 833
629 </div> 834 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8h_source.html#l00056">getInputDomain()</a>.</p>
630 </div> 835
631 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a> 836 </div>
632 <div class="memitem"> 837 </div>
633 <div class="memproto"> 838 <a id="ae3b9c32b12796ece152388babad7cc7d"></a>
634 <table class="memname"> 839 <h2 class="memtitle"><span class="permalink"><a href="#ae3b9c32b12796ece152388babad7cc7d">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
635 <tr> 840
636 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin::getPreferredBlockSize</a> </td> 841 <div class="memitem">
637 <td>(</td> 842 <div class="memproto">
638 <td class="paramname"></td><td>)</td> 843 <table class="mlabels">
639 <td> const<code> [inline, virtual, inherited]</code></td> 844 <tr>
640 </tr> 845 <td class="mlabels-left">
641 </table> 846 <table class="memname">
642 </div> 847 <tr>
643 <div class="memdoc"> 848 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
644 849 <td>(</td>
645 <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> 850 <td class="paramname"></td><td>)</td>
646 <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> 851 <td> const</td>
647 <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> 852 </tr>
648 853 </table>
649 <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> 854 </td>
650 855 <td class="mlabels-right">
651 <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> 856 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
652 857 </tr>
653 <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> 858 </table>
654 859 </div><div class="memdoc">
655 </div> 860
656 </div> 861 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" title="Process a single block of input data. ">process()</a> function). </p>
657 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a> 862 <p>This should be called before <a class="el" href="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb" 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>
658 <div class="memitem"> 863 <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="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb" 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>
659 <div class="memproto"> 864
660 <table class="memname"> 865 <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>
661 <tr> 866
662 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin::getPreferredStepSize</a> </td> 867 <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>
663 <td>(</td> 868
664 <td class="paramname"></td><td>)</td> 869 <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>
665 <td> const<code> [inline, virtual, inherited]</code></td> 870
666 </tr> 871 </div>
667 </table> 872 </div>
668 </div> 873 <a id="a33eaf9a265bc3a055e156452112456c2"></a>
669 <div class="memdoc"> 874 <h2 class="memtitle"><span class="permalink"><a href="#a33eaf9a265bc3a055e156452112456c2">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
670 875
671 <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> 876 <div class="memitem">
672 <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> 877 <div class="memproto">
673 <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> 878 <table class="mlabels">
674 879 <tr>
675 <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> 880 <td class="mlabels-left">
676 881 <table class="memname">
677 <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> 882 <tr>
678 883 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
679 <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> 884 <td>(</td>
680 885 <td class="paramname"></td><td>)</td>
681 </div> 886 <td> const</td>
682 </div> 887 </tr>
683 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a> 888 </table>
684 <div class="memitem"> 889 </td>
685 <div class="memproto"> 890 <td class="mlabels-right">
686 <table class="memname"> 891 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
687 <tr> 892 </tr>
688 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin::getMinChannelCount</a> </td> 893 </table>
689 <td>(</td> 894 </div><div class="memdoc">
690 <td class="paramname"></td><td>)</td> 895
691 <td> const<code> [inline, virtual, inherited]</code></td> 896 <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="classSpectralCentroid.html#aca96c70e7e75c9e4a7db38485018914c" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
692 </tr> 897 <p>This should be called before <a class="el" href="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb" 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>
693 </table> 898 <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="classSpectralCentroid.html#aab1ae16f5c68e2b319668f447908cedb" 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>
694 </div> 899
695 <div class="memdoc"> 900 <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>
901
902 <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>
903
904 <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>
905
906 </div>
907 </div>
908 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
909 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
910
911 <div class="memitem">
912 <div class="memproto">
913 <table class="mlabels">
914 <tr>
915 <td class="mlabels-left">
916 <table class="memname">
917 <tr>
918 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
919 <td>(</td>
920 <td class="paramname"></td><td>)</td>
921 <td> const</td>
922 </tr>
923 </table>
924 </td>
925 <td class="mlabels-right">
926 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
927 </tr>
928 </table>
929 </div><div class="memdoc">
696 930
697 <p>Get the minimum supported number of input channels. </p> 931 <p>Get the minimum supported number of input channels. </p>
698 932
699 <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> 933 <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>
700 934
701 <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> 935 <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>
702 936
703 <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">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">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> 937 <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">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">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>
704 938
705 </div> 939 </div>
706 </div> 940 </div>
707 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a> 941 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
708 <div class="memitem"> 942 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
709 <div class="memproto"> 943
710 <table class="memname"> 944 <div class="memitem">
711 <tr> 945 <div class="memproto">
712 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin::getMaxChannelCount</a> </td> 946 <table class="mlabels">
713 <td>(</td> 947 <tr>
714 <td class="paramname"></td><td>)</td> 948 <td class="mlabels-left">
715 <td> const<code> [inline, virtual, inherited]</code></td> 949 <table class="memname">
716 </tr> 950 <tr>
717 </table> 951 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
718 </div> 952 <td>(</td>
719 <div class="memdoc"> 953 <td class="paramname"></td><td>)</td>
954 <td> const</td>
955 </tr>
956 </table>
957 </td>
958 <td class="mlabels-right">
959 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
960 </tr>
961 </table>
962 </div><div class="memdoc">
720 963
721 <p>Get the maximum supported number of input channels. </p> 964 <p>Get the maximum supported number of input channels. </p>
722 965
723 <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> 966 <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>
724 967
725 <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> 968 <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>
726 969
727 <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">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">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> 970 <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">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">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>
728 971
729 </div> 972 </div>
730 </div> 973 </div>
731 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 974 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
732 <div class="memitem"> 975 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
733 <div class="memproto"> 976
734 <table class="memname"> 977 <div class="memitem">
735 <tr> 978 <div class="memproto">
736 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 979 <table class="mlabels">
737 <td>(</td> 980 <tr>
738 <td class="paramname"></td><td>)</td> 981 <td class="mlabels-left">
739 <td> const<code> [inline, virtual, inherited]</code></td> 982 <table class="memname">
740 </tr> 983 <tr>
741 </table> 984 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
742 </div> 985 <td>(</td>
743 <div class="memdoc"> 986 <td class="paramname"></td><td>)</td>
744 987 <td> const</td>
745 <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> 988 </tr>
989 </table>
990 </td>
991 <td class="mlabels-right">
992 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
993 </tr>
994 </table>
995 </div><div class="memdoc">
996
997 <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>
746 <p>Do not reimplement this function in your subclass. </p> 998 <p>Do not reimplement this function in your subclass. </p>
747 999
748 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1000 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
749 1001
750 <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> 1002 <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>
751 1003
752 </div> 1004 </div>
753 </div> 1005 </div>
754 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a> 1006 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
755 <div class="memitem"> 1007 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
756 <div class="memproto"> 1008
757 <table class="memname"> 1009 <div class="memitem">
758 <tr> 1010 <div class="memproto">
759 <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td> 1011 <table class="mlabels">
760 <td>(</td> 1012 <tr>
761 <td class="paramname"></td><td>)</td> 1013 <td class="mlabels-left">
762 <td> const<code> [inline, virtual, inherited]</code></td> 1014 <table class="memname">
763 </tr> 1015 <tr>
764 </table> 1016 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
765 </div> 1017 <td>(</td>
766 <div class="memdoc"> 1018 <td class="paramname"></td><td>)</td>
1019 <td> const</td>
1020 </tr>
1021 </table>
1022 </td>
1023 <td class="mlabels-right">
1024 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1025 </tr>
1026 </table>
1027 </div><div class="memdoc">
767 1028
768 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 1029 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
769 1030
770 <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> 1031 <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>
771 1032
772 <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> 1033 <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>
773 1034
774 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 1035 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
775 1036
776 </div> 1037 </div>
777 </div> 1038 </div>
778 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a> 1039 <a id="a0c24ff6a43c681198dc9497287a26e3a"></a>
779 <div class="memitem"> 1040 <h2 class="memtitle"><span class="permalink"><a href="#a0c24ff6a43c681198dc9497287a26e3a">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
780 <div class="memproto"> 1041
781 <table class="memname"> 1042 <div class="memitem">
782 <tr> 1043 <div class="memproto">
783 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> <a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">Vamp::PluginBase::getParameterDescriptors</a> </td> 1044 <table class="mlabels">
784 <td>(</td> 1045 <tr>
785 <td class="paramname"></td><td>)</td> 1046 <td class="mlabels-left">
786 <td> const<code> [inline, virtual, inherited]</code></td> 1047 <table class="memname">
787 </tr> 1048 <tr>
788 </table> 1049 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
789 </div> 1050 <td>(</td>
790 <div class="memdoc"> 1051 <td class="paramname"></td><td>)</td>
1052 <td> const</td>
1053 </tr>
1054 </table>
1055 </td>
1056 <td class="mlabels-right">
1057 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1058 </tr>
1059 </table>
1060 </div><div class="memdoc">
791 1061
792 <p>Get the controllable parameters of this plugin. </p> 1062 <p>Get the controllable parameters of this plugin. </p>
793 1063
794 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a602faa0bfaae83e2ca53b36292271a76">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9be71561265c2e6e43b7feaddaa91f36">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a9df01323a09e117bc12354ebe9244edf">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae157465a4e07d180bab05b5c3a4d8987">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#abceae88cc9762b0ea310d7aad71de815">PercussionOnsetDetector</a>.</p> 1064 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f2b1c45be01169414bc86b685f4508e">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab2b67205d86e921cb0a9bd1f819d2cf9">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a4a707648d17d03a66b110b73b99e821b">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a4d5edffcea6c8757e0c077913b098aea">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ae1cc81d82aaac8db5cf8a1067494f3d8">PercussionOnsetDetector</a>.</p>
795 1065
796 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00204">204</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1066 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
797 1067
798 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 1068 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
799 1069
800 </div> 1070 </div>
801 </div> 1071 </div>
802 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a> 1072 <a id="aa813d61077080ec95487d2a0227cc51b"></a>
803 <div class="memitem"> 1073 <h2 class="memtitle"><span class="permalink"><a href="#aa813d61077080ec95487d2a0227cc51b">&#9670;&nbsp;</a></span>getParameter()</h2>
804 <div class="memproto"> 1074
805 <table class="memname"> 1075 <div class="memitem">
806 <tr> 1076 <div class="memproto">
807 <td class="memname">virtual float <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase::getParameter</a> </td> 1077 <table class="mlabels">
1078 <tr>
1079 <td class="mlabels-left">
1080 <table class="memname">
1081 <tr>
1082 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
808 <td>(</td> 1083 <td>(</td>
809 <td class="paramtype">std::string&#160;</td> 1084 <td class="paramtype">std::string&#160;</td>
810 <td class="paramname"></td><td>)</td> 1085 <td class="paramname"></td><td>)</td>
811 <td> const<code> [inline, virtual, inherited]</code></td> 1086 <td> const</td>
812 </tr> 1087 </tr>
813 </table> 1088 </table>
814 </div> 1089 </td>
815 <div class="memdoc"> 1090 <td class="mlabels-right">
1091 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1092 </tr>
1093 </table>
1094 </div><div class="memdoc">
816 1095
817 <p>Get the value of a named parameter. </p> 1096 <p>Get the value of a named parameter. </p>
818 <p>The argument is the identifier field from that parameter's descriptor. </p> 1097 <p>The argument is the identifier field from that parameter's descriptor. </p>
819 1098
820 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#af0c46d4f67ca93be7c76f3ea2e6c8efb">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a034920f56c8d7609a85447c42556048c">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ab278c4b6f2ca23248dc94ad775273f39">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a2030b05fb1228b30ace16200780c9152">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b28da8315fcde46ce7644d6592ba527">PercussionOnsetDetector</a>.</p> 1099 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a97149b60fb9d7c4359262ba8f6ff9743">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5c0a4d72a25fded51829de21771de521">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a93f32b68462f46af5265327a69479c38">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae988b4015672a73914e83c1589952752">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#accce70a87d6b30d4696d40a3e09b8f17">PercussionOnsetDetector</a>.</p>
821 1100
822 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00212">212</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1101 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
823 1102
824 </div> 1103 </div>
825 </div> 1104 </div>
826 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a> 1105 <a id="a6c718ce822f7b73b98940d59dcaa9366"></a>
827 <div class="memitem"> 1106 <h2 class="memtitle"><span class="permalink"><a href="#a6c718ce822f7b73b98940d59dcaa9366">&#9670;&nbsp;</a></span>setParameter()</h2>
828 <div class="memproto"> 1107
829 <table class="memname"> 1108 <div class="memitem">
830 <tr> 1109 <div class="memproto">
831 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase::setParameter</a> </td> 1110 <table class="mlabels">
1111 <tr>
1112 <td class="mlabels-left">
1113 <table class="memname">
1114 <tr>
1115 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
832 <td>(</td> 1116 <td>(</td>
833 <td class="paramtype">std::string&#160;</td> 1117 <td class="paramtype">std::string&#160;</td>
834 <td class="paramname">, </td> 1118 <td class="paramname">, </td>
835 </tr> 1119 </tr>
836 <tr> 1120 <tr>
840 <td class="paramname">&#160;</td> 1124 <td class="paramname">&#160;</td>
841 </tr> 1125 </tr>
842 <tr> 1126 <tr>
843 <td></td> 1127 <td></td>
844 <td>)</td> 1128 <td>)</td>
845 <td></td><td><code> [inline, virtual, inherited]</code></td> 1129 <td></td><td></td>
846 </tr> 1130 </tr>
847 </table> 1131 </table>
848 </div> 1132 </td>
849 <div class="memdoc"> 1133 <td class="mlabels-right">
1134 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1135 </tr>
1136 </table>
1137 </div><div class="memdoc">
850 1138
851 <p>Set a named parameter. </p> 1139 <p>Set a named parameter. </p>
852 <p>The first argument is the identifier field from that parameter's descriptor. </p> 1140 <p>The first argument is the identifier field from that parameter's descriptor. </p>
853 1141
854 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p> 1142 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
855 1143
856 <p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00218">218</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> 1144 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
857 1145
858 </div> 1146 </div>
859 </div> 1147 </div>
860 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a> 1148 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
861 <div class="memitem"> 1149 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
862 <div class="memproto"> 1150
863 <table class="memname"> 1151 <div class="memitem">
864 <tr> 1152 <div class="memproto">
865 <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> 1153 <table class="mlabels">
866 <td>(</td> 1154 <tr>
867 <td class="paramname"></td><td>)</td> 1155 <td class="mlabels-left">
868 <td> const<code> [inline, virtual, inherited]</code></td> 1156 <table class="memname">
869 </tr> 1157 <tr>
870 </table> 1158 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
871 </div> 1159 <td>(</td>
872 <div class="memdoc"> 1160 <td class="paramname"></td><td>)</td>
1161 <td> const</td>
1162 </tr>
1163 </table>
1164 </td>
1165 <td class="mlabels-right">
1166 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1167 </tr>
1168 </table>
1169 </div><div class="memdoc">
873 1170
874 <p>Get the program settings available in this plugin. </p> 1171 <p>Get the program settings available in this plugin. </p>
875 <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> 1172 <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>
876 <p>The programs must have unique names. </p> 1173 <p>The programs must have unique names. </p>
877 1174
878 <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> 1175 <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>
879 1176
880 <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> 1177 <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>
881 1178
882 </div> 1179 </div>
883 </div> 1180 </div>
884 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a> 1181 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
885 <div class="memitem"> 1182 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
886 <div class="memproto"> 1183
887 <table class="memname"> 1184 <div class="memitem">
888 <tr> 1185 <div class="memproto">
889 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td> 1186 <table class="mlabels">
890 <td>(</td> 1187 <tr>
891 <td class="paramname"></td><td>)</td> 1188 <td class="mlabels-left">
892 <td> const<code> [inline, virtual, inherited]</code></td> 1189 <table class="memname">
893 </tr> 1190 <tr>
894 </table> 1191 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
895 </div> 1192 <td>(</td>
896 <div class="memdoc"> 1193 <td class="paramname"></td><td>)</td>
1194 <td> const</td>
1195 </tr>
1196 </table>
1197 </td>
1198 <td class="mlabels-right">
1199 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1200 </tr>
1201 </table>
1202 </div><div class="memdoc">
897 1203
898 <p>Get the current program. </p> 1204 <p>Get the current program. </p>
899 1205
900 <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> 1206 <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>
901 1207
902 <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> 1208 <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>
903 1209
904 </div> 1210 </div>
905 </div> 1211 </div>
906 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a> 1212 <a id="aadd3a547ef140bae200473a9518e3353"></a>
907 <div class="memitem"> 1213 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
908 <div class="memproto"> 1214
909 <table class="memname"> 1215 <div class="memitem">
910 <tr> 1216 <div class="memproto">
911 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td> 1217 <table class="mlabels">
1218 <tr>
1219 <td class="mlabels-left">
1220 <table class="memname">
1221 <tr>
1222 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
912 <td>(</td> 1223 <td>(</td>
913 <td class="paramtype">std::string&#160;</td> 1224 <td class="paramtype">std::string&#160;</td>
914 <td class="paramname"></td><td>)</td> 1225 <td class="paramname"></td><td>)</td>
915 <td><code> [inline, virtual, inherited]</code></td> 1226 <td></td>
916 </tr> 1227 </tr>
917 </table> 1228 </table>
918 </div> 1229 </td>
919 <div class="memdoc"> 1230 <td class="mlabels-right">
1231 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1232 </tr>
1233 </table>
1234 </div><div class="memdoc">
920 1235
921 <p>Select a program. </p> 1236 <p>Select a program. </p>
922 <p>(If the given program name is not one of the available programs, do nothing.) </p> 1237 <p>(If the given program name is not one of the available programs, do nothing.) </p>
923 1238
924 <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> 1239 <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>
925 1240
926 <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> 1241 <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>
927 1242
928 </div> 1243 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
929 </div> 1244
930 <hr/><h2>Member Data Documentation</h2> 1245 </div>
931 <a class="anchor" id="a49805a090ba58477da4adbefea4392a7"></a> 1246 </div>
932 <div class="memitem"> 1247 <h2 class="groupheader">Member Data Documentation</h2>
933 <div class="memproto"> 1248 <a id="a49805a090ba58477da4adbefea4392a7"></a>
934 <table class="memname"> 1249 <h2 class="memtitle"><span class="permalink"><a href="#a49805a090ba58477da4adbefea4392a7">&#9670;&nbsp;</a></span>m_stepSize</h2>
935 <tr> 1250
936 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#a49805a090ba58477da4adbefea4392a7">SpectralCentroid::m_stepSize</a><code> [protected]</code></td> 1251 <div class="memitem">
937 </tr> 1252 <div class="memproto">
938 </table> 1253 <table class="mlabels">
939 </div> 1254 <tr>
940 <div class="memdoc"> 1255 <td class="mlabels-left">
941 1256 <table class="memname">
942 <p>Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00073">73</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p> 1257 <tr>
943 1258 <td class="memname">size_t SpectralCentroid::m_stepSize</td>
944 <p>Referenced by <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">process()</a>.</p> 1259 </tr>
945 1260 </table>
946 </div> 1261 </td>
947 </div> 1262 <td class="mlabels-right">
948 <a class="anchor" id="a262f583d71b442bb2d80023e7c85aa4e"></a> 1263 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
949 <div class="memitem"> 1264 </tr>
950 <div class="memproto"> 1265 </table>
951 <table class="memname"> 1266 </div><div class="memdoc">
952 <tr> 1267
953 <td class="memname">size_t <a class="el" href="classSpectralCentroid.html#a262f583d71b442bb2d80023e7c85aa4e">SpectralCentroid::m_blockSize</a><code> [protected]</code></td> 1268 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00073">73</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p>
954 </tr> 1269
955 </table> 1270 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">process()</a>.</p>
956 </div> 1271
957 <div class="memdoc"> 1272 </div>
958 1273 </div>
959 <p>Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00074">74</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p> 1274 <a id="a262f583d71b442bb2d80023e7c85aa4e"></a>
960 1275 <h2 class="memtitle"><span class="permalink"><a href="#a262f583d71b442bb2d80023e7c85aa4e">&#9670;&nbsp;</a></span>m_blockSize</h2>
961 <p>Referenced by <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">process()</a>.</p> 1276
962 1277 <div class="memitem">
963 </div> 1278 <div class="memproto">
964 </div> 1279 <table class="mlabels">
965 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1280 <tr>
966 <div class="memitem"> 1281 <td class="mlabels-left">
967 <div class="memproto"> 1282 <table class="memname">
968 <table class="memname"> 1283 <tr>
969 <tr> 1284 <td class="memname">size_t SpectralCentroid::m_blockSize</td>
970 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1285 </tr>
971 </tr> 1286 </table>
972 </table> 1287 </td>
973 </div> 1288 <td class="mlabels-right">
974 <div class="memdoc"> 1289 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
975 1290 </tr>
976 <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> 1291 </table>
977 1292 </div><div class="memdoc">
978 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00375">FixedTempoEstimator::D::calculate()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">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> 1293
1294 <p class="definition">Definition at line <a class="el" href="SpectralCentroid_8h_source.html#l00074">74</a> of file <a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>.</p>
1295
1296 <p class="reference">Referenced by <a class="el" href="SpectralCentroid_8cpp_source.html#l00104">initialise()</a>, and <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">process()</a>.</p>
1297
1298 </div>
1299 </div>
1300 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1301 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1302
1303 <div class="memitem">
1304 <div class="memproto">
1305 <table class="mlabels">
1306 <tr>
1307 <td class="mlabels-left">
1308 <table class="memname">
1309 <tr>
1310 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1311 </tr>
1312 </table>
1313 </td>
1314 <td class="mlabels-right">
1315 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1316 </tr>
1317 </table>
1318 </div><div class="memdoc">
1319
1320 <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>
1321
1322 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">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>
979 1323
980 </div> 1324 </div>
981 </div> 1325 </div>
982 <hr/>The documentation for this class was generated from the following files:<ul> 1326 <hr/>The documentation for this class was generated from the following files:<ul>
983 <li><a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a></li> 1327 <li><a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a></li>
984 <li><a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a></li> 1328 <li><a class="el" href="SpectralCentroid_8cpp_source.html">SpectralCentroid.cpp</a></li>
985 </ul> 1329 </ul>
986 </div><!-- contents --> 1330 </div><!-- contents -->
987 </div> 1331 </div><!-- doc-content -->
988 <div id="nav-path" class="navpath"> 1332 <!-- start footer part -->
989 <ul> 1333 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
990 <li class="navelem"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> </li> 1334 <ul>
991 1335 <li class="navelem"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a></li>
992 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by 1336 <li class="footer">Generated by
993 <a href="http://www.doxygen.org/index.html"> 1337 <a href="http://www.doxygen.org/index.html">
994 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1338 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
995 </ul> 1339 </ul>
996 </div> 1340 </div>
997
998
999 </body> 1341 </body>
1000 </html> 1342 </html>