Mercurial > hg > vamp-docs
view code-docs/hierarchy.html @ 7:66d125fb8b42 tip
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author | Chris Cannam |
---|---|
date | Fri, 24 Feb 2017 16:45:00 +0000 |
parents | 27319718b1f8 |
children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <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"/> <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="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, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.7</span> </div> </td> </tr> </tbody> </table> </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;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('hierarchy.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">Class Hierarchy</div> </div> </div><!--header--> <div class="contents"> <div class="textblock"> <p><a href="inherits.html">Go to the graphical class hierarchy</a></p> This inheritance list is sorted roughly, but not completely, alphabetically:</div><div class="directory"> <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory"> <tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampFeature.html" target="_self">_VampFeature</a></td><td class="desc"></td></tr> <tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampFeatureList.html" target="_self">_VampFeatureList</a></td><td class="desc"></td></tr> <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="union__VampFeatureUnion.html" target="_self">_VampFeatureUnion</a></td><td class="desc"></td></tr> <tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampFeatureV2.html" target="_self">_VampFeatureV2</a></td><td class="desc"></td></tr> <tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampOutputDescriptor.html" target="_self">_VampOutputDescriptor</a></td><td class="desc"></td></tr> <tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampParameterDescriptor.html" target="_self">_VampParameterDescriptor</a></td><td class="desc">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins </td></tr> <tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__VampPluginDescriptor.html" target="_self">_VampPluginDescriptor</a></td><td class="desc"></td></tr> <tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classFixedTempoEstimator_1_1D.html" target="_self">FixedTempoEstimator::D</a></td><td class="desc"></td></tr> <tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVamp_1_1Plugin_1_1Feature.html" target="_self">Vamp::Plugin::Feature</a></td><td class="desc"></td></tr> <tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1FFT.html" target="_self">Vamp::FFT</a></td><td class="desc">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors </td></tr> <tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1FFTComplex.html" target="_self">Vamp::FFTComplex</a></td><td class="desc">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors </td></tr> <tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1FFTReal.html" target="_self">Vamp::FFTReal</a></td><td class="desc">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors </td></tr> <tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html" target="_self">Vamp::Plugin::OutputDescriptor</a></td><td class="desc"></td></tr> <tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html" target="_self">Vamp::PluginBase::ParameterDescriptor</a></td><td class="desc"></td></tr> <tr id="row_14_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_14_" class="arrow" onclick="toggleFolder('14_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1PluginAdapterBase.html" target="_self">Vamp::PluginAdapterBase</a></td><td class="desc"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> provide a wrapper class that a plugin library can use to make its C++ <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> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API </td></tr> <tr id="row_14_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1PluginAdapter.html" target="_self">Vamp::PluginAdapter< P ></a></td><td class="desc"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation </td></tr> <tr id="row_15_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_15_" class="arrow" onclick="toggleFolder('15_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1PluginBase.html" target="_self">Vamp::PluginBase</a></td><td class="desc">A base class for plugins with optional configurable parameters, programs, etc </td></tr> <tr id="row_15_0_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_15_0_" class="arrow" onclick="toggleFolder('15_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1Plugin.html" target="_self">Vamp::Plugin</a></td><td class="desc"><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 </td></tr> <tr id="row_15_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classAmplitudeFollower.html" target="_self">AmplitudeFollower</a></td><td class="desc">Example plugin implementing the SuperCollider amplitude follower function </td></tr> <tr id="row_15_0_1_"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classFixedTempoEstimator.html" target="_self">FixedTempoEstimator</a></td><td class="desc">Example plugin that estimates the tempo of a short fixed-tempo sample </td></tr> <tr id="row_15_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPercussionOnsetDetector.html" target="_self">PercussionOnsetDetector</a></td><td class="desc">Example plugin that detects percussive events </td></tr> <tr id="row_15_0_3_"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPowerSpectrum.html" target="_self">PowerSpectrum</a></td><td class="desc">Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio </td></tr> <tr id="row_15_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSpectralCentroid.html" target="_self">SpectralCentroid</a></td><td class="desc">Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio </td></tr> <tr id="row_15_0_5_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span id="arr_15_0_5_" class="arrow" onclick="toggleFolder('15_0_5_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" target="_self">Vamp::HostExt::PluginWrapper</a></td><td class="desc"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. ">PluginWrapper</a> is a simple base class for adapter plugins </td></tr> <tr id="row_15_0_5_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" target="_self">Vamp::HostExt::PluginBufferingAdapter</a></td><td class="desc"><a class="el" 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...">PluginBufferingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that allows plugins to be used by a host supplying an audio stream in non-overlapping buffers of arbitrary size </td></tr> <tr id="row_15_0_5_1_"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" target="_self">Vamp::HostExt::PluginChannelAdapter</a></td><td class="desc"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that...">PluginChannelAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that implements a policy for management of plugins that expect a different number of input channels from the number actually available in the source audio data </td></tr> <tr id="row_15_0_5_2_" class="even"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" target="_self">Vamp::HostExt::PluginInputDomainAdapter</a></td><td class="desc"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma...">PluginInputDomainAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that converts time-domain input into frequency-domain input for plugins that need it </td></tr> <tr id="row_15_0_5_3_"><td class="entry"><span style="width:64px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" target="_self">Vamp::HostExt::PluginSummarisingAdapter</a></td><td class="desc"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an...">PluginSummarisingAdapter</a> is a <a class="el" href="namespaceVamp.html">Vamp</a> plugin adapter that provides summarisation methods such as mean and median averages of output features, for use in any context where an available plugin produces individual values but the result that is actually needed is some sort of aggregate </td></tr> <tr id="row_15_0_6_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1PluginHostAdapter.html" target="_self">Vamp::PluginHostAdapter</a></td><td class="desc"><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <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> object </td></tr> <tr id="row_15_0_7_"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classZeroCrossing.html" target="_self">ZeroCrossing</a></td><td class="desc">Example plugin that calculates the positions and density of zero-crossing points in an audio waveform </td></tr> <tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" target="_self">Vamp::HostExt::PluginLoader</a></td><td class="desc"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html" title="Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the...">Vamp::HostExt::PluginLoader</a> is a convenience class for discovering and loading <a class="el" href="namespaceVamp.html">Vamp</a> plugins using the typical plugin-path, library naming, and categorisation conventions described in the <a class="el" href="namespaceVamp.html">Vamp</a> SDK documentation </td></tr> <tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVamp_1_1RealTime.html" target="_self">Vamp::RealTime</a></td><td class="desc"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions </td></tr> </table> </div><!-- directory --> </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> </body> </html>