Mercurial > hg > vamp-docs

comparison code-docs/vamp-sdk_2Plugin_8h.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: Plugin.h File Reference</title> 8 <title>VampPluginSDK: Plugin.h File 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
35 </td> 31 </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><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree"> 48 <div id="nav-tree">
63 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
64 </div> 51 </div>
65 </div> 52 </div>
66 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
68 </div> 55 </div>
69 </div> 56 </div>
70 <script type="text/javascript"> 57 <script type="text/javascript">
71 initNavTree('vamp-sdk_2Plugin_8h.html',''); 58 $(document).ready(function(){initNavTree('vamp-sdk_2Plugin_8h.html','');});
72 </script> 59 </script>
73 <div id="doc-content"> 60 <div id="doc-content">
74 <div class="header"> 61 <div class="header">
75 <div class="summary"> 62 <div class="summary">
76 <a href="#nested-classes">Classes</a> &#124; 63 <a href="#nested-classes">Classes</a> &#124;
77 <a href="#namespaces">Namespaces</a> </div> 64 <a href="#namespaces">Namespaces</a> </div>
78 <div class="headertitle"> 65 <div class="headertitle">
79 <div class="title">vamp-sdk/Plugin.h File Reference</div> </div> 66 <div class="title">vamp-sdk/Plugin.h File Reference</div> </div>
80 </div><!--header--> 67 </div><!--header-->
81 <div class="contents"> 68 <div class="contents">
82 69 <div class="textblock"><code>#include &lt;string&gt;</code><br />
70 <code>#include &lt;vector&gt;</code><br />
71 <code>#include &lt;map&gt;</code><br />
72 <code>#include &quot;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&quot;</code><br />
73 <code>#include &quot;<a class="el" href="vamp-sdk_2RealTime_8h_source.html">RealTime.h</a>&quot;</code><br />
74 <code>#include &quot;<a class="el" href="plugguard_8h_source.html">plugguard.h</a>&quot;</code><br />
75 </div><div class="textblock"><div class="dynheader">
76 Include dependency graph for vamp-sdk/Plugin.h:</div>
77 <div class="dyncontent">
78 <div class="center"><img src="vamp-sdk_2Plugin_8h__incl.png" border="0" usemap="#Plugin_8h" alt=""/></div>
79 <map name="Plugin_8h" id="Plugin_8h">
80 <area shape="rect" id="node5" href="vamp-sdk_2PluginBase_8h.html" title="PluginBase.h" alt="" coords="41,79,135,104"/>
81 <area shape="rect" id="node6" href="plugguard_8h.html" title="plugguard.h" alt="" coords="288,152,376,177"/>
82 <area shape="rect" id="node7" href="vamp-sdk_2RealTime_8h.html" title="RealTime.h" alt="" coords="210,79,294,104"/>
83 </map>
84 </div>
85 </div><div class="textblock"><div class="dynheader">
86 This graph shows which files directly or indirectly include this file:</div>
87 <div class="dyncontent">
88 <div class="center"><img src="vamp-sdk_2Plugin_8h__dep__incl.png" border="0" usemap="#Plugin_8hdep" alt=""/></div>
89 <map name="Plugin_8hdep" id="Plugin_8hdep">
90 <area shape="rect" id="node2" href="PluginAdapter_8h.html" title="PluginAdapter.h" alt="" coords="355,79,463,104"/>
91 <area shape="rect" id="node4" href="vamp-sdk_8h.html" title="vamp&#45;sdk.h" alt="" coords="1103,79,1190,104"/>
92 <area shape="rect" id="node5" href="vamp-hostsdk_2Plugin_8h.html" title="Plugin.h" alt="" coords="1343,79,1409,104"/>
93 <area shape="rect" id="node15" href="AmplitudeFollower_8h.html" title="AmplitudeFollower.h" alt="" coords="24,79,157,104"/>
94 <area shape="rect" id="node17" href="FixedTempoEstimator_8h.html" title="FixedTempoEstimator.h" alt="" coords="181,79,331,104"/>
95 <area shape="rect" id="node19" href="PercussionOnsetDetector_8h.html" title="PercussionOnsetDetector.h" alt="" coords="488,79,659,104"/>
96 <area shape="rect" id="node21" href="ZeroCrossing_8h.html" title="ZeroCrossing.h" alt="" coords="683,79,789,104"/>
97 <area shape="rect" id="node23" href="SpectralCentroid_8h.html" title="SpectralCentroid.h" alt="" coords="813,79,937,104"/>
98 <area shape="rect" id="node25" href="PowerSpectrum_8h.html" title="PowerSpectrum.h" alt="" coords="961,79,1079,104"/>
99 <area shape="rect" id="node3" href="plugins_8cpp.html" title="plugins.cpp" alt="" coords="365,152,451,177"/>
100 <area shape="rect" id="node6" href="PluginWrapper_8h.html" title="PluginWrapper.h" alt="" coords="1449,152,1559,177"/>
101 <area shape="rect" id="node8" href="vamp-hostsdk_8h.html" title="vamp&#45;hostsdk.h" alt="" coords="1545,299,1655,324"/>
102 <area shape="rect" id="node14" href="PluginHostAdapter_8h.html" title="PluginHostAdapter.h" alt="" coords="2141,225,2275,251"/>
103 <area shape="rect" id="node7" href="PluginBufferingAdapter_8h.html" title="PluginBufferingAdapter.h" alt="" coords="1245,225,1403,251"/>
104 <area shape="rect" id="node9" href="PluginChannelAdapter_8h.html" title="PluginChannelAdapter.h" alt="" coords="1427,225,1581,251"/>
105 <area shape="rect" id="node10" href="PluginInputDomainAdapter_8h.html" title="PluginInputDomainAdapter.h" alt="" coords="1811,225,1989,251"/>
106 <area shape="rect" id="node12" href="PluginLoader_8h.html" title="PluginLoader.h" alt="" coords="2014,225,2117,251"/>
107 <area shape="rect" id="node13" href="PluginSummarisingAdapter_8h.html" title="PluginSummarisingAdapter.h" alt="" coords="1605,225,1787,251"/>
108 <area shape="rect" id="node11" href="vamp-simple-host_8cpp.html" title="vamp&#45;simple&#45;host.cpp" alt="" coords="1993,299,2138,324"/>
109 <area shape="rect" id="node16" href="AmplitudeFollower_8cpp.html" title="AmplitudeFollower.cpp" alt="" coords="5,152,152,177"/>
110 <area shape="rect" id="node18" href="FixedTempoEstimator_8cpp.html" title="FixedTempoEstimator.cpp" alt="" coords="176,152,339,177"/>
111 <area shape="rect" id="node20" href="PercussionOnsetDetector_8cpp.html" title="PercussionOnsetDetector.cpp" alt="" coords="475,152,659,177"/>
112 <area shape="rect" id="node22" href="ZeroCrossing_8cpp.html" title="ZeroCrossing.cpp" alt="" coords="683,152,802,177"/>
113 <area shape="rect" id="node24" href="SpectralCentroid_8cpp.html" title="SpectralCentroid.cpp" alt="" coords="826,152,963,177"/>
114 <area shape="rect" id="node26" href="PowerSpectrum_8cpp.html" title="PowerSpectrum.cpp" alt="" coords="987,152,1119,177"/>
115 </map>
116 </div>
117 </div>
83 <p><a href="vamp-sdk_2Plugin_8h_source.html">Go to the source code of this file.</a></p> 118 <p><a href="vamp-sdk_2Plugin_8h_source.html">Go to the source code of this file.</a></p>
84 <table class="memberdecls"> 119 <table class="memberdecls">
85 <tr><td colspan="2"><h2><a name="nested-classes"></a> 120 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
86 Classes</h2></td></tr> 121 Classes</h2></td></tr>
87 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td></tr> 122 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td></tr>
88 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#details">More...</a><br/></td></tr> 123 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#details">More...</a><br /></td></tr>
124 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::OutputDescriptor</a></td></tr> 125 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::OutputDescriptor</a></td></tr>
126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Feature</a></td></tr> 127 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Feature</a></td></tr>
91 <tr><td colspan="2"><h2><a name="namespaces"></a> 128 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 </table><table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
92 Namespaces</h2></td></tr> 131 Namespaces</h2></td></tr>
93 <tr class="memitem:namespaceVamp"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html">Vamp</a></td></tr> 132 <tr class="memitem:namespaceVamp"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html">Vamp</a></td></tr>
133 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 </table> 134 </table>
95 </div><!-- contents --> 135 </div><!-- contents -->
136 </div><!-- doc-content -->
137 <!-- start footer part -->
138 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
139 <ul>
140 <li class="navelem"><a class="el" href="dir_8661d6ced9d80e9e8c7982a58cd73404.html">vamp-sdk</a></li><li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a></li>
141 <li class="footer">Generated by
142 <a href="http://www.doxygen.org/index.html">
143 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
144 </ul>
96 </div> 145 </div>
97 <div id="nav-path" class="navpath">
98 <ul>
99 <li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a> </li>
100
101 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
102 <a href="http://www.doxygen.org/index.html">
103 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
104 </ul>
105 </div>
106
107
108 </body> 146 </body>
109 </html> 147 </html>