annotate code-docs/namespaceVamp.html @ 7:66d125fb8b42 tip

Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@3 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
Chris@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: Vamp Namespace Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('namespaceVamp.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#namespaces">Namespaces</a> &#124;
Chris@1 64 <a href="#nested-classes">Classes</a> &#124;
Chris@1 65 <a href="#func-members">Functions</a> </div>
Chris@1 66 <div class="headertitle">
Chris@1 67 <div class="title">Vamp Namespace Reference</div> </div>
Chris@3 68 </div><!--header-->
Chris@1 69 <div class="contents">
Chris@1 70 <table class="memberdecls">
Chris@6 71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Chris@1 72 Namespaces</h2></td></tr>
Chris@6 73 <tr class="memitem:namespaceVamp_1_1HostExt"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp_1_1HostExt.html">HostExt</a></td></tr>
Chris@6 74 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 75 </table><table class="memberdecls">
Chris@6 76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Chris@1 77 Classes</h2></td></tr>
Chris@3 78 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFT.html">FFT</a></td></tr>
Chris@6 79 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors. <a href="classVamp_1_1FFT.html#details">More...</a><br /></td></tr>
Chris@6 80 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 81 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTComplex.html">FFTComplex</a></td></tr>
Chris@6 82 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors. <a href="classVamp_1_1FFTComplex.html#details">More...</a><br /></td></tr>
Chris@6 83 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 84 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1FFTReal.html">FFTReal</a></td></tr>
Chris@6 85 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple <a class="el" href="classVamp_1_1FFT.html" title="A simple FFT implementation provided for convenience of plugin authors. ">FFT</a> implementation provided for convenience of plugin authors. <a href="classVamp_1_1FFTReal.html#details">More...</a><br /></td></tr>
Chris@6 86 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 87 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></td></tr>
Chris@6 88 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 89 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapter.html">PluginAdapter</a></td></tr>
Chris@6 91 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 92 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 93 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginAdapterBase.html">PluginAdapterBase</a></td></tr>
Chris@6 94 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 95 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 96 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a></td></tr>
Chris@6 97 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 98 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 99 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginHostAdapter.html">PluginHostAdapter</a></td></tr>
Chris@6 100 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 101 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 102 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a></td></tr>
Chris@6 103 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
Chris@6 104 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 105 </table><table class="memberdecls">
Chris@6 106 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Chris@1 107 Functions</h2></td></tr>
Chris@3 108 <tr class="memitem:a85842d554b6abf7bf9ff648b70f39fef"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVamp.html#a85842d554b6abf7bf9ff648b70f39fef">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;rt)</td></tr>
Chris@6 109 <tr class="separator:a85842d554b6abf7bf9ff648b70f39fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 110 </table>
Chris@6 111 <h2 class="groupheader">Function Documentation</h2>
Chris@6 112 <a id="a85842d554b6abf7bf9ff648b70f39fef"></a>
Chris@6 113 <h2 class="memtitle"><span class="permalink"><a href="#a85842d554b6abf7bf9ff648b70f39fef">&#9670;&nbsp;</a></span>operator<<()</h2>
Chris@6 114
Chris@1 115 <div class="memitem">
Chris@1 116 <div class="memproto">
Chris@1 117 <table class="memname">
Chris@1 118 <tr>
Chris@1 119 <td class="memname">std::ostream&amp; Vamp::operator&lt;&lt; </td>
Chris@1 120 <td>(</td>
Chris@1 121 <td class="paramtype">std::ostream &amp;&#160;</td>
Chris@1 122 <td class="paramname"><em>out</em>, </td>
Chris@1 123 </tr>
Chris@1 124 <tr>
Chris@1 125 <td class="paramkey"></td>
Chris@1 126 <td></td>
Chris@6 127 <td class="paramtype">const <a class="el" href="structVamp_1_1RealTime.html">RealTime</a> &amp;&#160;</td>
Chris@1 128 <td class="paramname"><em>rt</em>&#160;</td>
Chris@1 129 </tr>
Chris@1 130 <tr>
Chris@1 131 <td></td>
Chris@1 132 <td>)</td>
Chris@1 133 <td></td><td></td>
Chris@1 134 </tr>
Chris@1 135 </table>
Chris@6 136 </div><div class="memdoc">
Chris@1 137
Chris@1 138 </div>
Chris@1 139 </div>
Chris@3 140 </div><!-- contents -->
Chris@6 141 </div><!-- doc-content -->
Chris@6 142 <!-- start footer part -->
Chris@6 143 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 144 <ul>
Chris@6 145 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li>
Chris@6 146 <li class="footer">Generated by
Chris@6 147 <a href="http://www.doxygen.org/index.html">
Chris@6 148 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 149 </ul>
Chris@1 150 </div>
Chris@1 151 </body>
Chris@1 152 </html>