Mercurial > hg > vamp-website
diff code-doc/namespaceVamp.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/namespaceVamp.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/namespaceVamp.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,89 +1,146 @@ -<!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 Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> <li><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="namespaces.html"><span>Namespace List</span></a></li> - <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="namespaces.html"><span>Namespace List</span></a></li> + <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> </ul> </div> </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('namespaceVamp.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#namespaces">Namespaces</a> | +<a href="#nested-classes">Classes</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Vamp Namespace Reference</div> </div> +</div> <div class="contents"> -<h1>Vamp Namespace Reference</h1><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></td></tr> -<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr> - -<tr><td colspan="2"><br><h2>Classes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#_details">More...</a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginAdapter.html" title="PluginAdapter turns a PluginAdapterBase into a specific wrapper for a particular...">PluginAdapter</a> and <a class="el" href="classVamp_1_1PluginAdapterBase.html" title="PluginAdapter and PluginAdapterBase provide a wrapper class that a plugin library...">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...">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><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight"><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="classVamp_1_1PluginAdapter.html#_details">More...</a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#_details">More...</a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions. <a href="structVamp_1_1RealTime.html#_details">More...</a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a C++ <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction...">Vamp::Plugin</a> object. <a href="classVamp_1_1PluginHostAdapter.html#_details">More...</a><br></td></tr> -<tr><td colspan="2"><br><h2>Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#85842d554b6abf7bf9ff648b70f39fef">operator<<</a> (std::ostream &out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &rt)</td></tr> - +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr> +<tr><td colspan="2"><h2><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><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> is a base class for plugin instance classes that provide feature extraction from audio or related data. <a href="classVamp_1_1Plugin.html#details">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><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><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><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><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">A base class for plugins with optional configurable parameters, programs, etc. <a href="classVamp_1_1PluginBase.html#details">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structVamp_1_1RealTime.html" title="RealTime represents time values to nanosecond precision with accurate arithmetic and frame-rate conve...">RealTime</a> represents time values to nanosecond precision with accurate arithmetic and frame-rate conversion functions. <a href="structVamp_1_1RealTime.html#details">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri...">PluginHostAdapter</a> is a wrapper class that a <a class="el" href="namespaceVamp.html">Vamp</a> host can use to make the C-language VampPluginDescriptor object appear as a 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> object. <a href="classVamp_1_1PluginHostAdapter.html#details">More...</a><br/></td></tr> +<tr><td colspan="2"><h2><a name="func-members"></a> +Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#a85842d554b6abf7bf9ff648b70f39fef">operator<<</a> (std::ostream &out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &rt)</td></tr> </table> -<hr><h2>Function Documentation</h2> -<a class="anchor" name="85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator<<" ref="85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &out, const RealTime &rt)" --> +<hr/><h2>Function Documentation</h2> +<a class="anchor" id="a85842d554b6abf7bf9ff648b70f39fef"></a><!-- doxytag: member="Vamp::operator<<" ref="a85842d554b6abf7bf9ff648b70f39fef" args="(std::ostream &out, const RealTime &rt)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::ostream& Vamp::operator<< </td> + <td class="memname">std::ostream& Vamp::operator<< </td> <td>(</td> - <td class="paramtype">std::ostream & </td> - <td class="paramname"> <em>out</em>, </td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>out</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">const RealTime & </td> - <td class="paramname"> <em>rt</em></td><td> </td> + <td class="paramtype">const RealTime & </td> + <td class="paramname"><em>rt</em> </td> </tr> <tr> <td></td> <td>)</td> - <td></td><td></td><td></td> + <td></td><td></td> </tr> </table> </div> <div class="memdoc"> -<p> +</div> +</div> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> -</div> -</div><p> -</div> -<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:13 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> + <li class="footer">Generated on Tue Oct 4 2011 14:38:51 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>