Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginAdapter.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Update for 2.1 release; add wiki link
author cannam
date Fri, 25 Sep 2009 15:40:18 +0000
parents cc0be37dc9d3
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::PluginAdapter&lt; P &gt; Class Template 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_1PluginAdapter.html">PluginAdapter</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::PluginAdapter&lt; P &gt; Class Template Reference</h1><!-- doxytag: class="Vamp::PluginAdapter" --><!-- doxytag: inherits="Vamp::PluginAdapterBase" --><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation.
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::PluginAdapter&lt; P &gt;:</div>
cannam@0 36 <div class="dynsection">
cannam@0 37 <p><center><img src="classVamp_1_1PluginAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapter_3_01P_01_4__inherit__map" alt="Inheritance graph"></center>
cannam@0 38 <map name="Vamp_1_1PluginAdapter_3_01P_01_4__inherit__map">
cannam@35 39 <area shape="rect" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library..." alt="" coords="8,7,171,31"></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_1PluginAdapter-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@0 46 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a> ()</td></tr>
cannam@0 47
cannam@0 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a> ()</td></tr>
cannam@0 49
cannam@21 50 <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 51
cannam@21 52 <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 53 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 54 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">createPlugin</a> (float inputSampleRate)</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 <h3>template&lt;typename P&gt;<br>
cannam@35 62 class Vamp::PluginAdapter&lt; P &gt;</h3>
cannam@35 63
cannam@35 64 <a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation.
cannam@35 65 <p>
cannam@35 66 See <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>.
cannam@35 67 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00095">95</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 68 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 69 <a class="anchor" name="16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="16312efd629b7063d7b6d67889a2c15a" args="()" -->
cannam@0 70 <div class="memitem">
cannam@0 71 <div class="memproto">
cannam@0 72 <div class="memtemplate">
cannam@0 73 template&lt;typename P&gt; </div>
cannam@0 74 <table class="memname">
cannam@0 75 <tr>
cannam@0 76 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td>
cannam@0 77 <td>(</td>
cannam@0 78 <td class="paramname"> </td>
cannam@0 79 <td>&nbsp;)&nbsp;</td>
cannam@21 80 <td><code> [inline]</code></td>
cannam@0 81 </tr>
cannam@0 82 </table>
cannam@0 83 </div>
cannam@0 84 <div class="memdoc">
cannam@0 85
cannam@0 86 <p>
cannam@0 87
cannam@21 88 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00098">98</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 89
cannam@0 90 </div>
cannam@0 91 </div><p>
cannam@0 92 <a class="anchor" name="9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="9612c9df7d4844959a36921d43d4bd50" args="()" -->
cannam@0 93 <div class="memitem">
cannam@0 94 <div class="memproto">
cannam@0 95 <div class="memtemplate">
cannam@0 96 template&lt;typename P&gt; </div>
cannam@0 97 <table class="memname">
cannam@0 98 <tr>
cannam@0 99 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::~<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td>
cannam@0 100 <td>(</td>
cannam@0 101 <td class="paramname"> </td>
cannam@0 102 <td>&nbsp;)&nbsp;</td>
cannam@21 103 <td><code> [inline, virtual]</code></td>
cannam@0 104 </tr>
cannam@0 105 </table>
cannam@0 106 </div>
cannam@0 107 <div class="memdoc">
cannam@0 108
cannam@0 109 <p>
cannam@0 110
cannam@21 111 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00099">99</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 112
cannam@0 113 </div>
cannam@0 114 </div><p>
cannam@0 115 <hr><h2>Member Function Documentation</h2>
cannam@0 116 <a class="anchor" name="3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" -->
cannam@0 117 <div class="memitem">
cannam@0 118 <div class="memproto">
cannam@0 119 <div class="memtemplate">
cannam@0 120 template&lt;typename P&gt; </div>
cannam@0 121 <table class="memname">
cannam@0 122 <tr>
cannam@0 123 <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; P &gt;::createPlugin </td>
cannam@0 124 <td>(</td>
cannam@0 125 <td class="paramtype">float&nbsp;</td>
cannam@0 126 <td class="paramname"> <em>inputSampleRate</em> </td>
cannam@0 127 <td>&nbsp;)&nbsp;</td>
cannam@21 128 <td><code> [inline, protected, virtual]</code></td>
cannam@0 129 </tr>
cannam@0 130 </table>
cannam@0 131 </div>
cannam@0 132 <div class="memdoc">
cannam@0 133
cannam@0 134 <p>
cannam@0 135
cannam@0 136 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
cannam@0 137
cannam@21 138 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00102">102</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
cannam@0 139
cannam@0 140 </div>
cannam@0 141 </div><p>
cannam@21 142 <a class="anchor" name="d24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="d24595002512f9f00e8e45216d6f5dfb" args="()" -->
cannam@0 143 <div class="memitem">
cannam@0 144 <div class="memproto">
cannam@0 145 <table class="memname">
cannam@0 146 <tr>
cannam@21 147 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
cannam@0 148 <td>(</td>
cannam@0 149 <td class="paramname"> </td>
cannam@0 150 <td>&nbsp;)&nbsp;</td>
cannam@21 151 <td><code> [inherited]</code></td>
cannam@0 152 </tr>
cannam@0 153 </table>
cannam@0 154 </div>
cannam@0 155 <div class="memdoc">
cannam@0 156
cannam@0 157 <p>
cannam@0 158 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
cannam@0 159 <p>
cannam@0 160
cannam@21 161 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00054">vampGetPluginDescriptor()</a>.</p>
cannam@0 162
cannam@0 163 </div>
cannam@0 164 </div><p>
cannam@0 165 <hr><h2>Member Data Documentation</h2>
cannam@0 166 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" -->
cannam@0 167 <div class="memitem">
cannam@0 168 <div class="memproto">
cannam@0 169 <table class="memname">
cannam@0 170 <tr>
cannam@21 171 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code> </td>
cannam@0 172 </tr>
cannam@0 173 </table>
cannam@0 174 </div>
cannam@0 175 <div class="memdoc">
cannam@0 176
cannam@0 177 <p>
cannam@0 178
cannam@21 179 <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 180
cannam@0 181 </div>
cannam@0 182 </div><p>
cannam@0 183 <hr>The documentation for this class was generated from the following file:<ul>
cannam@0 184 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul>
cannam@0 185 </div>
cannam@35 186 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 187 <a href="http://www.doxygen.org/index.html">
cannam@35 188 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 189 </body>
cannam@0 190 </html>