Mercurial > hg > vamp-docs
view code-docs/annotated.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
author | Chris Cannam |
---|---|
date | Fri, 13 Jul 2012 13:30:27 +0100 |
parents | 3c430ef1ed66 |
children | 27319718b1f8 |
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"/> <title>VampPluginSDK: Class List</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <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="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.4</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 class="current"><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('annotated.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">Class List</div> </div> </div><!--header--> <div class="contents"> <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><table> <tr><td class="indexkey"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td><td class="indexvalue">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins </td></tr> <tr><td class="indexkey"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a></td><td class="indexvalue">Example plugin implementing the SuperCollider amplitude follower function </td></tr> <tr><td class="indexkey"><a class="el" href="classFixedTempoEstimator_1_1D.html">FixedTempoEstimator::D</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Vamp::Plugin::Feature</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="classVamp_1_1FFT.html">Vamp::FFT</a></td><td class="indexvalue">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><td class="indexkey"><a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a></td><td class="indexvalue">Example plugin that estimates the tempo of a short fixed-tempo sample </td></tr> <tr><td class="indexkey"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">Vamp::Plugin::OutputDescriptor</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">Vamp::PluginBase::ParameterDescriptor</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a></td><td class="indexvalue">Example plugin that detects percussive events </td></tr> <tr><td class="indexkey"><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter< P ></a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1PluginAdapterBase.html">Vamp::PluginAdapterBase</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td class="indexvalue">A base class for plugins with optional configurable parameters, programs, etc </td></tr> <tr><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html">Vamp::HostExt::PluginBufferingAdapter</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html">Vamp::HostExt::PluginChannelAdapter</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1PluginHostAdapter.html">Vamp::PluginHostAdapter</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html">Vamp::HostExt::PluginInputDomainAdapter</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginLoader.html">Vamp::HostExt::PluginLoader</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html">Vamp::HostExt::PluginSummarisingAdapter</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html">Vamp::HostExt::PluginWrapper</a></td><td class="indexvalue"><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><td class="indexkey"><a class="el" href="classPowerSpectrum.html">PowerSpectrum</a></td><td class="indexvalue">Example plugin that returns a power spectrum calculated (trivially) from the frequency domain representation of each block of audio </td></tr> <tr><td class="indexkey"><a class="el" href="structVamp_1_1RealTime.html">Vamp::RealTime</a></td><td class="indexvalue"><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> <tr><td class="indexkey"><a class="el" href="classSpectralCentroid.html">SpectralCentroid</a></td><td class="indexvalue">Example plugin that calculates the centre of gravity of the frequency domain representation of each block of audio </td></tr> <tr><td class="indexkey"><a class="el" href="classZeroCrossing.html">ZeroCrossing</a></td><td class="indexvalue">Example plugin that calculates the positions and density of zero-crossing points in an audio waveform </td></tr> </table> </div><!-- contents --> </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>