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

Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
line wrap: on
line diff
--- a/code-docs/vamp-sdk_2Plugin_8h.html	Tue Dec 03 16:43:33 2013 +0000
+++ b/code-docs/vamp-sdk_2Plugin_8h.html	Fri Feb 24 16:44:47 2017 +0000
@@ -3,64 +3,51 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>VampPluginSDK: Plugin.h File Reference</title>
-
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript">
   $(document).ready(initResizable);
 </script>
-
-
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
-<div id="top"><!-- do not remove this div! -->
-
-
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
-  
-  
-  <td style="padding-left: 0.5em;">
+  <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">VampPluginSDK
-   &#160;<span id="projectnumber">2.4</span>
+   &#160;<span id="projectnumber">2.7</span>
    </div>
-   
   </td>
-  
-  
-  
  </tr>
  </tbody>
 </table>
 </div>
-
-<!-- Generated by Doxygen 1.8.0 -->
-  <div id="navrow1" class="tabs">
-    <ul class="tablist">
-      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
-      <li><a href="annotated.html"><span>Classes</span></a></li>
-      <li class="current"><a href="files.html"><span>Files</span></a></li>
-      <li><a href="dirs.html"><span>Directories</span></a></li>
-    </ul>
-  </div>
-  <div id="navrow2" class="tabs2">
-    <ul class="tablist">
-      <li><a href="files.html"><span>File&#160;List</span></a></li>
-      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
-    </ul>
-  </div>
-</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',false,false,'search.php','Search');
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;" 
@@ -68,7 +55,7 @@
   </div>
 </div>
 <script type="text/javascript">
-  initNavTree('vamp-sdk_2Plugin_8h.html','');
+$(document).ready(function(){initNavTree('vamp-sdk_2Plugin_8h.html','');});
 </script>
 <div id="doc-content">
 <div class="header">
@@ -79,31 +66,82 @@
 <div class="title">vamp-sdk/Plugin.h File Reference</div>  </div>
 </div><!--header-->
 <div class="contents">
