Mercurial > hg > vamp-docs
diff code-docs/inherits.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/inherits.html Tue Dec 03 16:43:33 2013 +0000 +++ b/code-docs/inherits.html Fri Feb 24 16:44:47 2017 +0000 @@ -3,65 +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: Class Hierarchy</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 -  <span id="projectnumber">2.4</span> +  <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 Page</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><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="annotated.html"><span>Class List</span></a></li> - <li class="current"><a href="inherits.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Class 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;" @@ -69,7 +55,7 @@ </div> </div> <script type="text/javascript"> - initNavTree('hierarchy.html',''); +$(document).ready(function(){initNavTree('hierarchy.html','');}); </script> <div id="doc-content"> <div class="header"> @@ -82,80 +68,118 @@ </div><table border="0" cellspacing="10" cellpadding="0"> <tr><td><img src="inherit_graph_0.png" border="0" alt="" usemap="#__VampFeature"/> <map name="__VampFeature" id="__VampFeature"> -<area shape="rect" id="node1" href="struct__VampFeature.html" title="_VampFeature" alt="" coords="6,5,103,30"/></map> +<area shape="rect" id="node1" href="struct__VampFeature.html" title="_VampFeature" alt="" coords="5,5,104,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_1.png" border="0" alt="" usemap="#__VampFeatureList"/> <map name="__VampFeatureList" id="__VampFeatureList"> -<area shape="rect" id="node1" href="struct__VampFeatureList.html" title="_VampFeatureList" alt="" coords="5,5,120,30"/></map> +<area shape="rect" id="node1" href="struct__VampFeatureList.html" title="_VampFeatureList" alt="" coords="5,5,124,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_2.png" border="0" alt="" usemap="#__VampFeatureUnion"/> <map name="__VampFeatureUnion" id="__VampFeatureUnion"> -<area shape="rect" id="node1" href="union__VampFeatureUnion.html" title="_VampFeatureUnion" alt="" coords="6,5,135,30"/></map> +<area shape="rect" id="node1" href="union__VampFeatureUnion.html" title="_VampFeatureUnion" alt="" coords="5,5,136,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_3.png" border="0" alt="" usemap="#__VampFeatureV2"/> <map name="__VampFeatureV2" id="__VampFeatureV2"> -<area shape="rect" id="node1" href="struct__VampFeatureV2.html" title="_VampFeatureV2" alt="" coords="6,5,117,30"/></map> +<area shape="rect" id="node1" href="struct__VampFeatureV2.html" title="_VampFeatureV2" alt="" coords="5,5,119,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_4.png" border="0" alt="" usemap="#__VampOutputDescriptor"/> <map name="__VampOutputDescriptor" id="__VampOutputDescriptor"> -<area shape="rect" id="node1" href="struct__VampOutputDescriptor.html" title="_VampOutputDescriptor" alt="" coords="6,5,157,30"/></map> +<area shape="rect" id="node1" href="struct__VampOutputDescriptor.html" title="_VampOutputDescriptor" alt="" coords="5,5,157,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_5.png" border="0" alt="" usemap="#__VampParameterDescriptor"/> <map name="__VampParameterDescriptor" id="__VampParameterDescriptor"> -<area shape="rect" id="node1" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins." alt="" coords="6,5,173,30"/></map> +<area shape="rect" id="node1" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins. " alt="" coords="5,5,176,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_6.png" border="0" alt="" usemap="#__VampPluginDescriptor"/> <map name="__VampPluginDescriptor" id="__VampPluginDescriptor"> -<area shape="rect" id="node1" href="struct__VampPluginDescriptor.html" title="_VampPluginDescriptor" alt="" coords="5,5,152,30"/></map> +<area shape="rect" id="node1" href="struct__VampPluginDescriptor.html" title="_VampPluginDescriptor" alt="" coords="5,5,153,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_7.png" border="0" alt="" usemap="#FixedTempoEstimator_1_1D"/> <map name="FixedTempoEstimator_1_1D" id="FixedTempoEstimator_1_1D"> -<area shape="rect" id="node1" href="classFixedTempoEstimator_1_1D.html" title="FixedTempoEstimator::D" alt="" coords="5,5,157,30"/></map> +<area shape="rect" id="node1" href="classFixedTempoEstimator_1_1D.html" title="FixedTempoEstimator::D" alt="" coords="5,5,161,31"/> +</map> </td></tr> <tr><td><img src="inherit_graph_8.png" border="0" alt="" usemap="#Vamp_1_1FFT"/> <map name="Vamp_1_1FFT" id="Vamp_1_1FFT"> -<area shape="rect" id="node1" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors." alt="" coords="6,5,85,30"/></map> +<area shape="rect" id="node1" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. " alt="" coords="5,5,85,31"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_9.png" border="0" alt="" usemap="#Vamp_1_1HostExt_1_1PluginLoader"/> +<tr><td><img src="inherit_graph_9.png" border="0" alt="" usemap="#Vamp_1_1FFTComplex"/> +<map name="Vamp_1_1FFTComplex" id="Vamp_1_1FFTComplex"> +<area shape="rect" id="node1" href="classVamp_1_1FFTComplex.html" title="A simple FFT implementation provided for convenience of plugin authors. " alt="" coords="5,5,133,31"/> +</map> +</td></tr> +<tr><td><img src="inherit_graph_10.png" border="0" alt="" usemap="#Vamp_1_1FFTReal"/> +<map name="Vamp_1_1FFTReal" id="Vamp_1_1FFTReal"> +<area shape="rect" id="node1" href="classVamp_1_1FFTReal.html" title="A simple FFT implementation provided for convenience of plugin authors. " alt="" coords="5,5,109,31"/> +</map> +</td></tr> +<tr><td><img src="inherit_graph_11.png" border="0" alt="" usemap="#Vamp_1_1HostExt_1_1PluginLoader"/> <map name="Vamp_1_1HostExt_1_1PluginLoader" id="Vamp_1_1HostExt_1_1PluginLoader"> -<area shape="rect" id="node1" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the..." alt="" coords="5,5,181,30"/></map> +<area shape="rect" id="node1" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the..." alt="" coords="5,5,188,31"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_10.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1Feature"/> +<tr><td><img src="inherit_graph_12.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1Feature"/> <map name="Vamp_1_1Plugin_1_1Feature" id="Vamp_1_1Plugin_1_1Feature"> -<area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1Feature.html" title="Vamp::Plugin::Feature" alt="" coords="6,5,143,30"/></map> +<area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1Feature.html" title="Vamp::Plugin::Feature" alt="" coords="5,5,149,31"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_11.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1OutputDescriptor"/> +<tr><td><img src="inherit_graph_13.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1OutputDescriptor"/> <map name="Vamp_1_1Plugin_1_1OutputDescriptor" id="Vamp_1_1Plugin_1_1OutputDescriptor"> -<area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1OutputDescriptor.html" title="Vamp::Plugin::OutputDescriptor" alt="" coords="6,5,197,30"/></map> +<area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1OutputDescriptor.html" title="Vamp::Plugin::OutputDescriptor" alt="" coords="5,5,203,31"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_12.png" border="0" alt="" usemap="#Vamp_1_1PluginAdapterBase"/> +<tr><td><img src="inherit_graph_14.png" border="0" alt="" usemap="#Vamp_1_1PluginAdapterBase"/> <map name="Vamp_1_1PluginAdapterBase" id="Vamp_1_1PluginAdapterBase"> -<area shape="rect" id="node1" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its..." alt="" coords="5,5,165,30"/><area shape="rect" id="node3" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio..." alt="" coords="214,5,378,30"/></map> +<area shape="rect" id="node1" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its..." alt="" coords="5,5,171,31"/> +<area shape="rect" id="node2" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio..." alt="" coords="219,5,388,31"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_13.png" border="0" alt="" usemap="#Vamp_1_1PluginBase"/> +<tr><td><img src="inherit_graph_15.png" border="0" alt="" usemap="#Vamp_1_1PluginBase"/> <map name="Vamp_1_1PluginBase" id="Vamp_1_1PluginBase"> -<area shape="rect" id="node1" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc." alt="" coords="6,178,125,203"/><area shape="rect" id="node3" 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="174,178,266,203"/><area shape="rect" id="node5" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function." alt="" coords="345,5,468,30"/><area shape="rect" id="node7" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed-tempo sample." alt="" coords="338,54,475,79"/><area shape="rect" id="node9" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events." alt="" coords="329,103,484,129"/><area shape="rect" id="node11" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe..." alt="" coords="353,153,460,178"/><area shape="rect" id="node13" href="classSpectralCentroid.html" title="Example plugin that calculates the centre of gravity of the frequency domain representation of each b..." alt="" coords="351,202,463,227"/><area shape="rect" id="node15" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins." alt="" coords="315,251,499,277"/><area shape="rect" id="node25" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri..." alt="" coords="327,301,486,326"/><area shape="rect" id="node27" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero-crossing points in an audio waveform..." alt="" coords="360,350,453,375"/><area shape="rect" id="node17" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="558,178,789,203"/><area shape="rect" id="node19" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="560,227,787,253"/><area shape="rect" id="node21" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma..." alt="" coords="547,277,800,302"/><area shape="rect" id="node23" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="547,326,800,351"/></map> +<area shape="rect" id="node1" href="classVamp_1_1PluginBase.html" title="A base class for plugins with optional configurable parameters, programs, etc. " alt="" coords="5,179,128,204"/> +<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="176,179,271,204"/> +<area shape="rect" id="node3" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function. " alt="" coords="352,5,476,31"/> +<area shape="rect" id="node4" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed-tempo sample. " alt="" coords="344,55,484,80"/> +<area shape="rect" id="node5" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events. " alt="" coords="333,104,495,129"/> +<area shape="rect" id="node6" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe..." alt="" coords="359,153,469,179"/> +<area shape="rect" id="node7" href="classSpectralCentroid.html" title="Example plugin that calculates the centre of gravity of the frequency domain representation of each b..." alt="" coords="357,203,471,228"/> +<area shape="rect" id="node8" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. " alt="" coords="319,252,509,277"/> +<area shape="rect" id="node13" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri..." alt="" coords="333,301,495,327"/> +<area shape="rect" id="node14" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero-crossing points in an audio waveform..." alt="" coords="367,351,461,376"/> +<area shape="rect" id="node9" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="569,152,764,191"/> +<area shape="rect" id="node10" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="571,215,762,253"/> +<area shape="rect" id="node11" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma..." alt="" coords="580,277,753,316"/> +<area shape="rect" id="node12" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="557,340,776,379"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_14.png" border="0" alt="" usemap="#Vamp_1_1PluginBase_1_1ParameterDescriptor"/> +<tr><td><img src="inherit_graph_16.png" border="0" alt="" usemap="#Vamp_1_1PluginBase_1_1ParameterDescriptor"/> <map name="Vamp_1_1PluginBase_1_1ParameterDescriptor" id="Vamp_1_1PluginBase_1_1ParameterDescriptor"> -<area shape="rect" id="node1" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html" title="Vamp::PluginBase::ParameterDescriptor" alt="" coords="6,5,239,30"/></map> +<area shape="rect" id="node1" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html" title="Vamp::PluginBase::Parameter\lDescriptor" alt="" coords="5,5,192,44"/> +</map> </td></tr> -<tr><td><img src="inherit_graph_15.png" border="0" alt="" usemap="#Vamp_1_1RealTime"/> +<tr><td><img src="inherit_graph_17.png" border="0" alt="" usemap="#Vamp_1_1RealTime"/> <map name="Vamp_1_1RealTime" id="Vamp_1_1RealTime"> -<area shape="rect" id="node1" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve..." alt="" coords="6,5,114,30"/></map> +<area shape="rect" id="node1" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve..." alt="" coords="5,5,119,31"/> +</map> </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="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="footer">Generated on Fri Jul 13 2012 13:28:49 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>