Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginAdapterBase.html @ 40:9391fbda5ad2 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update site for v2.2 release
author cannam
date Thu, 26 Aug 2010 11:36:19 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::PluginAdapterBase Class Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::PluginAdapterBase Class Reference</h1><!-- doxytag: class="Vamp::PluginAdapterBase" --><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">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...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API.
cannam@35 30 <a href="#_details">More...</a>
cannam@35 31 <p>
cannam@35 32 <code>#include &lt;<a class="el" href="PluginAdapter_8h-source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code>
cannam@0 33 <p>
cannam@0 34 <div class="dynheader">
cannam@0 35 Inheritance diagram for Vamp::PluginAdapterBase:</div>
cannam@0 36 <div class="dynsection">
cannam@0 37 <p><center><img src="classVamp_1_1PluginAdapterBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapterBase__inherit__map" alt="Inheritance graph"></center>
cannam@0 38 <map name="Vamp_1_1PluginAdapterBase__inherit__map">
cannam@35 39 <area shape="rect" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular..." alt="" coords="5,81,173,105"></map>
cannam@0 40 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 41
cannam@0 42 <p>
cannam@35 43 <a href="classVamp_1_1PluginAdapterBase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 44 <tr><td></td></tr>
cannam@0 45 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@21 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</a> ()</td></tr>
cannam@0 47
cannam@21 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr>
cannam@0 49
cannam@21 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#d24595002512f9f00e8e45216d6f5dfb"></a><br></td></tr>
cannam@0 51 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 52 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr>
cannam@0 53
cannam@0 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</td></tr>
cannam@0 55
cannam@0 56 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@21 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">Impl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr>
cannam@0 58
cannam@0 59 </table>
cannam@35 60 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 61 <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">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...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API.
cannam@35 62 <p>
cannam@35 63 Almost all <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter&lt;T&gt; for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="plugins_8cpp.html#bb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl>
cannam@35 64
cannam@35 65 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00065">65</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 66 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@21 67 <a class="anchor" name="aa8afd318b6c3da108e1cbcc7e46603d"></a><!-- doxytag: member="Vamp::PluginAdapterBase::~PluginAdapterBase" ref="aa8afd318b6c3da108e1cbcc7e46603d" args="()" -->
cannam@0 68 <div class="memitem">
cannam@0 69 <div class="memproto">
cannam@0 70 <table class="memname">
cannam@0 71 <tr>
cannam@21 72 <td class="memname">virtual Vamp::PluginAdapterBase::~PluginAdapterBase </td>
cannam@0 73 <td>(</td>
cannam@0 74 <td class="paramname"> </td>
cannam@0 75 <td>&nbsp;)&nbsp;</td>
cannam@21 76 <td><code> [virtual]</code></td>
cannam@0 77 </tr>
cannam@0 78 </table>
cannam@0 79 </div>
cannam@0 80 <div class="memdoc">
cannam@0 81
cannam@0 82 <p>
cannam@0 83
cannam@0 84 </div>
cannam@0 85 </div><p>
cannam@0 86 <a class="anchor" name="5dad6a9b4b170c0f284962e125ac988e"></a><!-- doxytag: member="Vamp::PluginAdapterBase::PluginAdapterBase" ref="5dad6a9b4b170c0f284962e125ac988e" args="()" -->
cannam@0 87 <div class="memitem">
cannam@0 88 <div class="memproto">
cannam@0 89 <table class="memname">
cannam@0 90 <tr>
cannam@0 91 <td class="memname">Vamp::PluginAdapterBase::PluginAdapterBase </td>
cannam@0 92 <td>(</td>
cannam@0 93 <td class="paramname"> </td>
cannam@0 94 <td>&nbsp;)&nbsp;</td>
cannam@21 95 <td><code> [protected]</code></td>
cannam@0 96 </tr>
cannam@0 97 </table>
cannam@0 98 </div>
cannam@0 99 <div class="memdoc">
cannam@0 100
cannam@0 101 <p>
cannam@0 102
cannam@0 103 </div>
cannam@0 104 </div><p>
cannam@0 105 <hr><h2>Member Function Documentation</h2>
cannam@21 106 <a class="anchor" name="d24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapterBase::getDescriptor" ref="d24595002512f9f00e8e45216d6f5dfb" args="()" -->
cannam@0 107 <div class="memitem">
cannam@0 108 <div class="memproto">
cannam@0 109 <table class="memname">
cannam@0 110 <tr>
cannam@21 111 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
cannam@0 112 <td>(</td>
cannam@0 113 <td class="paramname"> </td>
cannam@0 114 <td>&nbsp;)&nbsp;</td>
cannam@21 115 <td></td>
cannam@0 116 </tr>
cannam@0 117 </table>
cannam@0 118 </div>
cannam@0 119 <div class="memdoc">
cannam@0 120
cannam@0 121 <p>
cannam@0 122 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
cannam@0 123 <p>
cannam@0 124
cannam@21 125 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00054">vampGetPluginDescriptor()</a>.</p>
cannam@0 126
cannam@0 127 </div>
cannam@0 128 </div><p>
cannam@0 129 <a class="anchor" name="9116adb9b7a426f4f0ded15e45a5531b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::createPlugin" ref="9116adb9b7a426f4f0ded15e45a5531b" args="(float inputSampleRate)=0" -->
cannam@0 130 <div class="memitem">
cannam@0 131 <div class="memproto">
cannam@0 132 <table class="memname">
cannam@0 133 <tr>
cannam@0 134 <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::PluginAdapterBase::createPlugin </td>
cannam@0 135 <td>(</td>
cannam@0 136 <td class="paramtype">float&nbsp;</td>
cannam@0 137 <td class="paramname"> <em>inputSampleRate</em> </td>
cannam@0 138 <td>&nbsp;)&nbsp;</td>
cannam@21 139 <td><code> [protected, pure virtual]</code></td>
cannam@0 140 </tr>
cannam@0 141 </table>
cannam@0 142 </div>
cannam@0 143 <div class="memdoc">
cannam@0 144
cannam@0 145 <p>
cannam@0 146
cannam@0 147 <p>Implemented in <a class="el" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">Vamp::PluginAdapter&lt; P &gt;</a>.</p>
cannam@0 148
cannam@0 149 </div>
cannam@0 150 </div><p>
cannam@0 151 <hr><h2>Member Data Documentation</h2>
cannam@0 152 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" -->
cannam@0 153 <div class="memitem">
cannam@0 154 <div class="memproto">
cannam@0 155 <table class="memname">
cannam@0 156 <tr>
cannam@21 157 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected]</code> </td>
cannam@0 158 </tr>
cannam@0 159 </table>
cannam@0 160 </div>
cannam@0 161 <div class="memdoc">
cannam@0 162
cannam@0 163 <p>
cannam@0 164
cannam@21 165 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00081">81</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 166
cannam@0 167 </div>
cannam@0 168 </div><p>
cannam@21 169 <hr>The documentation for this class was generated from the following file:<ul>
cannam@21 170 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul>
cannam@0 171 </div>
cannam@35 172 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 173 <a href="http://www.doxygen.org/index.html">
cannam@35 174 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 175 </body>
cannam@0 176 </html>