-
+<div class="textblock"><code>#include &lt;string&gt;</code><br />
+<code>#include &lt;vector&gt;</code><br />
+<code>#include &lt;map&gt;</code><br />
+<code>#include &quot;<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="vamp-sdk_2RealTime_8h_source.html">RealTime.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="plugguard_8h_source.html">plugguard.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for vamp-sdk/Plugin.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="vamp-sdk_2Plugin_8h__incl.png" border="0" usemap="#Plugin_8h" alt=""/></div>
+<map name="Plugin_8h" id="Plugin_8h">
+<area shape="rect" id="node5" href="vamp-sdk_2PluginBase_8h.html" title="PluginBase.h" alt="" coords="41,79,135,104"/>
+<area shape="rect" id="node6" href="plugguard_8h.html" title="plugguard.h" alt="" coords="288,152,376,177"/>
+<area shape="rect" id="node7" href="vamp-sdk_2RealTime_8h.html" title="RealTime.h" alt="" coords="210,79,294,104"/>
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="vamp-sdk_2Plugin_8h__dep__incl.png" border="0" usemap="#Plugin_8hdep" alt=""/></div>
+<map name="Plugin_8hdep" id="Plugin_8hdep">
+<area shape="rect" id="node2" href="PluginAdapter_8h.html" title="PluginAdapter.h" alt="" coords="355,79,463,104"/>
+<area shape="rect" id="node4" href="vamp-sdk_8h.html" title="vamp&#45;sdk.h" alt="" coords="1103,79,1190,104"/>
+<area shape="rect" id="node5" href="vamp-hostsdk_2Plugin_8h.html" title="Plugin.h" alt="" coords="1343,79,1409,104"/>
+<area shape="rect" id="node15" href="AmplitudeFollower_8h.html" title="AmplitudeFollower.h" alt="" coords="24,79,157,104"/>
+<area shape="rect" id="node17" href="FixedTempoEstimator_8h.html" title="FixedTempoEstimator.h" alt="" coords="181,79,331,104"/>
+<area shape="rect" id="node19" href="PercussionOnsetDetector_8h.html" title="PercussionOnsetDetector.h" alt="" coords="488,79,659,104"/>
+<area shape="rect" id="node21" href="ZeroCrossing_8h.html" title="ZeroCrossing.h" alt="" coords="683,79,789,104"/>
+<area shape="rect" id="node23" href="SpectralCentroid_8h.html" title="SpectralCentroid.h" alt="" coords="813,79,937,104"/>
+<area shape="rect" id="node25" href="PowerSpectrum_8h.html" title="PowerSpectrum.h" alt="" coords="961,79,1079,104"/>
+<area shape="rect" id="node3" href="plugins_8cpp.html" title="plugins.cpp" alt="" coords="365,152,451,177"/>
+<area shape="rect" id="node6" href="PluginWrapper_8h.html" title="PluginWrapper.h" alt="" coords="1449,152,1559,177"/>
+<area shape="rect" id="node8" href="vamp-hostsdk_8h.html" title="vamp&#45;hostsdk.h" alt="" coords="1545,299,1655,324"/>
+<area shape="rect" id="node14" href="PluginHostAdapter_8h.html" title="PluginHostAdapter.h" alt="" coords="2141,225,2275,251"/>
+<area shape="rect" id="node7" href="PluginBufferingAdapter_8h.html" title="PluginBufferingAdapter.h" alt="" coords="1245,225,1403,251"/>
+<area shape="rect" id="node9" href="PluginChannelAdapter_8h.html" title="PluginChannelAdapter.h" alt="" coords="1427,225,1581,251"/>
+<area shape="rect" id="node10" href="PluginInputDomainAdapter_8h.html" title="PluginInputDomainAdapter.h" alt="" coords="1811,225,1989,251"/>
+<area shape="rect" id="node12" href="PluginLoader_8h.html" title="PluginLoader.h" alt="" coords="2014,225,2117,251"/>
+<area shape="rect" id="node13" href="PluginSummarisingAdapter_8h.html" title="PluginSummarisingAdapter.h" alt="" coords="1605,225,1787,251"/>
+<area shape="rect" id="node11" href="vamp-simple-host_8cpp.html" title="vamp&#45;simple&#45;host.cpp" alt="" coords="1993,299,2138,324"/>
+<area shape="rect" id="node16" href="AmplitudeFollower_8cpp.html" title="AmplitudeFollower.cpp" alt="" coords="5,152,152,177"/>
+<area shape="rect" id="node18" href="FixedTempoEstimator_8cpp.html" title="FixedTempoEstimator.cpp" alt="" coords="176,152,339,177"/>
+<area shape="rect" id="node20" href="PercussionOnsetDetector_8cpp.html" title="PercussionOnsetDetector.cpp" alt="" coords="475,152,659,177"/>
+<area shape="rect" id="node22" href="ZeroCrossing_8cpp.html" title="ZeroCrossing.cpp" alt="" coords="683,152,802,177"/>
+<area shape="rect" id="node24" href="SpectralCentroid_8cpp.html" title="SpectralCentroid.cpp" alt="" coords="826,152,963,177"/>
+<area shape="rect" id="node26" href="PowerSpectrum_8cpp.html" title="PowerSpectrum.cpp" alt="" coords="987,152,1119,177"/>
+</map>
+</div>
+</div>
 <p><a href="vamp-sdk_2Plugin_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
-<tr><td colspan="2"><h2><a name="nested-classes"></a>
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 Classes</h2></td></tr>
 <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>
-<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
-<tr><td colspan="2"><h2><a name="namespaces"></a>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
 Namespaces</h2></td></tr>
-<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <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>
+    <li class="footer">Generated by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+  </ul>
 </div>
-  <div id="nav-path" class="navpath">
-    <ul>
-      <li class="navelem"><a class="el" href="vamp-sdk_2Plugin_8h.html">Plugin.h</a>      </li>
-
-    <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
-   </ul>
- </div>
-
-
 </body>
 </html>