Mercurial > hg > vamp-docs

comparison code-docs/classVamp_1_1PluginAdapter.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
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: Vamp::PluginAdapter&lt; P &gt; Class Template Reference</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
49 <li><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 </div>
65 </div>
66 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle">
68 </div>
69 </div>
70 <script type="text/javascript">
71 initNavTree('classVamp_1_1PluginAdapter.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-methods">Public Member Functions</a> &#124;
77 <a href="#pro-methods">Protected Member Functions</a> &#124;
78 <a href="#pro-attribs">Protected Attributes</a> </div>
79 <div class="headertitle">
80 <div class="title">Vamp::PluginAdapter&lt; P &gt; Class Template Reference</div> </div>
81 </div>
82 <div class="contents">
83 <!-- doxytag: class="Vamp::PluginAdapter" --><!-- doxytag: inherits="Vamp::PluginAdapterBase" -->
84 <p><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation.
85 <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p>
86
87 <p><code>#include &lt;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&gt;</code></p>
88 <div class="dynheader">
89 Inheritance diagram for Vamp::PluginAdapter&lt; P &gt;:</div>
90 <div class="dyncontent">
91 <div class="center"><img src="classVamp_1_1PluginAdapter__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" alt="Inheritance graph"/></div>
92 <map name="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" id="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map">
93 <area shape="rect" id="node2" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its..." alt="" coords="7,6,165,31"/></map>
94 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
95
96 <p><a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a></p>
97 <table class="memberdecls">
98 <tr><td colspan="2"><h2><a name="pub-methods"></a>
99 Public Member Functions</h2></td></tr>
100 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a> ()</td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a> ()</td></tr>
102 <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr>
103 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#ad24595002512f9f00e8e45216d6f5dfb"></a><br/></td></tr>
104 <tr><td colspan="2"><h2><a name="pro-methods"></a>
105 Protected Member Functions</h2></td></tr>
106 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">createPlugin</a> (float inputSampleRate)</td></tr>
107 <tr><td colspan="2"><h2><a name="pro-attribs"></a>
108 Protected Attributes</h2></td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top">Impl *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr>
110 </table>
111 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
112 <div class="textblock"><h3>template&lt;typename P&gt;<br/>
113 class Vamp::PluginAdapter&lt; P &gt;</h3>
114
115 <p><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular plugin implementatio...">PluginAdapter</a> turns a <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a> into a specific wrapper for a particular plugin implementation. </p>
116 <p>See <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library can use to make its...">PluginAdapterBase</a>. </p>
117
118 <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>
119 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
120 <a class="anchor" id="a16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="a16312efd629b7063d7b6d67889a2c15a" args="()" -->
121 <div class="memitem">
122 <div class="memproto">
123 <div class="memtemplate">
124 template&lt;typename P&gt; </div>
125 <table class="memname">
126 <tr>
127 <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>
128 <td>(</td>
129 <td class="paramname"></td><td>)</td>
130 <td><code> [inline]</code></td>
131 </tr>
132 </table>
133 </div>
134 <div class="memdoc">
135
136 <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>
137
138 </div>
139 </div>
140 <a class="anchor" id="a9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="a9612c9df7d4844959a36921d43d4bd50" args="()" -->
141 <div class="memitem">
142 <div class="memproto">
143 <div class="memtemplate">
144 template&lt;typename P&gt; </div>
145 <table class="memname">
146 <tr>
147 <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>
148 <td>(</td>
149 <td class="paramname"></td><td>)</td>
150 <td><code> [inline, virtual]</code></td>
151 </tr>
152 </table>
153 </div>
154 <div class="memdoc">
155
156 <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>
157
158 </div>
159 </div>
160 <hr/><h2>Member Function Documentation</h2>
161 <a class="anchor" id="a3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="a3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" -->
162 <div class="memitem">
163 <div class="memproto">
164 <div class="memtemplate">
165 template&lt;typename P&gt; </div>
166 <table class="memname">
167 <tr>
168 <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>
169 <td>(</td>
170 <td class="paramtype">float&#160;</td>
171 <td class="paramname"><em>inputSampleRate</em></td><td>)</td>
172 <td><code> [inline, protected, virtual]</code></td>
173 </tr>
174 </table>
175 </div>
176 <div class="memdoc">
177
178 <p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p>
179
180 <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>
181
182 </div>
183 </div>
184 <a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="ad24595002512f9f00e8e45216d6f5dfb" args="()" -->
185 <div class="memitem">
186 <div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td>
190 <td>(</td>
191 <td class="paramname"></td><td>)</td>
192 <td><code> [inherited]</code></td>
193 </tr>
194 </table>
195 </div>
196 <div class="memdoc">
197
198 <p>Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. </p>
199
200 <p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p>
201
202 </div>
203 </div>
204 <hr/><h2>Member Data Documentation</h2>
205 <a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="a0e3594c54884efd5a7ef38030645745b" args="" -->
206 <div class="memitem">
207 <div class="memproto">
208 <table class="memname">
209 <tr>
210 <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code></td>
211 </tr>
212 </table>
213 </div>
214 <div class="memdoc">
215
216 <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>
217
218 </div>
219 </div>
220 <hr/>The documentation for this class was generated from the following file:<ul>
221 <li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li>
222 </ul>
223 </div>
224 </div>
225 <div id="nav-path" class="navpath">
226 <ul>
227 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
228 <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </li>
229
230 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
231 <a href="http://www.doxygen.org/index.html">
232 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
233 </ul>
234 </div>
235
236
237 </body>
238 </html>