Mercurial > hg > vamp-docs

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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: Member List</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><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('classVamp_1_1Plugin.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">Vamp::Plugin Member List</div> </div>
Chris@1 77 </div>
Chris@1 78 <div class="contents">
Chris@1 79 This is the complete list of members for <a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a>, including all inherited members.<table>
Chris@1 80 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a0730bc72c87fa02eb8d2854b233f7be1">FeatureList</a> typedef</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 81 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a448fb57dc245d47923ec9eeaf9856c5f">FeatureSet</a> typedef</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 82 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcaa30e7877ab33f76acbdca28607e6ab53">FrequencyDomain</a> enum value</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 83 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 84 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a24e77eccf1bdfbbca3c79bb25e8799b3">getCurrentProgram</a>() const </td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 85 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 86 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 87 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#ae1d317a9702cbeda65ddf0ec500c1ff6">getInputDomain</a>() const =0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 88 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 89 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a2c5ab12b6fa4847cb244bd1e9cb3ae5e">getMaxChannelCount</a>() const </td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 90 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a267b42e866df3cf0d190893e8096f525">getMinChannelCount</a>() const </td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 91 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 92 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#ad064d5d132b5c9bd7064f429c3309e35">getOutputDescriptors</a>() const =0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 93 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a97ababcd45348ceec998d0f8e0f38bf7">getParameter</a>(std::string) const </td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 94 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#aac3e49b3b66cacfbb768dfdf07444f21">getParameterDescriptors</a>() const </td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 95 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a>() const =0</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 96 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#aa529adf83f87a603954eb31407602aac">getPreferredBlockSize</a>() const </td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 97 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a514c716c22f81c055f19b56c3f882567">getPreferredStepSize</a>() const </td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 98 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#abb307c60bdb981d5f5af50c3c4ae84af">getPrograms</a>() const </td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 99 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#aeca2a26e658ba0314ba90d25dd2195d6">getRemainingFeatures</a>()=0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 100 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#abe13b3997a69fbcc09e2213faa352f91">getType</a>() const </td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 101 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a8fd2c48291c64b790f0efb8948508dcf">getVampApiVersion</a>() const </td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 102 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#af26212cf5fc511b603a8b48034247822">initialise</a>(size_t inputChannels, size_t stepSize, size_t blockSize)=0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 103 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bc">InputDomain</a> enum name</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 104 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a59b9dd82a4f4eb946cd0474cc81abc23">m_inputSampleRate</a></td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [protected]</code></td></tr>
Chris@1 105 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a30f531b8fb69fac41a24e3d2a6a08ed9">OutputList</a> typedef</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 106 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> typedef</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td></td></tr>
Chris@1 107 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a1b78c4f46c72ef345ed27f0b9bf20ac9">Plugin</a>(float inputSampleRate)</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, protected]</code></td></tr>
Chris@1 108 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996">process</a>(const float *const *inputBuffers, RealTime timestamp)=0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 109 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> typedef</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td></td></tr>
Chris@1 110 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#aad67dc9d0052417511070c4ebcfbf24f">reset</a>()=0</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [pure virtual]</code></td></tr>
Chris@1 111 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a>(std::string)</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 112 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a>(std::string, float)</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 113 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a39cb7649d6dcc20e4cb1640cd55907bcad4a9f31b958a43a9757af7893aa2e7ff">TimeDomain</a> enum value</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td></td></tr>
Chris@1 114 <tr class="memlist"><td><a class="el" href="classVamp_1_1Plugin.html#a42d3096f9c1f58b1876024cd8d9ab80b">~Plugin</a>()</td><td><a class="el" href="classVamp_1_1Plugin.html">Vamp::Plugin</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 115 <tr class="memlist"><td><a class="el" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a>()</td><td><a class="el" href="classVamp_1_1PluginBase.html">Vamp::PluginBase</a></td><td><code> [inline, virtual]</code></td></tr>
Chris@1 116 </table></div>
Chris@1 117 </div>
Chris@1 118 <div id="nav-path" class="navpath">
Chris@1 119 <ul>
Chris@1 120
Chris@1 121 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
Chris@1 122 <a href="http://www.doxygen.org/index.html">
Chris@1 123 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 124 </ul>
Chris@1 125 </div>
Chris@1 126
Chris@1 127
Chris@1 128 </body>
Chris@1 129 </html>