Mercurial > hg > vamp-website
diff code-doc/classVamp_1_1PluginAdapter.html @ 50:8260c0f4e05b website
Update code docs for 2.3
author | cannam |
---|---|
date | Tue, 04 Oct 2011 13:47:23 +0000 |
parents | 0976232e353b |
children |
line wrap: on
line diff
--- a/code-doc/classVamp_1_1PluginAdapter.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/classVamp_1_1PluginAdapter.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,190 +1,238 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>VampPluginSDK: Vamp::PluginAdapter< P > Class Template Reference</title> -<link href="tabs.css" rel="stylesheet" type="text/css"> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -</head><body> -<!-- Generated by Doxygen 1.5.8 --> -<div class="navigation" id="top"> - <div class="tabs"> - <ul> - <li><a href="main.html"><span>Main Page</span></a></li> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> + + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">VampPluginSDK +  <span id="projectnumber">2.1</span> + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> - <div class="tabs"> - <ul> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> - <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> </div> </div> +<script type="text/javascript"> + initNavTree('classVamp_1_1PluginAdapter.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> </div> + <div class="headertitle"> +<div class="title">Vamp::PluginAdapter< P > Class Template Reference</div> </div> +</div> <div class="contents"> -<h1>Vamp::PluginAdapter< P > 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. -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="PluginAdapter_8h-source.html">vamp-sdk/PluginAdapter.h</a>></code> -<p> +<!-- doxytag: class="Vamp::PluginAdapter" --><!-- doxytag: inherits="Vamp::PluginAdapterBase" --> +<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. + <a href="classVamp_1_1PluginAdapter.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Vamp::PluginAdapter< P >:</div> -<div class="dynsection"> -<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> -<map name="Vamp_1_1PluginAdapter_3_01P_01_4__inherit__map"> -<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> -<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dyncontent"> +<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> +<map name="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map" id="Vamp_1_1PluginAdapter_3_01P_01_4_inherit__map"> +<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> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> -<p> -<a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></td></tr> -<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a> ()</td></tr> +<p><a href="classVamp_1_1PluginAdapter-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a16312efd629b7063d7b6d67889a2c15a">PluginAdapter</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#ad24595002512f9f00e8e45216d6f5dfb"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#a3f387e7e37409e00d32477903b5b13d3">createPlugin</a> (float inputSampleRate)</td></tr> +<tr><td colspan="2"><h2><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><h3>template<typename P><br/> +class Vamp::PluginAdapter< P ></h3> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#9612c9df7d4844959a36921d43d4bd50">~PluginAdapter</a> ()</td></tr> +<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> +<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> -<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb">getDescriptor</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. <a href="#d24595002512f9f00e8e45216d6f5dfb"></a><br></td></tr> -<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html#3f387e7e37409e00d32477903b5b13d3">createPlugin</a> (float inputSampleRate)</td></tr> - -<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">Impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">m_impl</a></td></tr> - -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -<h3>template<typename P><br> - class Vamp::PluginAdapter< P ></h3> - -<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. -<p> -See <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">PluginAdapterBase</a>. -<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> -<hr><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" name="16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="16312efd629b7063d7b6d67889a2c15a" args="()" --> +<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> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a16312efd629b7063d7b6d67889a2c15a"></a><!-- doxytag: member="Vamp::PluginAdapter::PluginAdapter" ref="a16312efd629b7063d7b6d67889a2c15a" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename P> </div> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td> + <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td> <td>(</td> - <td class="paramname"> </td> - <td> ) </td> + <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> - -<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> +<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> </div> -</div><p> -<a class="anchor" name="9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="9612c9df7d4844959a36921d43d4bd50" args="()" --> +</div> +<a class="anchor" id="a9612c9df7d4844959a36921d43d4bd50"></a><!-- doxytag: member="Vamp::PluginAdapter::~PluginAdapter" ref="a9612c9df7d4844959a36921d43d4bd50" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename P> </div> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::~<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::~<a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </td> <td>(</td> - <td class="paramname"> </td> - <td> ) </td> + <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> - -<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> +<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> </div> -</div><p> -<hr><h2>Member Function Documentation</h2> -<a class="anchor" name="3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" --> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a3f387e7e37409e00d32477903b5b13d3"></a><!-- doxytag: member="Vamp::PluginAdapter::createPlugin" ref="a3f387e7e37409e00d32477903b5b13d3" args="(float inputSampleRate)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename P> </div> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::createPlugin </td> + <td class="memname"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>< P >::createPlugin </td> <td>(</td> - <td class="paramtype">float </td> - <td class="paramname"> <em>inputSampleRate</em> </td> - <td> ) </td> + <td class="paramtype">float </td> + <td class="paramname"><em>inputSampleRate</em></td><td>)</td> <td><code> [inline, protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> +<p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p> -<p>Implements <a class="el" href="classVamp_1_1PluginAdapterBase.html#9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase</a>.</p> - -<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> +<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> </div> -</div><p> -<a class="anchor" name="d24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="d24595002512f9f00e8e45216d6f5dfb" args="()" --> +</div> +<a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapter::getDescriptor" ref="ad24595002512f9f00e8e45216d6f5dfb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td> + <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td> <td>(</td> - <td class="paramname"> </td> - <td> ) </td> + <td class="paramname"></td><td>)</td> <td><code> [inherited]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> -Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. -<p> +<p>Return a VampPluginDescriptor describing the plugin that is wrapped by this adapter. </p> -<p>Referenced by <a class="el" href="plugins_8cpp-source.html#l00054">vampGetPluginDescriptor()</a>.</p> +<p>Referenced by <a class="el" href="plugins_8cpp_source.html#l00054">vampGetPluginDescriptor()</a>.</p> </div> -</div><p> -<hr><h2>Member Data Documentation</h2> -<a class="anchor" name="0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="0e3594c54884efd5a7ef38030645745b" args="" --> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapter::m_impl" ref="a0e3594c54884efd5a7ef38030645745b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code> </td> + <td class="memname">Impl* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a0e3594c54884efd5a7ef38030645745b">Vamp::PluginAdapterBase::m_impl</a><code> [protected, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> - -<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> +<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> </div> -</div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="PluginAdapter_8h-source.html">PluginAdapter.h</a></ul> </div> -<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by -<a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PluginAdapter_8h_source.html">PluginAdapter.h</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> + <li class="navelem"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a> </li> + + <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + </body> </html>