annotate code-docs/struct__VampFeatureList.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
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@1 5 <title>VampPluginSDK: _VampFeatureList Struct Reference</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
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@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('struct__VampFeatureList.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#pub-attribs">Public Attributes</a> </div>
Chris@1 77 <div class="headertitle">
Chris@1 78 <div class="title">_VampFeatureList Struct Reference</div> </div>
Chris@1 79 </div>
Chris@1 80 <div class="contents">
Chris@1 81 <!-- doxytag: class="_VampFeatureList" -->
Chris@1 82 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
Chris@1 83
Chris@1 84 <p><a href="struct__VampFeatureList-members.html">List of all members.</a></p>
Chris@1 85 <table class="memberdecls">
Chris@1 86 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
Chris@1 87 Public Attributes</h2></td></tr>
Chris@1 88 <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>
Chris@1 89 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of features in this feature list. <a href="#a01db33a31ae5e04a4bd097f4b6aa75f1"></a><br/></td></tr>
Chris@1 90 <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>
Chris@1 91 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Features in this feature list. <a href="#a103c817094643ac5ff4410768f4f92a7"></a><br/></td></tr>
Chris@1 92 </table>
Chris@1 93 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 94 <div class="textblock">
Chris@1 95 <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>
Chris@1 96 </div><hr/><h2>Member Data Documentation</h2>
Chris@1 97 <a class="anchor" id="a01db33a31ae5e04a4bd097f4b6aa75f1"></a><!-- doxytag: member="_VampFeatureList::featureCount" ref="a01db33a31ae5e04a4bd097f4b6aa75f1" args="" -->
Chris@1 98 <div class="memitem">
Chris@1 99 <div class="memproto">
Chris@1 100 <table class="memname">
Chris@1 101 <tr>
Chris@1 102 <td class="memname">unsigned int <a class="el" href="struct__VampFeatureList.html#a01db33a31ae5e04a4bd097f4b6aa75f1">_VampFeatureList::featureCount</a></td>
Chris@1 103 </tr>
Chris@1 104 </table>
Chris@1 105 </div>
Chris@1 106 <div class="memdoc">
Chris@1 107
Chris@1 108 <p>Number of features in this feature list. </p>
Chris@1 109
Chris@1 110 <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>
Chris@1 111
Chris@1 112 </div>
Chris@1 113 </div>
Chris@1 114 <a class="anchor" id="a103c817094643ac5ff4410768f4f92a7"></a><!-- doxytag: member="_VampFeatureList::features" ref="a103c817094643ac5ff4410768f4f92a7" args="" -->
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"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a>* <a class="el" href="struct__VampFeatureList.html#a103c817094643ac5ff4410768f4f92a7">_VampFeatureList::features</a></td>
Chris@1 120 </tr>
Chris@1 121 </table>
Chris@1 122 </div>
Chris@1 123 <div class="memdoc">
Chris@1 124
Chris@1 125 <p>Features in this feature list. </p>
Chris@1 126 <p>May be NULL if featureCount is zero.</p>
Chris@1 127 <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>
Chris@1 128 <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>
Chris@1 129
Chris@1 130 <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>
Chris@1 131
Chris@1 132 </div>
Chris@1 133 </div>
Chris@1 134 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 135 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
Chris@1 136 </ul>
Chris@1 137 </div>
Chris@1 138 </div>
Chris@1 139 <div id="nav-path" class="navpath">
Chris@1 140 <ul>
Chris@1 141 <li class="navelem"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> </li>
Chris@1 142
Chris@1 143 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
Chris@1 144 <a href="http://www.doxygen.org/index.html">
Chris@1 145 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 146 </ul>
Chris@1 147 </div>
Chris@1 148
Chris@1 149
Chris@1 150 </body>
Chris@1 151 </html>