Mercurial > hg > vamp-docs

diff code-docs/struct__VampFeatureList.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 diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/code-docs/struct__VampFeatureList.html	Tue Oct 04 14:56:07 2011 +0100
@@ -0,0 +1,151 @@
+<!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: _VampFeatureList Struct 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 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 id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
+      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&#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('struct__VampFeatureList.html','');
+</script>
+<div id="doc-content">
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Public Attributes</a>  </div>
+  <div class="headertitle">
+<div class="title">_VampFeatureList Struct Reference</div>  </div>
+</div>
+<div class="contents">
+<!-- doxytag: class="_VampFeatureList" -->
+<p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
+
+<p><a href="struct__VampFeatureList-members.html">List of all members.</a></p>
+<table class="memberdecls">
+<tr><td colspan="2"><h2><a name="pub-attribs"></a>
+Public Attributes</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html#a01db33a31ae5e04a4bd097f4b6aa75f1">featureCount</a></td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of features in this feature list.  <a href="#a01db33a31ae5e04a4bd097f4b6aa75f1"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html#a103c817094643ac5ff4410768f4f92a7">features</a></td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Features in this feature list.  <a href="#a103c817094643ac5ff4410768f4f92a7"></a><br/></td></tr>
+</table>
+<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
+<div class="textblock">
+<p>Definition at line <a class="el" href="vamp_8h_source.html#l00217">217</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
+</div><hr/><h2>Member Data Documentation</h2>
+<a class="anchor" id="a01db33a31ae5e04a4bd097f4b6aa75f1"></a><!-- doxytag: member="_VampFeatureList::featureCount" ref="a01db33a31ae5e04a4bd097f4b6aa75f1" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned int <a class="el" href="struct__VampFeatureList.html#a01db33a31ae5e04a4bd097f4b6aa75f1">_VampFeatureList::featureCount</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Number of features in this feature list. </p>
+
+<p>Definition at line <a class="el" href="vamp_8h_source.html#l00220">220</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a103c817094643ac5ff4410768f4f92a7"></a><!-- doxytag: member="_VampFeatureList::features" ref="a103c817094643ac5ff4410768f4f92a7" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a>* <a class="el" href="struct__VampFeatureList.html#a103c817094643ac5ff4410768f4f92a7">_VampFeatureList::features</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Features in this feature list. </p>
+<p>May be NULL if featureCount is zero.</p>
+<p>If present, this array must contain featureCount feature structures for a <a class="el" href="namespaceVamp.html">Vamp</a> API version 1 plugin, or 2*featureCount feature unions for a <a class="el" href="namespaceVamp.html">Vamp</a> API version 2 plugin.</p>
+<p>The features returned by an API version 2 plugin must consist of the same feature structures as in API version 1 for the first featureCount array elements, followed by featureCount unions that contain VampFeatureV2 structures (or NULL pointers if no V2 feature structures are present). </p>
+
+<p>Definition at line <a class="el" href="vamp_8h_source.html#l00235">235</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
+</ul>
+</div>
+</div>
+  <div id="nav-path" class="navpath">
+    <ul>
+      <li class="navelem"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>      </li>
+
+    <li class="footer">Generated on Tue Oct 4 2011 14:38:50 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>