annotate code-docs/inherits.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: Class Hierarchy</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 56 <li class="current"><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('hierarchy.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="headertitle">
Chris@1 76 <div class="title">Class Hierarchy</div> </div>
Chris@1 77 </div>
Chris@1 78 <div class="contents">
Chris@1 79 <div class="textblock">
Chris@1 80 <p><a href="hierarchy.html">Go to the textual class hierarchy</a></p>
Chris@1 81 </div><table border="0" cellspacing="10" cellpadding="0">
Chris@1 82 <tr><td><img src="inherit_graph_0.png" border="0" alt="" usemap="#__VampFeature"/>
Chris@1 83 <map name="__VampFeature" id="__VampFeature">
Chris@1 84 <area shape="rect" id="node1" href="struct__VampFeature.html" title="_VampFeature" alt="" coords="6,5,103,30"/></map>
Chris@1 85 </td></tr>
Chris@1 86 <tr><td><img src="inherit_graph_1.png" border="0" alt="" usemap="#__VampFeatureList"/>
Chris@1 87 <map name="__VampFeatureList" id="__VampFeatureList">
Chris@1 88 <area shape="rect" id="node1" href="struct__VampFeatureList.html" title="_VampFeatureList" alt="" coords="5,5,120,30"/></map>
Chris@1 89 </td></tr>
Chris@1 90 <tr><td><img src="inherit_graph_2.png" border="0" alt="" usemap="#__VampFeatureUnion"/>
Chris@1 91 <map name="__VampFeatureUnion" id="__VampFeatureUnion">
Chris@1 92 <area shape="rect" id="node1" href="union__VampFeatureUnion.html" title="_VampFeatureUnion" alt="" coords="6,5,135,30"/></map>
Chris@1 93 </td></tr>
Chris@1 94 <tr><td><img src="inherit_graph_3.png" border="0" alt="" usemap="#__VampFeatureV2"/>
Chris@1 95 <map name="__VampFeatureV2" id="__VampFeatureV2">
Chris@1 96 <area shape="rect" id="node1" href="struct__VampFeatureV2.html" title="_VampFeatureV2" alt="" coords="6,5,117,30"/></map>
Chris@1 97 </td></tr>
Chris@1 98 <tr><td><img src="inherit_graph_4.png" border="0" alt="" usemap="#__VampOutputDescriptor"/>
Chris@1 99 <map name="__VampOutputDescriptor" id="__VampOutputDescriptor">
Chris@1 100 <area shape="rect" id="node1" href="struct__VampOutputDescriptor.html" title="_VampOutputDescriptor" alt="" coords="6,5,157,30"/></map>
Chris@1 101 </td></tr>
Chris@1 102 <tr><td><img src="inherit_graph_5.png" border="0" alt="" usemap="#__VampParameterDescriptor"/>
Chris@1 103 <map name="__VampParameterDescriptor" id="__VampParameterDescriptor">
Chris@1 104 <area shape="rect" id="node1" href="struct__VampParameterDescriptor.html" title="C language API for Vamp plugins." alt="" coords="6,5,173,30"/></map>
Chris@1 105 </td></tr>
Chris@1 106 <tr><td><img src="inherit_graph_6.png" border="0" alt="" usemap="#__VampPluginDescriptor"/>
Chris@1 107 <map name="__VampPluginDescriptor" id="__VampPluginDescriptor">
Chris@1 108 <area shape="rect" id="node1" href="struct__VampPluginDescriptor.html" title="_VampPluginDescriptor" alt="" coords="5,5,152,30"/></map>
Chris@1 109 </td></tr>
Chris@1 110 <tr><td><img src="inherit_graph_7.png" border="0" alt="" usemap="#FixedTempoEstimator_1_1D"/>
Chris@1 111 <map name="FixedTempoEstimator_1_1D" id="FixedTempoEstimator_1_1D">
Chris@1 112 <area shape="rect" id="node1" href="classFixedTempoEstimator_1_1D.html" title="FixedTempoEstimator::D" alt="" coords="5,5,157,30"/></map>
Chris@1 113 </td></tr>
Chris@1 114 <tr><td><img src="inherit_graph_8.png" border="0" alt="" usemap="#Vamp_1_1HostExt_1_1PluginLoader"/>
Chris@1 115 <map name="Vamp_1_1HostExt_1_1PluginLoader" id="Vamp_1_1HostExt_1_1PluginLoader">
Chris@1 116 <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>
Chris@1 117 </td></tr>
Chris@1 118 <tr><td><img src="inherit_graph_9.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1Feature"/>
Chris@1 119 <map name="Vamp_1_1Plugin_1_1Feature" id="Vamp_1_1Plugin_1_1Feature">
Chris@1 120 <area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1Feature.html" title="Vamp::Plugin::Feature" alt="" coords="6,5,143,30"/></map>
Chris@1 121 </td></tr>
Chris@1 122 <tr><td><img src="inherit_graph_10.png" border="0" alt="" usemap="#Vamp_1_1Plugin_1_1OutputDescriptor"/>
Chris@1 123 <map name="Vamp_1_1Plugin_1_1OutputDescriptor" id="Vamp_1_1Plugin_1_1OutputDescriptor">
Chris@1 124 <area shape="rect" id="node1" href="structVamp_1_1Plugin_1_1OutputDescriptor.html" title="Vamp::Plugin::OutputDescriptor" alt="" coords="6,5,197,30"/></map>
Chris@1 125 </td></tr>
Chris@1 126 <tr><td><img src="inherit_graph_11.png" border="0" alt="" usemap="#Vamp_1_1PluginAdapterBase"/>
Chris@1 127 <map name="Vamp_1_1PluginAdapterBase" id="Vamp_1_1PluginAdapterBase">
Chris@1 128 <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>
Chris@1 129 </td></tr>
Chris@1 130 <tr><td><img src="inherit_graph_12.png" border="0" alt="" usemap="#Vamp_1_1PluginBase"/>
Chris@1 131 <map name="Vamp_1_1PluginBase" id="Vamp_1_1PluginBase">
Chris@1 132 <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&#45;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&#45;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&#45;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&#45;domain input into frequency&#45;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>
Chris@1 133 </td></tr>
Chris@1 134 <tr><td><img src="inherit_graph_13.png" border="0" alt="" usemap="#Vamp_1_1PluginBase_1_1ParameterDescriptor"/>
Chris@1 135 <map name="Vamp_1_1PluginBase_1_1ParameterDescriptor" id="Vamp_1_1PluginBase_1_1ParameterDescriptor">
Chris@1 136 <area shape="rect" id="node1" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html" title="Vamp::PluginBase::ParameterDescriptor" alt="" coords="6,5,239,30"/></map>
Chris@1 137 </td></tr>
Chris@1 138 <tr><td><img src="inherit_graph_14.png" border="0" alt="" usemap="#Vamp_1_1RealTime"/>
Chris@1 139 <map name="Vamp_1_1RealTime" id="Vamp_1_1RealTime">
Chris@1 140 <area shape="rect" id="node1" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame&#45;rate conve..." alt="" coords="6,5,114,30"/></map>
Chris@1 141 </td></tr>
Chris@1 142 </table>
Chris@1 143 </div>
Chris@1 144 </div>
Chris@1 145 <div id="nav-path" class="navpath">
Chris@1 146 <ul>
Chris@1 147
Chris@1 148 <li class="footer">Generated on Tue Oct 4 2011 14:38:51 for VampPluginSDK by
Chris@1 149 <a href="http://www.doxygen.org/index.html">
Chris@1 150 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 151 </ul>
Chris@1 152 </div>
Chris@1 153
Chris@1 154
Chris@1 155 </body>
Chris@1 156 </html>