Mercurial > hg > vamp-docs

view code-docs/plugins_8cpp.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
line wrap: on
line source
<!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: plugins.cpp File Reference</title>

<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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;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('plugins_8cpp.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">plugins.cpp File Reference</div>  </div>
</div>
<div class="contents">

<p><a href="plugins_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<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="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> (unsigned int version, unsigned int index)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library.  <a href="#abb0fd6db76ddd39698bc370e0fd0ea78"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classZeroCrossing.html">ZeroCrossing</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a><br class="typebreak"/>
&lt; <a class="el" href="classPowerSpectrum.html">PowerSpectrum</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="abb0fd6db76ddd39698bc370e0fd0ea78"></a><!-- doxytag: member="plugins.cpp::vampGetPluginDescriptor" ref="abb0fd6db76ddd39698bc370e0fd0ea78" args="(unsigned int version, unsigned int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>hostApiVersion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the descriptor for a given plugin index in this library. </p>
<p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
<p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
<p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

<p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>

</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a01871ad1ab2bb64e2c53fe5cce19b780"></a><!-- doxytag: member="plugins.cpp::zeroCrossingAdapter" ref="a01871ad1ab2bb64e2c53fe5cce19b780" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classZeroCrossing.html">ZeroCrossing</a>&gt; <a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00047">47</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ac96bdfb6356a153341b29b43c4961cd5"></a><!-- doxytag: member="plugins.cpp::spectralCentroidAdapter" ref="ac96bdfb6356a153341b29b43c4961cd5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classSpectralCentroid.html">SpectralCentroid</a>&gt; <a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00048">48</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="acee3823cb6a43281a2ecf923b69613dd"></a><!-- doxytag: member="plugins.cpp::percussionOnsetAdapter" ref="acee3823cb6a43281a2ecf923b69613dd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a>&gt; <a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00049">49</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a937de36d22633261716032570064a4be"></a><!-- doxytag: member="plugins.cpp::fixedTempoAdapter" ref="a937de36d22633261716032570064a4be" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a>&gt; <a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00050">50</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4e60bb6a99451da5deb18b969e6b16cd"></a><!-- doxytag: member="plugins.cpp::amplitudeAdapter" ref="a4e60bb6a99451da5deb18b969e6b16cd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a>&gt; <a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00051">51</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a77810f485caaae4a8b2303496046d3d7"></a><!-- doxytag: member="plugins.cpp::powerSpectrum" ref="a77810f485caaae4a8b2303496046d3d7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPowerSpectrum.html">PowerSpectrum</a>&gt; <a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00052">52</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="plugins_8cpp.html">plugins.cpp</a>      </li>

    <li class="footer">Generated on Tue Oct 4 2011 14:38: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>
   </ul>
 </div>


</body>
</html>