Mercurial > hg > vamp-website

comparison code-doc/classVamp_1_1PluginAdapter.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
comparison
equal deleted inserted replaced
-1:000000000000 0:351c4ebce5f9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::PluginAdapter&lt; P &gt; Class Template Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
15 <li><a href="dirs.html"><span>Directories</span></a></li>
16 </ul>
17 </div>
18 <div class="tabs">
19 <ul>
20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23 </ul>
24 </div>
25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a>
26 </div>
27 </div>
28 <div class="contents">
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>
30 <p>
31 <div class="dynheader">
32 Inheritance diagram for Vamp::PluginAdapter&lt; P &gt;:</div>
33 <div class="dynsection">
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>
35 <map name="Vamp_1_1PluginAdapter_3_01P_01_4__inherit__map">
36 <area shape="rect" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library..." alt="" coords="7,7,180,31"></map>
37 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
38
39 <p>
40 <a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
41 <h3>template&lt;typename P&gt;<br>
42 class Vamp::PluginAdapter&lt; P &gt;</h3>
43
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.
45 <p>
46 See <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>.
47 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00093">93</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
48 <table border="0" cellpadding="0" cellspacing="0">
49 <tr><td></td></tr>
50 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
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>
52
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>
54
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#7ff5c9374a8dc43f977c3707d1da45b5">getDescriptor</a> ()</td></tr>
56
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#7ff5c9374a8dc43f977c3707d1da45b5"></a><br></td></tr>
58 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
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>
60
61 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
62 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr>
63
64 </table>
65 <hr><h2>Constructor &amp; Destructor Documentation</h2>
66 <a class="anchor" name="16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="16312efd629b7063d7b6d67889a2c15a" args="()" -->
67 <div class="memitem">
68 <div class="memproto">
69 <div class="memtemplate">
70 template&lt;typename P&gt; </div>
71 <table class="memname">
72 <tr>
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>
74 <td>(</td>
75 <td class="paramname"> </td>
76 <td>&nbsp;)&nbsp;</td>
77 <td width="100%"><code> [inline]</code></td>
78 </tr>
79 </table>
80 </div>
81 <div class="memdoc">
82
83 <p>
84
85 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00096">96</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
86
87 </div>
88 </div><p>
89 <a class="anchor" name="9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="9612c9df7d4844959a36921d43d4bd50" args="()" -->
90 <div class="memitem">
91 <div class="memproto">
92 <div class="memtemplate">
93 template&lt;typename P&gt; </div>
94 <table class="memname">
95 <tr>
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>
97 <td>(</td>
98 <td class="paramname"> </td>
99 <td>&nbsp;)&nbsp;</td>
100 <td width="100%"><code> [inline, virtual]</code></td>
101 </tr>
102 </table>
103 </div>
104 <div class="memdoc">
105
106 <p>
107
108 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00097">97</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
109
110 </div>
111 </div><p>
112 <hr><h2>Member Function Documentation</h2>
113 <a class="anchor" name="3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" -->
114 <div class="memitem">
115 <div class="memproto">
116 <div class="memtemplate">
117 template&lt;typename P&gt; </div>
118 <table class="memname">
119 <tr>
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>
121 <td>(</td>
122 <td class="paramtype">float&nbsp;</td>
123 <td class="paramname"> <em>inputSampleRate</em> </td>
124 <td>&nbsp;)&nbsp;</td>
125 <td width="100%"><code> [inline, protected, virtual]</code></td>
126 </tr>
127 </table>
128 </div>
129 <div class="memdoc">
130
131 <p>
132
133 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
134
135 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00100">100</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
136
137 </div>
138 </div><p>
139 <a class="anchor" name="7ff5c9374a8dc43f977c3707d1da45b5"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="7ff5c9374a8dc43f977c3707d1da45b5" args="()" -->
140 <div class="memitem">
141 <div class="memproto">
142 <table class="memname">
143 <tr>
144 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> * Vamp::PluginAdapterBase::getDescriptor </td>
145 <td>(</td>
146 <td class="paramname"> </td>
147 <td>&nbsp;)&nbsp;</td>
148 <td width="100%"><code> [inherited]</code></td>
149 </tr>
150 </table>
151 </div>
152 <div class="memdoc">
153
154 <p>
155 Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter.
156 <p>
157
158 <p>Definition at line <a class="el" href="PluginAdapter_8cpp-source.html#l00138">138</a> of file <a class="el" href="PluginAdapter_8cpp-source.html">PluginAdapter.cpp</a>.</p>
159
160 <p>References <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginAdapter_8h-source.html#l00079">Vamp::PluginAdapterBase::m_impl</a>.</p>
161
162 <p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00050">vampGetPluginDescriptor()</a>.</p>
163
164 </div>
165 </div><p>
166 <hr><h2>Member Data Documentation</h2>
167 <a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" -->
168 <div class="memitem">
169 <div class="memproto">
170 <table class="memname">
171 <tr>
172 <td class="memname"><a class="el" href="classVamp_1_1PluginAdapterBase_1_1Impl.html">Impl</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code> </td>
173 </tr>
174 </table>
175 </div>
176 <div class="memdoc">
177
178 <p>
179
180 <p>Definition at line <a class="el" href="PluginAdapter_8h-source.html#l00079">79</a> of file <a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a>.</p>
181
182 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00138">Vamp::PluginAdapterBase::getDescriptor()</a>, <a class="el" href="PluginAdapter_8cpp-source.html#l00127">Vamp::PluginAdapterBase::PluginAdapterBase()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00132">Vamp::PluginAdapterBase::~PluginAdapterBase()</a>.</p>
183
184 </div>
185 </div><p>
186 <hr>The documentation for this class was generated from the following file:<ul>
187 <li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul>
188 </div>
189 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp;
190 <a href="http://www.doxygen.org/index.html">
191 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
192 </body>
193 </html>