Mercurial > hg > vamp-docs
diff code-docs/classVamp_1_1PluginAdapterBase.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
| author | Chris Cannam |
|---|---|
| date | Fri, 13 Jul 2012 13:30:27 +0100 |
| parents | 3c430ef1ed66 |
| children | 27319718b1f8 |
line wrap: on
line diff
--- a/code-docs/classVamp_1_1PluginAdapterBase.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/classVamp_1_1PluginAdapterBase.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>VampPluginSDK: Vamp::PluginAdapterBase Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -28,7 +29,7 @@ <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK -  <span id="projectnumber">2.1</span> +  <span id="projectnumber">2.4</span> </div> </td> @@ -40,7 +41,7 @@ </table> </div> -<!-- Generated by Doxygen 1.7.5.1 --> +<!-- Generated by Doxygen 1.8.0 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> @@ -78,9 +79,9 @@ <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">Vamp::PluginAdapterBase Class Reference</div> </div> -</div> +</div><!--header--> <div class="contents"> -<!-- doxytag: class="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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. <a href="classVamp_1_1PluginAdapterBase.html#details">More...</a></p> @@ -97,30 +98,30 @@ <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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</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 class="memitem:aaa8afd318b6c3da108e1cbcc7e46603d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">~PluginAdapterBase</a> ()</td></tr> +<tr class="memitem:ad24595002512f9f00e8e45216d6f5dfb"><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 class="memdesc:ad24595002512f9f00e8e45216d6f5dfb"><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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr> -<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</td></tr> +<tr class="memitem:a5dad6a9b4b170c0f284962e125ac988e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">PluginAdapterBase</a> ()</td></tr> +<tr class="memitem:a9116adb9b7a426f4f0ded15e45a5531b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">createPlugin</a> (float inputSampleRate)=0</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> +<tr class="memitem:a0e3594c54884efd5a7ef38030645745b"><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"><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> and <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> provide a wrapper class that a plugin library can use to make its C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> objects available through the <a class="el" href="namespaceVamp.html">Vamp</a> C API. </p> <p>Almost all <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries will want to make use of this. To do so, all they need to do is declare a PluginAdapter<T> for each plugin class T in their library. It's very simple, and you need to know absolutely nothing about how it works in order to use it. Just cut and paste from an existing plugin's discovery function. </p> -<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl> +<dl class="section see"><dt>See also:</dt><dd><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78" title="Get the descriptor for a given plugin index in this library.">vampGetPluginDescriptor</a> </dd></dl> <p>Definition at line <a class="el" href="PluginAdapter_8h_source.html#l00065">65</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="aaa8afd318b6c3da108e1cbcc7e46603d"></a><!-- doxytag: member="Vamp::PluginAdapterBase::~PluginAdapterBase" ref="aaa8afd318b6c3da108e1cbcc7e46603d" args="()" --> +<a class="anchor" id="aaa8afd318b6c3da108e1cbcc7e46603d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual Vamp::PluginAdapterBase::~PluginAdapterBase </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1PluginAdapterBase.html#aaa8afd318b6c3da108e1cbcc7e46603d">Vamp::PluginAdapterBase::~PluginAdapterBase</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [virtual]</code></td> @@ -131,12 +132,12 @@ </div> </div> -<a class="anchor" id="a5dad6a9b4b170c0f284962e125ac988e"></a><!-- doxytag: member="Vamp::PluginAdapterBase::PluginAdapterBase" ref="a5dad6a9b4b170c0f284962e125ac988e" args="()" --> +<a class="anchor" id="a5dad6a9b4b170c0f284962e125ac988e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">Vamp::PluginAdapterBase::PluginAdapterBase </td> + <td class="memname"><a class="el" href="classVamp_1_1PluginAdapterBase.html#a5dad6a9b4b170c0f284962e125ac988e">Vamp::PluginAdapterBase::PluginAdapterBase</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [protected]</code></td> @@ -148,12 +149,12 @@ </div> </div> <hr/><h2>Member Function Documentation</h2> -<a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a><!-- doxytag: member="Vamp::PluginAdapterBase::getDescriptor" ref="ad24595002512f9f00e8e45216d6f5dfb" args="()" --> +<a class="anchor" id="ad24595002512f9f00e8e45216d6f5dfb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* Vamp::PluginAdapterBase::getDescriptor </td> + <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> @@ -168,12 +169,12 @@ </div> </div> -<a class="anchor" id="a9116adb9b7a426f4f0ded15e45a5531b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::createPlugin" ref="a9116adb9b7a426f4f0ded15e45a5531b" args="(float inputSampleRate)=0" --> +<a class="anchor" id="a9116adb9b7a426f4f0ded15e45a5531b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* Vamp::PluginAdapterBase::createPlugin </td> + <td class="memname">virtual <a class="el" href="classVamp_1_1Plugin.html">Plugin</a>* <a class="el" href="classVamp_1_1PluginAdapterBase.html#a9116adb9b7a426f4f0ded15e45a5531b">Vamp::PluginAdapterBase::createPlugin</a> </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>inputSampleRate</em></td><td>)</td> @@ -188,7 +189,7 @@ </div> </div> <hr/><h2>Member Data Documentation</h2> -<a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a><!-- doxytag: member="Vamp::PluginAdapterBase::m_impl" ref="a0e3594c54884efd5a7ef38030645745b" args="" --> +<a class="anchor" id="a0e3594c54884efd5a7ef38030645745b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -206,16 +207,16 @@ <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><!-- contents --> </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_1PluginAdapterBase.html">PluginAdapterBase</a> </li> - <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by + <li class="footer">Generated on Fri Jul 13 2012 13:28:49 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> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div>