Mercurial > hg > vamp-docs

comparison code-docs/classZeroCrossing.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: ZeroCrossing Class Reference</title> 8 <title>VampPluginSDK: ZeroCrossing 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('classZeroCrossing.html',''); 58 $(document).ready(function(){initNavTree('classZeroCrossing.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="classZeroCrossing-members.html">List of all members</a> </div>
80 <div class="headertitle"> 67 <div class="headertitle">
81 <div class="title">ZeroCrossing Class Reference</div> </div> 68 <div class="title">ZeroCrossing 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 ZeroCrossing:</div> 77 Inheritance diagram for ZeroCrossing:</div>
91 <div class="dyncontent"> 78 <div class="dyncontent">
92 <div class="center"><img src="classZeroCrossing__inherit__graph.png" border="0" usemap="#ZeroCrossing_inherit__map" alt="Inheritance graph"/></div> 79 <div class="center"><img src="classZeroCrossing__inherit__graph.png" border="0" usemap="#ZeroCrossing_inherit__map" alt="Inheritance graph"/></div>
93 <map name="ZeroCrossing_inherit__map" id="ZeroCrossing_inherit__map"> 80 <map name="ZeroCrossing_inherit__map" id="ZeroCrossing_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="classZeroCrossing-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:a9855153a54bdc9ba75cc1a705a149473"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a> (float inputSampleRate)</td></tr> 105 <tr class="memitem:a9855153a54bdc9ba75cc1a705a149473"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing</a> (float inputSampleRate)</td></tr>
106 <tr class="separator:a9855153a54bdc9ba75cc1a705a149473"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 <tr class="memitem:af1de0da862e6e2443581e4e16044675b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a> ()</td></tr> 107 <tr class="memitem:af1de0da862e6e2443581e4e16044675b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">~ZeroCrossing</a> ()</td></tr>
108 <tr class="separator:af1de0da862e6e2443581e4e16044675b"><td class="memSeparator" colspan="2">&#160;</td></tr>
116 <tr class="memitem:af21bbcc87a6eb7875dfab7d86222dccc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr> 109 <tr class="memitem:af21bbcc87a6eb7875dfab7d86222dccc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">initialise</a> (size_t channels, size_t stepSize, size_t blockSize)</td></tr>
117 <tr class="memdesc:af21bbcc87a6eb7875dfab7d86222dccc"><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="#af21bbcc87a6eb7875dfab7d86222dccc"></a><br/></td></tr> 110 <tr class="memdesc:af21bbcc87a6eb7875dfab7d86222dccc"><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="#af21bbcc87a6eb7875dfab7d86222dccc">More...</a><br /></td></tr>
111 <tr class="separator:af21bbcc87a6eb7875dfab7d86222dccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
118 <tr class="memitem:a9ae6c4a31ea027dceb1e97ead807e228"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">reset</a> ()</td></tr> 112 <tr class="memitem:a9ae6c4a31ea027dceb1e97ead807e228"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">reset</a> ()</td></tr>
119 <tr class="memdesc:a9ae6c4a31ea027dceb1e97ead807e228"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9ae6c4a31ea027dceb1e97ead807e228"></a><br/></td></tr> 113 <tr class="memdesc:a9ae6c4a31ea027dceb1e97ead807e228"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the plugin after use, to prepare it for another clean run. <a href="#a9ae6c4a31ea027dceb1e97ead807e228">More...</a><br /></td></tr>
120 <tr class="memitem:aafe2ce6ebd353a14c40db7e8e60f4051"><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="classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051">getInputDomain</a> () const </td></tr> 114 <tr class="separator:a9ae6c4a31ea027dceb1e97ead807e228"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <tr class="memdesc:aafe2ce6ebd353a14c40db7e8e60f4051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#aafe2ce6ebd353a14c40db7e8e60f4051"></a><br/></td></tr> 115 <tr class="memitem:a2fd2cefbd1564e4d30ccabd64d6555e7"><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="classZeroCrossing.html#a2fd2cefbd1564e4d30ccabd64d6555e7">getInputDomain</a> () const</td></tr>
122 <tr class="memitem:af2baf9e19fcdd11cfe97ace56d4f5c1a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a">getIdentifier</a> () const </td></tr> 116 <tr class="memdesc:a2fd2cefbd1564e4d30ccabd64d6555e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's required input domain. <a href="#a2fd2cefbd1564e4d30ccabd64d6555e7">More...</a><br /></td></tr>
123 <tr class="memdesc:af2baf9e19fcdd11cfe97ace56d4f5c1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#af2baf9e19fcdd11cfe97ace56d4f5c1a"></a><br/></td></tr> 117 <tr class="separator:a2fd2cefbd1564e4d30ccabd64d6555e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
124 <tr class="memitem:afa96f7ce6e7d9f03768f48c6a9d88498"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498">getName</a> () const </td></tr> 118 <tr class="memitem:af5049a01a3f003f17a45c61b599c6543"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af5049a01a3f003f17a45c61b599c6543">getIdentifier</a> () const</td></tr>
125 <tr class="memdesc:afa96f7ce6e7d9f03768f48c6a9d88498"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#afa96f7ce6e7d9f03768f48c6a9d88498"></a><br/></td></tr> 119 <tr class="memdesc:af5049a01a3f003f17a45c61b599c6543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#af5049a01a3f003f17a45c61b599c6543">More...</a><br /></td></tr>
126 <tr class="memitem:a710bb0b013157adaeef2a9e6867b4478"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478">getDescription</a> () const </td></tr> 120 <tr class="separator:af5049a01a3f003f17a45c61b599c6543"><td class="memSeparator" colspan="2">&#160;</td></tr>
127 <tr class="memdesc:a710bb0b013157adaeef2a9e6867b4478"><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="#a710bb0b013157adaeef2a9e6867b4478"></a><br/></td></tr> 121 <tr class="memitem:a191365f793e6488d02d57029eb14deb2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a191365f793e6488d02d57029eb14deb2">getName</a> () const</td></tr>
128 <tr class="memitem:ac68561634a3c329a029c2fd3deaeae2a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a">getMaker</a> () const </td></tr> 122 <tr class="memdesc:a191365f793e6488d02d57029eb14deb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a191365f793e6488d02d57029eb14deb2">More...</a><br /></td></tr>
129 <tr class="memdesc:ac68561634a3c329a029c2fd3deaeae2a"><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="#ac68561634a3c329a029c2fd3deaeae2a"></a><br/></td></tr> 123 <tr class="separator:a191365f793e6488d02d57029eb14deb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:ad685f6c2f443f07a1634550c335571eb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb">getPluginVersion</a> () const </td></tr> 124 <tr class="memitem:a7ba1cfd102a427f8333ddfa2fe234d58"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a7ba1cfd102a427f8333ddfa2fe234d58">getDescription</a> () const</td></tr>
131 <tr class="memdesc:ad685f6c2f443f07a1634550c335571eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#ad685f6c2f443f07a1634550c335571eb"></a><br/></td></tr> 125 <tr class="memdesc:a7ba1cfd102a427f8333ddfa2fe234d58"><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="#a7ba1cfd102a427f8333ddfa2fe234d58">More...</a><br /></td></tr>
132 <tr class="memitem:af9c41b92aa8ff8bddaebf75569ff789c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c">getCopyright</a> () const </td></tr> 126 <tr class="separator:a7ba1cfd102a427f8333ddfa2fe234d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memdesc:af9c41b92aa8ff8bddaebf75569ff789c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#af9c41b92aa8ff8bddaebf75569ff789c"></a><br/></td></tr> 127 <tr class="memitem:a9ddf295d977b6c64d8acd34b7e0ce1b0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a9ddf295d977b6c64d8acd34b7e0ce1b0">getMaker</a> () const</td></tr>
134 <tr class="memitem:ac9d590a6feb1fc9a37d7892aefe2b688"><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="classZeroCrossing.html#ac9d590a6feb1fc9a37d7892aefe2b688">getOutputDescriptors</a> () const </td></tr> 128 <tr class="memdesc:a9ddf295d977b6c64d8acd34b7e0ce1b0"><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="#a9ddf295d977b6c64d8acd34b7e0ce1b0">More...</a><br /></td></tr>
135 <tr class="memdesc:ac9d590a6feb1fc9a37d7892aefe2b688"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ac9d590a6feb1fc9a37d7892aefe2b688"></a><br/></td></tr> 129 <tr class="separator:a9ddf295d977b6c64d8acd34b7e0ce1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
130 <tr class="memitem:a4199350192d84a4ec5f379805cd3e7cf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a4199350192d84a4ec5f379805cd3e7cf">getPluginVersion</a> () const</td></tr>
131 <tr class="memdesc:a4199350192d84a4ec5f379805cd3e7cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version number of the plugin. <a href="#a4199350192d84a4ec5f379805cd3e7cf">More...</a><br /></td></tr>
132 <tr class="separator:a4199350192d84a4ec5f379805cd3e7cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:af955fb85b26a5497690aecbd288975f2"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#af955fb85b26a5497690aecbd288975f2">getCopyright</a> () const</td></tr>
134 <tr class="memdesc:af955fb85b26a5497690aecbd288975f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#af955fb85b26a5497690aecbd288975f2">More...</a><br /></td></tr>
135 <tr class="separator:af955fb85b26a5497690aecbd288975f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:ab83cfab3f9674920e295c2f3571bb24e"><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="classZeroCrossing.html#ab83cfab3f9674920e295c2f3571bb24e">getOutputDescriptors</a> () const</td></tr>
137 <tr class="memdesc:ab83cfab3f9674920e295c2f3571bb24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the outputs of this plugin. <a href="#ab83cfab3f9674920e295c2f3571bb24e">More...</a><br /></td></tr>
138 <tr class="separator:ab83cfab3f9674920e295c2f3571bb24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:abf4aaa6fd8cc03de63f4e1e8942633da"><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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr> 139 <tr class="memitem:abf4aaa6fd8cc03de63f4e1e8942633da"><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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">process</a> (const float *const *inputBuffers, <a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a> timestamp)</td></tr>
137 <tr class="memdesc:abf4aaa6fd8cc03de63f4e1e8942633da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#abf4aaa6fd8cc03de63f4e1e8942633da"></a><br/></td></tr> 140 <tr class="memdesc:abf4aaa6fd8cc03de63f4e1e8942633da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a single block of input data. <a href="#abf4aaa6fd8cc03de63f4e1e8942633da">More...</a><br /></td></tr>
141 <tr class="separator:abf4aaa6fd8cc03de63f4e1e8942633da"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a70996d1b7166e303903daf92a9a37ad8"><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="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">getRemainingFeatures</a> ()</td></tr> 142 <tr class="memitem:a70996d1b7166e303903daf92a9a37ad8"><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="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">getRemainingFeatures</a> ()</td></tr>
139 <tr class="memdesc:a70996d1b7166e303903daf92a9a37ad8"><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="#a70996d1b7166e303903daf92a9a37ad8"></a><br/></td></tr> 143 <tr class="memdesc:a70996d1b7166e303903daf92a9a37ad8"><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="#a70996d1b7166e303903daf92a9a37ad8">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:a70996d1b7166e303903daf92a9a37ad8"><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:a584f100b87c78f9af9da040d79567d52"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">m_stepSize</a></td></tr> 184 <tr class="memitem:a584f100b87c78f9af9da040d79567d52"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">m_stepSize</a></td></tr>
185 <tr class="separator:a584f100b87c78f9af9da040d79567d52"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a></td></tr> 186 <tr class="memitem:a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">m_previousSample</a></td></tr>
187 <tr class="separator:a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"><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 positions and density of zero-crossing points in an audio waveform. </p> 192 <div class="textblock"><p>Example plugin that calculates the positions and density of zero-crossing points in an audio waveform. </p>
172 193
173 <p>Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00047">47</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p> 194 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00047">47</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.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="a9855153a54bdc9ba75cc1a705a149473"></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="classZeroCrossing.html#a9855153a54bdc9ba75cc1a705a149473">ZeroCrossing::ZeroCrossing</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="a9855153a54bdc9ba75cc1a705a149473"></a>
347 <h2 class="memtitle"><span class="permalink"><a href="#a9855153a54bdc9ba75cc1a705a149473">&#9670;&nbsp;</a></span>ZeroCrossing()</h2>
348
349 <div class="memitem">
350 <div class="memproto">
351 <table class="memname">
352 <tr>
353 <td class="memname">ZeroCrossing::ZeroCrossing </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="ZeroCrossing_8cpp_source.html#l00047">47</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
290 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00046">46</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 363
291 364 </div>
292 </div> 365 </div>
293 </div> 366 <a id="af1de0da862e6e2443581e4e16044675b"></a>
294 <a class="anchor" id="af1de0da862e6e2443581e4e16044675b"></a> 367 <h2 class="memtitle"><span class="permalink"><a href="#af1de0da862e6e2443581e4e16044675b">&#9670;&nbsp;</a></span>~ZeroCrossing()</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="classZeroCrossing.html#af1de0da862e6e2443581e4e16044675b">ZeroCrossing::~ZeroCrossing</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">ZeroCrossing::~ZeroCrossing </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="ZeroCrossing_8cpp_source.html#l00053">53</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.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="af21bbcc87a6eb7875dfab7d86222dccc"></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="ZeroCrossing_8cpp_source.html#l00054">54</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
317 <tr> 390
318 <td class="memname">bool <a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc">ZeroCrossing::initialise</a> </td> 391 </div>
392 </div>
393 <h2 class="groupheader">Member Function Documentation</h2>
394 <a id="af21bbcc87a6eb7875dfab7d86222dccc"></a>
395 <h2 class="memtitle"><span class="permalink"><a href="#af21bbcc87a6eb7875dfab7d86222dccc">&#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 ZeroCrossing::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="ZeroCrossing_8cpp_source.html#l00094">94</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 440 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">95</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.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>, and <a class="el" href="ZeroCrossing_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>, and <a class="el" href="ZeroCrossing_8h_source.html#l00073">m_stepSize</a>.</p>
353 443
354 </div> 444 </div>
355 </div> 445 </div>
356 <a class="anchor" id="a9ae6c4a31ea027dceb1e97ead807e228"></a> 446 <a id="a9ae6c4a31ea027dceb1e97ead807e228"></a>
357 <div class="memitem"> 447 <h2 class="memtitle"><span class="permalink"><a href="#a9ae6c4a31ea027dceb1e97ead807e228">&#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="classZeroCrossing.html#a9ae6c4a31ea027dceb1e97ead807e228">ZeroCrossing::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 ZeroCrossing::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="ZeroCrossing_8cpp_source.html#l00105">105</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 474 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00106">106</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
376 475
377 <p>References <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>.</p> 476 <p class="reference">References <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>.</p>
378 477
379 </div> 478 </div>
380 </div> 479 </div>
381 <a class="anchor" id="aafe2ce6ebd353a14c40db7e8e60f4051"></a> 480 <a id="a2fd2cefbd1564e4d30ccabd64d6555e7"></a>
382 <div class="memitem"> 481 <h2 class="memtitle"><span class="permalink"><a href="#a2fd2cefbd1564e4d30ccabd64d6555e7">&#9670;&nbsp;</a></span>getInputDomain()</h2>
383 <div class="memproto"> 482
384 <table class="memname"> 483 <div class="memitem">
385 <tr> 484 <div class="memproto">
386 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> <a class="el" href="classZeroCrossing.html#aafe2ce6ebd353a14c40db7e8e60f4051">ZeroCrossing::getInputDomain</a> </td> 485 <table class="mlabels">
387 <td>(</td> 486 <tr>
388 <td class="paramname"></td><td>)</td> 487 <td class="mlabels-left">
389 <td> const<code> [inline, virtual]</code></td> 488 <table class="memname">
390 </tr> 489 <tr>
391 </table> 490 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> ZeroCrossing::getInputDomain </td>
392 </div> 491 <td>(</td>
393 <div class="memdoc"> 492 <td class="paramname"></td><td>)</td>
493 <td> const</td>
494 </tr>
495 </table>
496 </td>
497 <td class="mlabels-right">
498 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
499 </tr>
500 </table>
501 </div><div class="memdoc">
394 502
395 <p>Get the plugin's required input domain. </p> 503 <p>Get the plugin's required input domain. </p>
396 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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> 504 <p>If this is TimeDomain, the samples provided to the <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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>
397 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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> 505 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" 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>
398 506
399 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p> 507 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">Vamp::Plugin</a>.</p>
400 508
401 <p>Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00056">56</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p> 509 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00056">56</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
402 510
403 <p>References <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p> 511 <p class="reference">References <a class="el" href="ZeroCrossing_8cpp_source.html#l00089">getCopyright()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00071">getDescription()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00059">getIdentifier()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00077">getMaker()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00065">getName()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00083">getPluginVersion()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00192">getRemainingFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00152">Vamp::Plugin::TimeDomain</a>.</p>
404 512
405 </div> 513 </div>
406 </div> 514 </div>
407 <a class="anchor" id="af2baf9e19fcdd11cfe97ace56d4f5c1a"></a> 515 <a id="af5049a01a3f003f17a45c61b599c6543"></a>
408 <div class="memitem"> 516 <h2 class="memtitle"><span class="permalink"><a href="#af5049a01a3f003f17a45c61b599c6543">&#9670;&nbsp;</a></span>getIdentifier()</h2>
409 <div class="memproto"> 517
410 <table class="memname"> 518 <div class="memitem">
411 <tr> 519 <div class="memproto">
412 <td class="memname">string <a class="el" href="classZeroCrossing.html#af2baf9e19fcdd11cfe97ace56d4f5c1a">ZeroCrossing::getIdentifier</a> </td> 520 <table class="mlabels">
413 <td>(</td> 521 <tr>
414 <td class="paramname"></td><td>)</td> 522 <td class="mlabels-left">
415 <td> const<code> [virtual]</code></td> 523 <table class="memname">
416 </tr> 524 <tr>
417 </table> 525 <td class="memname">string ZeroCrossing::getIdentifier </td>
418 </div> 526 <td>(</td>
419 <div class="memdoc"> 527 <td class="paramname"></td><td>)</td>
528 <td> const</td>
529 </tr>
530 </table>
531 </td>
532 <td class="mlabels-right">
533 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
534 </tr>
535 </table>
536 </div><div class="memdoc">
420 537
421 <p>Get the computer-usable name of the plugin. </p> 538 <p>Get the computer-usable name of the plugin. </p>
422 <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> 539 <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>
423 <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> 540 <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>
424 <p>Example: "zero_crossings" </p> 541 <p>Example: "zero_crossings" </p>
425 542
426 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p> 543 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">Vamp::PluginBase</a>.</p>
427 544
428 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00058">58</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 545 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00059">59</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
429 546
430 </div> 547 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
431 </div> 548
432 <a class="anchor" id="afa96f7ce6e7d9f03768f48c6a9d88498"></a> 549 </div>
433 <div class="memitem"> 550 </div>
434 <div class="memproto"> 551 <a id="a191365f793e6488d02d57029eb14deb2"></a>
435 <table class="memname"> 552 <h2 class="memtitle"><span class="permalink"><a href="#a191365f793e6488d02d57029eb14deb2">&#9670;&nbsp;</a></span>getName()</h2>
436 <tr> 553
437 <td class="memname">string <a class="el" href="classZeroCrossing.html#afa96f7ce6e7d9f03768f48c6a9d88498">ZeroCrossing::getName</a> </td> 554 <div class="memitem">
438 <td>(</td> 555 <div class="memproto">
439 <td class="paramname"></td><td>)</td> 556 <table class="mlabels">
440 <td> const<code> [virtual]</code></td> 557 <tr>
441 </tr> 558 <td class="mlabels-left">
442 </table> 559 <table class="memname">
443 </div> 560 <tr>
444 <div class="memdoc"> 561 <td class="memname">string ZeroCrossing::getName </td>
562 <td>(</td>
563 <td class="paramname"></td><td>)</td>
564 <td> const</td>
565 </tr>
566 </table>
567 </td>
568 <td class="mlabels-right">
569 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
570 </tr>
571 </table>
572 </div><div class="memdoc">
445 573
446 <p>Get a human-readable name or title of the plugin. </p> 574 <p>Get a human-readable name or title of the plugin. </p>
447 <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> 575 <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>
448 <p>Example: "Zero Crossings" </p> 576 <p>Example: "Zero Crossings" </p>
449 577
450 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p> 578 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">Vamp::PluginBase</a>.</p>
451 579
452 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00064">64</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 580 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00065">65</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
453 581
454 </div> 582 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
455 </div> 583
456 <a class="anchor" id="a710bb0b013157adaeef2a9e6867b4478"></a> 584 </div>
457 <div class="memitem"> 585 </div>
458 <div class="memproto"> 586 <a id="a7ba1cfd102a427f8333ddfa2fe234d58"></a>
459 <table class="memname"> 587 <h2 class="memtitle"><span class="permalink"><a href="#a7ba1cfd102a427f8333ddfa2fe234d58">&#9670;&nbsp;</a></span>getDescription()</h2>
460 <tr> 588
461 <td class="memname">string <a class="el" href="classZeroCrossing.html#a710bb0b013157adaeef2a9e6867b4478">ZeroCrossing::getDescription</a> </td> 589 <div class="memitem">
462 <td>(</td> 590 <div class="memproto">
463 <td class="paramname"></td><td>)</td> 591 <table class="mlabels">
464 <td> const<code> [virtual]</code></td> 592 <tr>
465 </tr> 593 <td class="mlabels-left">
466 </table> 594 <table class="memname">
467 </div> 595 <tr>
468 <div class="memdoc"> 596 <td class="memname">string ZeroCrossing::getDescription </td>
597 <td>(</td>
598 <td class="paramname"></td><td>)</td>
599 <td> const</td>
600 </tr>
601 </table>
602 </td>
603 <td class="mlabels-right">
604 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
605 </tr>
606 </table>
607 </div><div class="memdoc">
469 608
470 <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> 609 <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>
471 <p>May be empty if the name has said it all already.</p> 610 <p>May be empty if the name has said it all already.</p>
472 <p>Example: "Detect and count zero crossing points" </p> 611 <p>Example: "Detect and count zero crossing points" </p>
473 612
474 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p> 613 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">Vamp::PluginBase</a>.</p>
475 614
476 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00070">70</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 615 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00071">71</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
477 616
478 </div> 617 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
479 </div> 618
480 <a class="anchor" id="ac68561634a3c329a029c2fd3deaeae2a"></a> 619 </div>
481 <div class="memitem"> 620 </div>
482 <div class="memproto"> 621 <a id="a9ddf295d977b6c64d8acd34b7e0ce1b0"></a>
483 <table class="memname"> 622 <h2 class="memtitle"><span class="permalink"><a href="#a9ddf295d977b6c64d8acd34b7e0ce1b0">&#9670;&nbsp;</a></span>getMaker()</h2>
484 <tr> 623
485 <td class="memname">string <a class="el" href="classZeroCrossing.html#ac68561634a3c329a029c2fd3deaeae2a">ZeroCrossing::getMaker</a> </td> 624 <div class="memitem">
486 <td>(</td> 625 <div class="memproto">
487 <td class="paramname"></td><td>)</td> 626 <table class="mlabels">
488 <td> const<code> [virtual]</code></td> 627 <tr>
489 </tr> 628 <td class="mlabels-left">
490 </table> 629 <table class="memname">
491 </div> 630 <tr>
492 <div class="memdoc"> 631 <td class="memname">string ZeroCrossing::getMaker </td>
632 <td>(</td>
633 <td class="paramname"></td><td>)</td>
634 <td> const</td>
635 </tr>
636 </table>
637 </td>
638 <td class="mlabels-right">
639 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
640 </tr>
641 </table>
642 </div><div class="memdoc">
493 643
494 <p>Get the name of the author or vendor of the plugin in human-readable form. </p> 644 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
495 <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> 645 <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>
496 646
497 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p> 647 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">Vamp::PluginBase</a>.</p>
498 648
499 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00076">76</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 649 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00077">77</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
500 650
501 </div> 651 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
502 </div> 652
503 <a class="anchor" id="ad685f6c2f443f07a1634550c335571eb"></a> 653 </div>
504 <div class="memitem"> 654 </div>
505 <div class="memproto"> 655 <a id="a4199350192d84a4ec5f379805cd3e7cf"></a>
506 <table class="memname"> 656 <h2 class="memtitle"><span class="permalink"><a href="#a4199350192d84a4ec5f379805cd3e7cf">&#9670;&nbsp;</a></span>getPluginVersion()</h2>
507 <tr> 657
508 <td class="memname">int <a class="el" href="classZeroCrossing.html#ad685f6c2f443f07a1634550c335571eb">ZeroCrossing::getPluginVersion</a> </td> 658 <div class="memitem">
509 <td>(</td> 659 <div class="memproto">
510 <td class="paramname"></td><td>)</td> 660 <table class="mlabels">
511 <td> const<code> [virtual]</code></td> 661 <tr>
512 </tr> 662 <td class="mlabels-left">
513 </table> 663 <table class="memname">
514 </div> 664 <tr>
515 <div class="memdoc"> 665 <td class="memname">int ZeroCrossing::getPluginVersion </td>
666 <td>(</td>
667 <td class="paramname"></td><td>)</td>
668 <td> const</td>
669 </tr>
670 </table>
671 </td>
672 <td class="mlabels-right">
673 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
674 </tr>
675 </table>
676 </div><div class="memdoc">
516 677
517 <p>Get the version number of the plugin. </p> 678 <p>Get the version number of the plugin. </p>
518 679
519 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p> 680 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">Vamp::PluginBase</a>.</p>
520 681
521 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00082">82</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 682 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00083">83</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
522 683
523 </div> 684 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
524 </div> 685
525 <a class="anchor" id="af9c41b92aa8ff8bddaebf75569ff789c"></a> 686 </div>
526 <div class="memitem"> 687 </div>
527 <div class="memproto"> 688 <a id="af955fb85b26a5497690aecbd288975f2"></a>
528 <table class="memname"> 689 <h2 class="memtitle"><span class="permalink"><a href="#af955fb85b26a5497690aecbd288975f2">&#9670;&nbsp;</a></span>getCopyright()</h2>
529 <tr> 690
530 <td class="memname">string <a class="el" href="classZeroCrossing.html#af9c41b92aa8ff8bddaebf75569ff789c">ZeroCrossing::getCopyright</a> </td> 691 <div class="memitem">
531 <td>(</td> 692 <div class="memproto">
532 <td class="paramname"></td><td>)</td> 693 <table class="mlabels">
533 <td> const<code> [virtual]</code></td> 694 <tr>
534 </tr> 695 <td class="mlabels-left">
535 </table> 696 <table class="memname">
536 </div> 697 <tr>
537 <div class="memdoc"> 698 <td class="memname">string ZeroCrossing::getCopyright </td>
699 <td>(</td>
700 <td class="paramname"></td><td>)</td>
701 <td> const</td>
702 </tr>
703 </table>
704 </td>
705 <td class="mlabels-right">
706 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
707 </tr>
708 </table>
709 </div><div class="memdoc">
538 710
539 <p>Get the copyright statement or licensing summary for the plugin. </p> 711 <p>Get the copyright statement or licensing summary for the plugin. </p>
540 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p> 712 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
541 713
542 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p> 714 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">Vamp::PluginBase</a>.</p>
543 715
544 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00088">88</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 716 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00089">89</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
545 717
546 </div> 718 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
547 </div> 719
548 <a class="anchor" id="ac9d590a6feb1fc9a37d7892aefe2b688"></a> 720 </div>
549 <div class="memitem"> 721 </div>
550 <div class="memproto"> 722 <a id="ab83cfab3f9674920e295c2f3571bb24e"></a>
551 <table class="memname"> 723 <h2 class="memtitle"><span class="permalink"><a href="#ab83cfab3f9674920e295c2f3571bb24e">&#9670;&nbsp;</a></span>getOutputDescriptors()</h2>
552 <tr> 724
553 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a> <a class="el" href="classZeroCrossing.html#ac9d590a6feb1fc9a37d7892aefe2b688">ZeroCrossing::getOutputDescriptors</a> </td> 725 <div class="memitem">
554 <td>(</td> 726 <div class="memproto">
555 <td class="paramname"></td><td>)</td> 727 <table class="mlabels">
556 <td> const<code> [virtual]</code></td> 728 <tr>
557 </tr> 729 <td class="mlabels-left">
558 </table> 730 <table class="memname">
559 </div> 731 <tr>
560 <div class="memdoc"> 732 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">ZeroCrossing::OutputList</a> ZeroCrossing::getOutputDescriptors </td>
733 <td>(</td>
734 <td class="paramname"></td><td>)</td>
735 <td> const</td>
736 </tr>
737 </table>
738 </td>
739 <td class="mlabels-right">
740 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
741 </tr>
742 </table>
743 </div><div class="memdoc">
561 744
562 <p>Get the outputs of this plugin. </p> 745 <p>Get the outputs of this plugin. </p>
563 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data.">process()</a> call. </p> 746 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> call. </p>
564 747
565 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p> 748 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">Vamp::Plugin</a>.</p>
566 749
567 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">111</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 750 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">112</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
568 751
569 <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#l00436">Vamp::Plugin::m_inputSampleRate</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#l00285">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00296">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p> 752 <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#l00444">Vamp::Plugin::m_inputSampleRate</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#l00285">Vamp::Plugin::OutputDescriptor::quantizeStep</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">Vamp::Plugin::OutputDescriptor::sampleRate</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">Vamp::Plugin::OutputDescriptor::sampleType</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">Vamp::Plugin::OutputDescriptor::unit</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00296">Vamp::Plugin::OutputDescriptor::VariableSampleRate</a>.</p>
570 753
571 </div> 754 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
572 </div> 755
573 <a class="anchor" id="abf4aaa6fd8cc03de63f4e1e8942633da"></a> 756 </div>
574 <div class="memitem"> 757 </div>
575 <div class="memproto"> 758 <a id="abf4aaa6fd8cc03de63f4e1e8942633da"></a>
576 <table class="memname"> 759 <h2 class="memtitle"><span class="permalink"><a href="#abf4aaa6fd8cc03de63f4e1e8942633da">&#9670;&nbsp;</a></span>process()</h2>
577 <tr> 760
578 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da">ZeroCrossing::process</a> </td> 761 <div class="memitem">
762 <div class="memproto">
763 <table class="mlabels">
764 <tr>
765 <td class="mlabels-left">
766 <table class="memname">
767 <tr>
768 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::process </td>
579 <td>(</td> 769 <td>(</td>
580 <td class="paramtype">const float *const *&#160;</td> 770 <td class="paramtype">const float *const *&#160;</td>
581 <td class="paramname"><em>inputBuffers</em>, </td> 771 <td class="paramname"><em>inputBuffers</em>, </td>
582 </tr> 772 </tr>
583 <tr> 773 <tr>
587 <td class="paramname"><em>timestamp</em>&#160;</td> 777 <td class="paramname"><em>timestamp</em>&#160;</td>
588 </tr> 778 </tr>
589 <tr> 779 <tr>
590 <td></td> 780 <td></td>
591 <td>)</td> 781 <td>)</td>
592 <td></td><td><code> [virtual]</code></td> 782 <td></td><td></td>
593 </tr> 783 </tr>
594 </table> 784 </table>
595 </div> 785 </td>
596 <div class="memdoc"> 786 <td class="mlabels-right">
787 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
788 </tr>
789 </table>
790 </div><div class="memdoc">
597 791
598 <p>Process a single block of input data. </p> 792 <p>Process a single block of input data. </p>
599 <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> 793 <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>
600 <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> 794 <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>
601 <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> 795 <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>
602 796
603 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p> 797 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">Vamp::Plugin</a>.</p>
604 798
605 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">142</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 799 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">143</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
606 800
607 <p>References <a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00436">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00073">m_stepSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">Vamp::Plugin::Feature::values</a>.</p> 801 <p class="reference">References <a class="el" href="structVamp_1_1RealTime.html#a939b4b1d1ca190db69a418883f16ce8a">Vamp::RealTime::frame2RealTime()</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">Vamp::Plugin::Feature::hasTimestamp</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00444">Vamp::Plugin::m_inputSampleRate</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00074">m_previousSample</a>, <a class="el" href="ZeroCrossing_8h_source.html#l00073">m_stepSize</a>, <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00360">Vamp::Plugin::Feature::timestamp</a>, and <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">Vamp::Plugin::Feature::values</a>.</p>
608 802
609 </div> 803 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
610 </div> 804
611 <a class="anchor" id="a70996d1b7166e303903daf92a9a37ad8"></a> 805 </div>
612 <div class="memitem"> 806 </div>
613 <div class="memproto"> 807 <a id="a70996d1b7166e303903daf92a9a37ad8"></a>
614 <table class="memname"> 808 <h2 class="memtitle"><span class="permalink"><a href="#a70996d1b7166e303903daf92a9a37ad8">&#9670;&nbsp;</a></span>getRemainingFeatures()</h2>
615 <tr> 809
616 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> <a class="el" href="classZeroCrossing.html#a70996d1b7166e303903daf92a9a37ad8">ZeroCrossing::getRemainingFeatures</a> </td> 810 <div class="memitem">
617 <td>(</td> 811 <div class="memproto">
618 <td class="paramname"></td><td>)</td> 812 <table class="mlabels">
619 <td><code> [virtual]</code></td> 813 <tr>
620 </tr> 814 <td class="mlabels-left">
621 </table> 815 <table class="memname">
622 </div> 816 <tr>
623 <div class="memdoc"> 817 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">ZeroCrossing::FeatureSet</a> ZeroCrossing::getRemainingFeatures </td>
818 <td>(</td>
819 <td class="paramname"></td><td>)</td>
820 <td></td>
821 </tr>
822 </table>
823 </td>
824 <td class="mlabels-right">
825 <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
826 </tr>
827 </table>
828 </div><div class="memdoc">
624 829
625 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p> 830 <p>After all blocks have been processed, calculate and return any remaining features derived from the complete input. </p>
626 831
627 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p> 832 <p>Implements <a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">Vamp::Plugin</a>.</p>
628 833
629 <p>Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00191">191</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p> 834 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8cpp_source.html#l00192">192</a> of file <a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a>.</p>
630 835
631 </div> 836 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8h_source.html#l00056">getInputDomain()</a>.</p>
632 </div> 837
633 <a class="anchor" id="aa529adf83f87a603954eb31407602aac"></a> 838 </div>
634 <div class="memitem"> 839 </div>
635 <div class="memproto"> 840 <a id="ae3b9c32b12796ece152388babad7cc7d"></a>
636 <table class="memname"> 841 <h2 class="memtitle"><span class="permalink"><a href="#ae3b9c32b12796ece152388babad7cc7d">&#9670;&nbsp;</a></span>getPreferredBlockSize()</h2>
637 <tr> 842
638 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">Vamp::Plugin::getPreferredBlockSize</a> </td> 843 <div class="memitem">
639 <td>(</td> 844 <div class="memproto">
640 <td class="paramname"></td><td>)</td> 845 <table class="mlabels">
641 <td> const<code> [inline, virtual, inherited]</code></td> 846 <tr>
642 </tr> 847 <td class="mlabels-left">
643 </table> 848 <table class="memname">
644 </div> 849 <tr>
645 <div class="memdoc"> 850 <td class="memname">virtual size_t Vamp::Plugin::getPreferredBlockSize </td>
646 851 <td>(</td>
647 <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> 852 <td class="paramname"></td><td>)</td>
648 <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> 853 <td> const</td>
649 <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> 854 </tr>
650 855 </table>
651 <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> 856 </td>
652 857 <td class="mlabels-right">
653 <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> 858 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
654 859 </tr>
655 <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> 860 </table>
656 861 </div><div class="memdoc">
657 </div> 862
658 </div> 863 <p>Get the preferred block size (window size &ndash; the number of sample frames passed in each block to the <a class="el" href="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> function). </p>
659 <a class="anchor" id="a514c716c22f81c055f19b56c3f882567"></a> 864 <p>This should be called before <a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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>
660 <div class="memitem"> 865 <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="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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>
661 <div class="memproto"> 866
662 <table class="memname"> 867 <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>
663 <tr> 868
664 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">Vamp::Plugin::getPreferredStepSize</a> </td> 869 <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>
665 <td>(</td> 870
666 <td class="paramname"></td><td>)</td> 871 <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>
667 <td> const<code> [inline, virtual, inherited]</code></td> 872
668 </tr> 873 </div>
669 </table> 874 </div>
670 </div> 875 <a id="a33eaf9a265bc3a055e156452112456c2"></a>
671 <div class="memdoc"> 876 <h2 class="memtitle"><span class="permalink"><a href="#a33eaf9a265bc3a055e156452112456c2">&#9670;&nbsp;</a></span>getPreferredStepSize()</h2>
672 877
673 <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> 878 <div class="memitem">
674 <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> 879 <div class="memproto">
675 <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> 880 <table class="mlabels">
676 881 <tr>
677 <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> 882 <td class="mlabels-left">
678 883 <table class="memname">
679 <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> 884 <tr>
680 885 <td class="memname">virtual size_t Vamp::Plugin::getPreferredStepSize </td>
681 <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> 886 <td>(</td>
682 887 <td class="paramname"></td><td>)</td>
683 </div> 888 <td> const</td>
684 </div> 889 </tr>
685 <a class="anchor" id="a267b42e866df3cf0d190893e8096f525"></a> 890 </table>
686 <div class="memitem"> 891 </td>
687 <div class="memproto"> 892 <td class="mlabels-right">
688 <table class="memname"> 893 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
689 <tr> 894 </tr>
690 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">Vamp::Plugin::getMinChannelCount</a> </td> 895 </table>
691 <td>(</td> 896 </div><div class="memdoc">
692 <td class="paramname"></td><td>)</td> 897
693 <td> const<code> [inline, virtual, inherited]</code></td> 898 <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="classZeroCrossing.html#abf4aaa6fd8cc03de63f4e1e8942633da" title="Process a single block of input data. ">process()</a> function) for the plugin. </p>
694 </tr> 899 <p>This should be called before <a class="el" href="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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>
695 </table> 900 <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="classZeroCrossing.html#af21bbcc87a6eb7875dfab7d86222dccc" 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>
696 </div> 901
697 <div class="memdoc"> 902 <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>
903
904 <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>
905
906 <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>
907
908 </div>
909 </div>
910 <a id="ab74f7634c6ac6e3da115667808a79c30"></a>
911 <h2 class="memtitle"><span class="permalink"><a href="#ab74f7634c6ac6e3da115667808a79c30">&#9670;&nbsp;</a></span>getMinChannelCount()</h2>
912
913 <div class="memitem">
914 <div class="memproto">
915 <table class="mlabels">
916 <tr>
917 <td class="mlabels-left">
918 <table class="memname">
919 <tr>
920 <td class="memname">virtual size_t Vamp::Plugin::getMinChannelCount </td>
921 <td>(</td>
922 <td class="paramname"></td><td>)</td>
923 <td> const</td>
924 </tr>
925 </table>
926 </td>
927 <td class="mlabels-right">
928 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
929 </tr>
930 </table>
931 </div><div class="memdoc">
698 932
699 <p>Get the minimum supported number of input channels. </p> 933 <p>Get the minimum supported number of input channels. </p>
700 934
701 <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> 935 <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>
702 936
703 <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> 937 <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>
704 938
705 <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">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">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> 939 <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">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">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>
706 940
707 </div> 941 </div>
708 </div> 942 </div>
709 <a class="anchor" id="a2c5ab12b6fa4847cb244bd1e9cb3ae5e"></a> 943 <a id="a0bff9464bc8c117470136c396b2405dd"></a>
710 <div class="memitem"> 944 <h2 class="memtitle"><span class="permalink"><a href="#a0bff9464bc8c117470136c396b2405dd">&#9670;&nbsp;</a></span>getMaxChannelCount()</h2>
711 <div class="memproto"> 945
712 <table class="memname"> 946 <div class="memitem">
713 <tr> 947 <div class="memproto">
714 <td class="memname">virtual size_t <a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">Vamp::Plugin::getMaxChannelCount</a> </td> 948 <table class="mlabels">
715 <td>(</td> 949 <tr>
716 <td class="paramname"></td><td>)</td> 950 <td class="mlabels-left">
717 <td> const<code> [inline, virtual, inherited]</code></td> 951 <table class="memname">
718 </tr> 952 <tr>
719 </table> 953 <td class="memname">virtual size_t Vamp::Plugin::getMaxChannelCount </td>
720 </div> 954 <td>(</td>
721 <div class="memdoc"> 955 <td class="paramname"></td><td>)</td>
956 <td> const</td>
957 </tr>
958 </table>
959 </td>
960 <td class="mlabels-right">
961 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
962 </tr>
963 </table>
964 </div><div class="memdoc">
722 965
723 <p>Get the maximum supported number of input channels. </p> 966 <p>Get the maximum supported number of input channels. </p>
724 967
725 <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> 968 <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>
726 969
727 <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> 970 <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>
728 971
729 <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">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">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> 972 <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">SpectralCentroid::initialise()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">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>
730 973
731 </div> 974 </div>
732 </div> 975 </div>
733 <a class="anchor" id="abe13b3997a69fbcc09e2213faa352f91"></a> 976 <a id="a530123068767a8728c568ffccfe3e4e5"></a>
734 <div class="memitem"> 977 <h2 class="memtitle"><span class="permalink"><a href="#a530123068767a8728c568ffccfe3e4e5">&#9670;&nbsp;</a></span>getType()</h2>
735 <div class="memproto"> 978
736 <table class="memname"> 979 <div class="memitem">
737 <tr> 980 <div class="memproto">
738 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">Vamp::Plugin::getType</a> </td> 981 <table class="mlabels">
739 <td>(</td> 982 <tr>
740 <td class="paramname"></td><td>)</td> 983 <td class="mlabels-left">
741 <td> const<code> [inline, virtual, inherited]</code></td> 984 <table class="memname">
742 </tr> 985 <tr>
743 </table> 986 <td class="memname">virtual std::string Vamp::Plugin::getType </td>
744 </div> 987 <td>(</td>
745 <div class="memdoc"> 988 <td class="paramname"></td><td>)</td>
746 989 <td> const</td>
747 <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> 990 </tr>
991 </table>
992 </td>
993 <td class="mlabels-right">
994 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
995 </tr>
996 </table>
997 </div><div class="memdoc">
998
999 <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>
748 <p>Do not reimplement this function in your subclass. </p> 1000 <p>Do not reimplement this function in your subclass. </p>
749 1001
750 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p> 1002 <p>Implements <a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">Vamp::PluginBase</a>.</p>
751 1003
752 <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> 1004 <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>
753 1005
754 </div> 1006 </div>
755 </div> 1007 </div>
756 <a class="anchor" id="a8fd2c48291c64b790f0efb8948508dcf"></a> 1008 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
757 <div class="memitem"> 1009 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">&#9670;&nbsp;</a></span>getVampApiVersion()</h2>
758 <div class="memproto"> 1010
759 <table class="memname"> 1011 <div class="memitem">
760 <tr> 1012 <div class="memproto">
761 <td class="memname">virtual unsigned int <a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">Vamp::PluginBase::getVampApiVersion</a> </td> 1013 <table class="mlabels">
762 <td>(</td> 1014 <tr>
763 <td class="paramname"></td><td>)</td> 1015 <td class="mlabels-left">
764 <td> const<code> [inline, virtual, inherited]</code></td> 1016 <table class="memname">
765 </tr> 1017 <tr>
766 </table> 1018 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
767 </div> 1019 <td>(</td>
768 <div class="memdoc"> 1020 <td class="paramname"></td><td>)</td>
1021 <td> const</td>
1022 </tr>
1023 </table>
1024 </td>
1025 <td class="mlabels-right">
1026 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1027 </tr>
1028 </table>
1029 </div><div class="memdoc">
769 1030
770 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p> 1031 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
771 1032
772 <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> 1033 <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>
773 1034
774 <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> 1035 <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>
775 1036
776 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 1037 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
777 1038
778 </div> 1039 </div>
779 </div> 1040 </div>
780 <a class="anchor" id="aac3e49b3b66cacfbb768dfdf07444f21"></a> 1041 <a id="a0c24ff6a43c681198dc9497287a26e3a"></a>
781 <div class="memitem"> 1042 <h2 class="memtitle"><span class="permalink"><a href="#a0c24ff6a43c681198dc9497287a26e3a">&#9670;&nbsp;</a></span>getParameterDescriptors()</h2>
782 <div class="memproto"> 1043
783 <table class="memname"> 1044 <div class="memitem">
784 <tr> 1045 <div class="memproto">
785 <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> 1046 <table class="mlabels">
786 <td>(</td> 1047 <tr>
787 <td class="paramname"></td><td>)</td> 1048 <td class="mlabels-left">
788 <td> const<code> [inline, virtual, inherited]</code></td> 1049 <table class="memname">
789 </tr> 1050 <tr>
790 </table> 1051 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
791 </div> 1052 <td>(</td>
792 <div class="memdoc"> 1053 <td class="paramname"></td><td>)</td>
1054 <td> const</td>
1055 </tr>
1056 </table>
1057 </td>
1058 <td class="mlabels-right">
1059 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1060 </tr>
1061 </table>
1062 </div><div class="memdoc">
793 1063
794 <p>Get the controllable parameters of this plugin. </p> 1064 <p>Get the controllable parameters of this plugin. </p>
795 1065
796 <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> 1066 <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>
797 1067
798 <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> 1068 <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>
799 1069
800 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00578">enumeratePlugins()</a>.</p> 1070 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
801 1071
802 </div> 1072 </div>
803 </div> 1073 </div>
804 <a class="anchor" id="a97ababcd45348ceec998d0f8e0f38bf7"></a> 1074 <a id="aa813d61077080ec95487d2a0227cc51b"></a>
805 <div class="memitem"> 1075 <h2 class="memtitle"><span class="permalink"><a href="#aa813d61077080ec95487d2a0227cc51b">&#9670;&nbsp;</a></span>getParameter()</h2>
806 <div class="memproto"> 1076
807 <table class="memname"> 1077 <div class="memitem">
808 <tr> 1078 <div class="memproto">
809 <td class="memname">virtual float <a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">Vamp::PluginBase::getParameter</a> </td> 1079 <table class="mlabels">
1080 <tr>
1081 <td class="mlabels-left">
1082 <table class="memname">
1083 <tr>
1084 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
810 <td>(</td> 1085 <td>(</td>
811 <td class="paramtype">std::string&#160;</td> 1086 <td class="paramtype">std::string&#160;</td>
812 <td class="paramname"></td><td>)</td> 1087 <td class="paramname"></td><td>)</td>
813 <td> const<code> [inline, virtual, inherited]</code></td> 1088 <td> const</td>
814 </tr> 1089 </tr>
815 </table> 1090 </table>
816 </div> 1091 </td>
817 <div class="memdoc"> 1092 <td class="mlabels-right">
1093 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1094 </tr>
1095 </table>
1096 </div><div class="memdoc">
818 1097
819 <p>Get the value of a named parameter. </p> 1098 <p>Get the value of a named parameter. </p>
820 <p>The argument is the identifier field from that parameter's descriptor. </p> 1099 <p>The argument is the identifier field from that parameter's descriptor. </p>
821 1100
822 <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> 1101 <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>
823 1102
824 <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> 1103 <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>
825 1104
826 </div> 1105 </div>
827 </div> 1106 </div>
828 <a class="anchor" id="a6c718ce822f7b73b98940d59dcaa9366"></a> 1107 <a id="a6c718ce822f7b73b98940d59dcaa9366"></a>
829 <div class="memitem"> 1108 <h2 class="memtitle"><span class="permalink"><a href="#a6c718ce822f7b73b98940d59dcaa9366">&#9670;&nbsp;</a></span>setParameter()</h2>
830 <div class="memproto"> 1109
831 <table class="memname"> 1110 <div class="memitem">
832 <tr> 1111 <div class="memproto">
833 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">Vamp::PluginBase::setParameter</a> </td> 1112 <table class="mlabels">
1113 <tr>
1114 <td class="mlabels-left">
1115 <table class="memname">
1116 <tr>
1117 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
834 <td>(</td> 1118 <td>(</td>
835 <td class="paramtype">std::string&#160;</td> 1119 <td class="paramtype">std::string&#160;</td>
836 <td class="paramname">, </td> 1120 <td class="paramname">, </td>
837 </tr> 1121 </tr>
838 <tr> 1122 <tr>
842 <td class="paramname">&#160;</td> 1126 <td class="paramname">&#160;</td>
843 </tr> 1127 </tr>
844 <tr> 1128 <tr>
845 <td></td> 1129 <td></td>
846 <td>)</td> 1130 <td>)</td>
847 <td></td><td><code> [inline, virtual, inherited]</code></td> 1131 <td></td><td></td>
848 </tr> 1132 </tr>
849 </table> 1133 </table>
850 </div> 1134 </td>
851 <div class="memdoc"> 1135 <td class="mlabels-right">
1136 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1137 </tr>
1138 </table>
1139 </div><div class="memdoc">
852 1140
853 <p>Set a named parameter. </p> 1141 <p>Set a named parameter. </p>
854 <p>The first argument is the identifier field from that parameter's descriptor. </p> 1142 <p>The first argument is the identifier field from that parameter's descriptor. </p>
855 1143
856 <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> 1144 <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>
857 1145
858 <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> 1146 <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>
859 1147
860 </div> 1148 </div>
861 </div> 1149 </div>
862 <a class="anchor" id="abb307c60bdb981d5f5af50c3c4ae84af"></a> 1150 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
863 <div class="memitem"> 1151 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">&#9670;&nbsp;</a></span>getPrograms()</h2>
864 <div class="memproto"> 1152
865 <table class="memname"> 1153 <div class="memitem">
866 <tr> 1154 <div class="memproto">
867 <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> 1155 <table class="mlabels">
868 <td>(</td> 1156 <tr>
869 <td class="paramname"></td><td>)</td> 1157 <td class="mlabels-left">
870 <td> const<code> [inline, virtual, inherited]</code></td> 1158 <table class="memname">
871 </tr> 1159 <tr>
872 </table> 1160 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
873 </div> 1161 <td>(</td>
874 <div class="memdoc"> 1162 <td class="paramname"></td><td>)</td>
1163 <td> const</td>
1164 </tr>
1165 </table>
1166 </td>
1167 <td class="mlabels-right">
1168 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1169 </tr>
1170 </table>
1171 </div><div class="memdoc">
875 1172
876 <p>Get the program settings available in this plugin. </p> 1173 <p>Get the program settings available in this plugin. </p>
877 <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> 1174 <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>
878 <p>The programs must have unique names. </p> 1175 <p>The programs must have unique names. </p>
879 1176
880 <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> 1177 <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>
881 1178
882 <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> 1179 <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>
883 1180
884 </div> 1181 </div>
885 </div> 1182 </div>
886 <a class="anchor" id="a24e77eccf1bdfbbca3c79bb25e8799b3"></a> 1183 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
887 <div class="memitem"> 1184 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">&#9670;&nbsp;</a></span>getCurrentProgram()</h2>
888 <div class="memproto"> 1185
889 <table class="memname"> 1186 <div class="memitem">
890 <tr> 1187 <div class="memproto">
891 <td class="memname">virtual std::string <a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">Vamp::PluginBase::getCurrentProgram</a> </td> 1188 <table class="mlabels">
892 <td>(</td> 1189 <tr>
893 <td class="paramname"></td><td>)</td> 1190 <td class="mlabels-left">
894 <td> const<code> [inline, virtual, inherited]</code></td> 1191 <table class="memname">
895 </tr> 1192 <tr>
896 </table> 1193 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
897 </div> 1194 <td>(</td>
898 <div class="memdoc"> 1195 <td class="paramname"></td><td>)</td>
1196 <td> const</td>
1197 </tr>
1198 </table>
1199 </td>
1200 <td class="mlabels-right">
1201 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1202 </tr>
1203 </table>
1204 </div><div class="memdoc">
899 1205
900 <p>Get the current program. </p> 1206 <p>Get the current program. </p>
901 1207
902 <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> 1208 <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>
903 1209
904 <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> 1210 <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>
905 1211
906 </div> 1212 </div>
907 </div> 1213 </div>
908 <a class="anchor" id="aadd3a547ef140bae200473a9518e3353"></a> 1214 <a id="aadd3a547ef140bae200473a9518e3353"></a>
909 <div class="memitem"> 1215 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">&#9670;&nbsp;</a></span>selectProgram()</h2>
910 <div class="memproto"> 1216
911 <table class="memname"> 1217 <div class="memitem">
912 <tr> 1218 <div class="memproto">
913 <td class="memname">virtual void <a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">Vamp::PluginBase::selectProgram</a> </td> 1219 <table class="mlabels">
1220 <tr>
1221 <td class="mlabels-left">
1222 <table class="memname">
1223 <tr>
1224 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
914 <td>(</td> 1225 <td>(</td>
915 <td class="paramtype">std::string&#160;</td> 1226 <td class="paramtype">std::string&#160;</td>
916 <td class="paramname"></td><td>)</td> 1227 <td class="paramname"></td><td>)</td>
917 <td><code> [inline, virtual, inherited]</code></td> 1228 <td></td>
918 </tr> 1229 </tr>
919 </table> 1230 </table>
920 </div> 1231 </td>
921 <div class="memdoc"> 1232 <td class="mlabels-right">
1233 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
1234 </tr>
1235 </table>
1236 </div><div class="memdoc">
922 1237
923 <p>Select a program. </p> 1238 <p>Select a program. </p>
924 <p>(If the given program name is not one of the available programs, do nothing.) </p> 1239 <p>(If the given program name is not one of the available programs, do nothing.) </p>
925 1240
926 <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> 1241 <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>
927 1242
928 <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> 1243 <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>
929 1244
930 </div> 1245 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
931 </div> 1246
932 <hr/><h2>Member Data Documentation</h2> 1247 </div>
933 <a class="anchor" id="a584f100b87c78f9af9da040d79567d52"></a> 1248 </div>
934 <div class="memitem"> 1249 <h2 class="groupheader">Member Data Documentation</h2>
935 <div class="memproto"> 1250 <a id="a584f100b87c78f9af9da040d79567d52"></a>
936 <table class="memname"> 1251 <h2 class="memtitle"><span class="permalink"><a href="#a584f100b87c78f9af9da040d79567d52">&#9670;&nbsp;</a></span>m_stepSize</h2>
937 <tr> 1252
938 <td class="memname">size_t <a class="el" href="classZeroCrossing.html#a584f100b87c78f9af9da040d79567d52">ZeroCrossing::m_stepSize</a><code> [protected]</code></td> 1253 <div class="memitem">
939 </tr> 1254 <div class="memproto">
940 </table> 1255 <table class="mlabels">
941 </div> 1256 <tr>
942 <div class="memdoc"> 1257 <td class="mlabels-left">
943 1258 <table class="memname">
944 <p>Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00073">73</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p> 1259 <tr>
945 1260 <td class="memname">size_t ZeroCrossing::m_stepSize</td>
946 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00094">initialise()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>.</p> 1261 </tr>
947 1262 </table>
948 </div> 1263 </td>
949 </div> 1264 <td class="mlabels-right">
950 <a class="anchor" id="a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"></a> 1265 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
951 <div class="memitem"> 1266 </tr>
952 <div class="memproto"> 1267 </table>
953 <table class="memname"> 1268 </div><div class="memdoc">
954 <tr> 1269
955 <td class="memname">float <a class="el" href="classZeroCrossing.html#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">ZeroCrossing::m_previousSample</a><code> [protected]</code></td> 1270 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00073">73</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
956 </tr> 1271
957 </table> 1272 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00095">initialise()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>.</p>
958 </div> 1273
959 <div class="memdoc"> 1274 </div>
960 1275 </div>
961 <p>Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00074">74</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p> 1276 <a id="a0f2d9f2cab0a8a30344e1f2c0ebb8ee8"></a>
962 1277 <h2 class="memtitle"><span class="permalink"><a href="#a0f2d9f2cab0a8a30344e1f2c0ebb8ee8">&#9670;&nbsp;</a></span>m_previousSample</h2>
963 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00105">reset()</a>.</p> 1278
964 1279 <div class="memitem">
965 </div> 1280 <div class="memproto">
966 </div> 1281 <table class="mlabels">
967 <a class="anchor" id="a59b9dd82a4f4eb946cd0474cc81abc23"></a> 1282 <tr>
968 <div class="memitem"> 1283 <td class="mlabels-left">
969 <div class="memproto"> 1284 <table class="memname">
970 <table class="memname"> 1285 <tr>
971 <tr> 1286 <td class="memname">float ZeroCrossing::m_previousSample</td>
972 <td class="memname">float <a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">Vamp::Plugin::m_inputSampleRate</a><code> [protected, inherited]</code></td> 1287 </tr>
973 </tr> 1288 </table>
974 </table> 1289 </td>
975 </div> 1290 <td class="mlabels-right">
976 <div class="memdoc"> 1291 <span class="mlabels"><span class="mlabel">protected</span></span> </td>
977 1292 </tr>
978 <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> 1293 </table>
979 1294 </div><div class="memdoc">
980 <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">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00105">AmplitudeFollower::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00252">FixedTempoEstimator::D::initialise()</a>, <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00363">FixedTempoEstimator::D::lag2tempo()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">process()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00369">FixedTempoEstimator::D::tempo2lag()</a>.</p> 1295
1296 <p class="definition">Definition at line <a class="el" href="ZeroCrossing_8h_source.html#l00074">74</a> of file <a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>.</p>
1297
1298 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>, and <a class="el" href="ZeroCrossing_8cpp_source.html#l00106">reset()</a>.</p>
1299
1300 </div>
1301 </div>
1302 <a id="a59b9dd82a4f4eb946cd0474cc81abc23"></a>
1303 <h2 class="memtitle"><span class="permalink"><a href="#a59b9dd82a4f4eb946cd0474cc81abc23">&#9670;&nbsp;</a></span>m_inputSampleRate</h2>
1304
1305 <div class="memitem">
1306 <div class="memproto">
1307 <table class="mlabels">
1308 <tr>
1309 <td class="mlabels-left">
1310 <table class="memname">
1311 <tr>
1312 <td class="memname">float Vamp::Plugin::m_inputSampleRate</td>
1313 </tr>
1314 </table>
1315 </td>
1316 <td class="mlabels-right">
1317 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
1318 </tr>
1319 </table>
1320 </div><div class="memdoc">
1321
1322 <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>
1323
1324 <p class="reference">Referenced by <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00106">AmplitudeFollower::initialise()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
981 1325
982 </div> 1326 </div>
983 </div> 1327 </div>
984 <hr/>The documentation for this class was generated from the following files:<ul> 1328 <hr/>The documentation for this class was generated from the following files:<ul>
985 <li><a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a></li> 1329 <li><a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a></li>
986 <li><a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a></li> 1330 <li><a class="el" href="ZeroCrossing_8cpp_source.html">ZeroCrossing.cpp</a></li>
987 </ul> 1331 </ul>
988 </div><!-- contents --> 1332 </div><!-- contents -->
989 </div> 1333 </div><!-- doc-content -->
990 <div id="nav-path" class="navpath"> 1334 <!-- start footer part -->
991 <ul> 1335 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
992 <li class="navelem"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a> </li> 1336 <ul>
993 1337 <li class="navelem"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a></li>
994 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by 1338 <li class="footer">Generated by
995 <a href="http://www.doxygen.org/index.html"> 1339 <a href="http://www.doxygen.org/index.html">
996 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 1340 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
997 </ul> 1341 </ul>
998 </div> 1342 </div>
999
1000
1001 </body> 1343 </body>
1002 </html> 1344 </html>