Mercurial > hg > vamp-website

annotate code-doc/classVamp_1_1PluginAdapter.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
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@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@21 7 <!-- Generated by Doxygen 1.5.6 -->
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@0 29 <h1>Vamp::PluginAdapter&lt; P &gt; Class Template Reference</h1><!-- doxytag: class="Vamp::PluginAdapter" --><!-- doxytag: inherits="Vamp::PluginAdapterBase" --><code>#include &lt;<a class="el" href="PluginAdapter_8h-source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31 <div class="dynheader">
cannam@0 32 Inheritance diagram for Vamp::PluginAdapter&lt; P &gt;:</div>
cannam@0 33 <div class="dynsection">
cannam@0 34 <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 35 <map name="Vamp_1_1PluginAdapter_3_01P_01_4__inherit__map">
cannam@21 36 <area shape="rect" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library..." alt="" coords="7,5,180,32"></map>
cannam@0 37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
cannam@0 38
cannam@0 39 <p>
cannam@0 40 <a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 41 <h3>template&lt;typename P&gt;<br>
cannam@0 42 class Vamp::PluginAdapter&lt; P &gt;</h3>
cannam@0 43
cannam@0 44 <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@0 45 <p>
cannam@0 46 See <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>.
cannam@21 47 <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 48 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 49 <tr><td></td></tr>
cannam@0 50 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@0 51 <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 52
cannam@0 53 <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 54
cannam@21 55 <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 56
cannam@21 57 <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 58 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
cannam@0 59 <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 60
cannam@0 61 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
cannam@21 62 <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 63
cannam@0 64 </table>
cannam@0 65 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@0 66 <a class="anchor" name="16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="16312efd629b7063d7b6d67889a2c15a" args="()" -->
cannam@0 67 <div class="memitem">
cannam@0 68 <div class="memproto">
cannam@0 69 <div class="memtemplate">
cannam@0 70 template&lt;typename P&gt; </div>
cannam@0 71 <table class="memname">
cannam@0 72 <tr>
cannam@0 73 <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 74 <td>(</td>
cannam@0 75 <td class="paramname"> </td>
cannam@0 76 <td>&nbsp;)&nbsp;</td>
cannam@21 77 <td><code> [inline]</code></td>
cannam@0 78 </tr>
cannam@0 79 </table>
cannam@0 80 </div>
cannam@0 81 <div class="memdoc">
cannam@0 82
cannam@0 83 <p>
cannam@0 84
cannam@21 85 <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 86
cannam@0 87 </div>
cannam@0 88 </div><p>
cannam@0 89 <a class="anchor" name="9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="9612c9df7d4844959a36921d43d4bd50" args="()" -->
cannam@0 90 <div class="memitem">
cannam@0 91 <div class="memproto">
cannam@0 92 <div class="memtemplate">
cannam@0 93 template&lt;typename P&gt; </div>
cannam@0 94 <table class="memname">
cannam@0 95 <tr>
cannam@0 96 <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 97 <td>(</td>
cannam@0 98 <td class="paramname"> </td>
cannam@0 99 <td>&nbsp;)&nbsp;</td>
cannam@21 100 <td><code> [inline, virtual]</code></td>
cannam@0 101 </tr>
cannam@0 102 </table>
cannam@0 103 </div>
cannam@0 104 <div class="memdoc">
cannam@0 105
cannam@0 106 <p>
cannam@0 107
cannam@21 108 <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 109
cannam@0 110 </div>
cannam@0 111 </div><p>
cannam@0 112 <hr><h2>Member Function Documentation</h2>
cannam@0 113 <a class="anchor" name="3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" -->
cannam@0 114 <div class="memitem">
cannam@0 115 <div class="memproto">
cannam@0 116 <div class="memtemplate">
cannam@0 117 template&lt;typename P&gt; </div>
cannam@0 118 <table class="memname">
cannam@0 119 <tr>
cannam@0 120 <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 121 <td>(</td>
cannam@0 122 <td class="paramtype">float&nbsp;</td>
cannam@0 123 <td class="paramname"> <em>inputSampleRate</em> </td>
cannam@0 124 <td>&nbsp;)&nbsp;</td>
cannam@21 125 <td><code> [inline, protected, virtual]</code></td>
cannam@0 126 </tr>
cannam@0 127 </table>
cannam@0 128 </div>
cannam@0 129 <div class="memdoc">
cannam@0 130
cannam@0 131 <p>
cannam@0 132
cannam@0 133 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
cannam@0 134
cannam@21 135 <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 136
cannam@0 137 </div>
cannam@0 138 </div><p>
cannam@21 139 <a class="anchor" name="d24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="d24595002512f9f00e8e45216d6f5dfb" args="()" -->
cannam@0 140 <div class="memitem">
cannam@0 141 <div class="memproto">
cannam@0 142 <table class="memname">
cannam@0 143 <tr>
cannam@21 144 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
cannam@0 145 <td>(</td>
cannam@0 146 <td class="paramname"> </td>
cannam@0 147 <td>&nbsp;)&nbsp;</td>
cannam@21 148 <td><code> [inherited]</code></td>
cannam@0 149 </tr>
cannam@0 150 </table>
cannam@0 151 </div>
cannam@0 152 <div class="memdoc">
cannam@0 153
cannam@0 154 <p>
cannam@0 155 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
cannam@0 156 <p>
cannam@0 157
cannam@21 158 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00054">vampGetPluginDescriptor()</a>.</p>
cannam@0 159
cannam@0 160 </div>
cannam@0 161 </div><p>
cannam@0 162 <hr><h2>Member Data Documentation</h2>
cannam@0 163 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" -->
cannam@0 164 <div class="memitem">
cannam@0 165 <div class="memproto">
cannam@0 166 <table class="memname">
cannam@0 167 <tr>
cannam@21 168 <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 169 </tr>
cannam@0 170 </table>
cannam@0 171 </div>
cannam@0 172 <div class="memdoc">
cannam@0 173
cannam@0 174 <p>
cannam@0 175
cannam@21 176 <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 177
cannam@0 178 </div>
cannam@0 179 </div><p>
cannam@0 180 <hr>The documentation for this class was generated from the following file:<ul>
cannam@0 181 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul>
cannam@0 182 </div>
cannam@21 183 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:21 2008 for VampPluginSDK by&nbsp;
cannam@0 184 <a href="http://www.doxygen.org/index.html">
cannam@21 185 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
cannam@0 186 </body>
cannam@0 187 </html>