Mercurial > hg > vamp-docs

annotate code-docs/struct__VampFeature.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
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: _VampFeature 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__VampFeature.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">_VampFeature Struct Reference</div> </div>
Chris@1 79 </div>
Chris@1 80 <div class="contents">
Chris@1 81 <!-- doxytag: class="_VampFeature" -->
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__VampFeature-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">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#abe6aa7a08185beeb9deca2d08d99859f">hasTimestamp</a></td></tr>
Chris@1 89 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if the feature has a timestamp (i.e. <a href="#abe6aa7a08185beeb9deca2d08d99859f"></a><br/></td></tr>
Chris@1 90 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#a31f0b57050e33d082692536097953d9c">sec</a></td></tr>
Chris@1 91 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Seconds component of timestamp. <a href="#a31f0b57050e33d082692536097953d9c"></a><br/></td></tr>
Chris@1 92 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#a8874cb23600c6b10ca6e8a40920d999e">nsec</a></td></tr>
Chris@1 93 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Nanoseconds component of timestamp. <a href="#a8874cb23600c6b10ca6e8a40920d999e"></a><br/></td></tr>
Chris@1 94 <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#ab1ce7c8a2b489e9b0694a967497a29fd">valueCount</a></td></tr>
Chris@1 95 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of values. <a href="#ab1ce7c8a2b489e9b0694a967497a29fd"></a><br/></td></tr>
Chris@1 96 <tr><td class="memItemLeft" align="right" valign="top">float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#ae4030f941ddb2bab8bc147b88e1f1c15">values</a></td></tr>
Chris@1 97 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Values for this returned sample. <a href="#ae4030f941ddb2bab8bc147b88e1f1c15"></a><br/></td></tr>
Chris@1 98 <tr><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#a6662b7489a7890cae713bf4e8f6d52cd">label</a></td></tr>
Chris@1 99 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Label for this returned sample. <a href="#a6662b7489a7890cae713bf4e8f6d52cd"></a><br/></td></tr>
Chris@1 100 </table>
Chris@1 101 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 102 <div class="textblock">
Chris@1 103 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00174">174</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 104 </div><hr/><h2>Member Data Documentation</h2>
Chris@1 105 <a class="anchor" id="abe6aa7a08185beeb9deca2d08d99859f"></a><!-- doxytag: member="_VampFeature::hasTimestamp" ref="abe6aa7a08185beeb9deca2d08d99859f" args="" -->
Chris@1 106 <div class="memitem">
Chris@1 107 <div class="memproto">
Chris@1 108 <table class="memname">
Chris@1 109 <tr>
Chris@1 110 <td class="memname">int <a class="el" href="struct__VampFeature.html#abe6aa7a08185beeb9deca2d08d99859f">_VampFeature::hasTimestamp</a></td>
Chris@1 111 </tr>
Chris@1 112 </table>
Chris@1 113 </div>
Chris@1 114 <div class="memdoc">
Chris@1 115
Chris@1 116 <p>1 if the feature has a timestamp (i.e. </p>
Chris@1 117 <p>if vampVariableSampleRate). </p>
Chris@1 118
Chris@1 119 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00177">177</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 120
Chris@1 121 </div>
Chris@1 122 </div>
Chris@1 123 <a class="anchor" id="a31f0b57050e33d082692536097953d9c"></a><!-- doxytag: member="_VampFeature::sec" ref="a31f0b57050e33d082692536097953d9c" args="" -->
Chris@1 124 <div class="memitem">
Chris@1 125 <div class="memproto">
Chris@1 126 <table class="memname">
Chris@1 127 <tr>
Chris@1 128 <td class="memname">int <a class="el" href="struct__VampFeature.html#a31f0b57050e33d082692536097953d9c">_VampFeature::sec</a></td>
Chris@1 129 </tr>
Chris@1 130 </table>
Chris@1 131 </div>
Chris@1 132 <div class="memdoc">
Chris@1 133
Chris@1 134 <p>Seconds component of timestamp. </p>
Chris@1 135
Chris@1 136 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00180">180</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 137
Chris@1 138 </div>
Chris@1 139 </div>
Chris@1 140 <a class="anchor" id="a8874cb23600c6b10ca6e8a40920d999e"></a><!-- doxytag: member="_VampFeature::nsec" ref="a8874cb23600c6b10ca6e8a40920d999e" args="" -->
Chris@1 141 <div class="memitem">
Chris@1 142 <div class="memproto">
Chris@1 143 <table class="memname">
Chris@1 144 <tr>
Chris@1 145 <td class="memname">int <a class="el" href="struct__VampFeature.html#a8874cb23600c6b10ca6e8a40920d999e">_VampFeature::nsec</a></td>
Chris@1 146 </tr>
Chris@1 147 </table>
Chris@1 148 </div>
Chris@1 149 <div class="memdoc">
Chris@1 150
Chris@1 151 <p>Nanoseconds component of timestamp. </p>
Chris@1 152
Chris@1 153 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00183">183</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 154
Chris@1 155 </div>
Chris@1 156 </div>
Chris@1 157 <a class="anchor" id="ab1ce7c8a2b489e9b0694a967497a29fd"></a><!-- doxytag: member="_VampFeature::valueCount" ref="ab1ce7c8a2b489e9b0694a967497a29fd" args="" -->
Chris@1 158 <div class="memitem">
Chris@1 159 <div class="memproto">
Chris@1 160 <table class="memname">
Chris@1 161 <tr>
Chris@1 162 <td class="memname">unsigned int <a class="el" href="struct__VampFeature.html#ab1ce7c8a2b489e9b0694a967497a29fd">_VampFeature::valueCount</a></td>
Chris@1 163 </tr>
Chris@1 164 </table>
Chris@1 165 </div>
Chris@1 166 <div class="memdoc">
Chris@1 167
Chris@1 168 <p>Number of values. </p>
Chris@1 169 <p>Must be binCount if hasFixedBinCount. </p>
Chris@1 170
Chris@1 171 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00186">186</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 172
Chris@1 173 </div>
Chris@1 174 </div>
Chris@1 175 <a class="anchor" id="ae4030f941ddb2bab8bc147b88e1f1c15"></a><!-- doxytag: member="_VampFeature::values" ref="ae4030f941ddb2bab8bc147b88e1f1c15" args="" -->
Chris@1 176 <div class="memitem">
Chris@1 177 <div class="memproto">
Chris@1 178 <table class="memname">
Chris@1 179 <tr>
Chris@1 180 <td class="memname">float* <a class="el" href="struct__VampFeature.html#ae4030f941ddb2bab8bc147b88e1f1c15">_VampFeature::values</a></td>
Chris@1 181 </tr>
Chris@1 182 </table>
Chris@1 183 </div>
Chris@1 184 <div class="memdoc">
Chris@1 185
Chris@1 186 <p>Values for this returned sample. </p>
Chris@1 187
Chris@1 188 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00189">189</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 189
Chris@1 190 </div>
Chris@1 191 </div>
Chris@1 192 <a class="anchor" id="a6662b7489a7890cae713bf4e8f6d52cd"></a><!-- doxytag: member="_VampFeature::label" ref="a6662b7489a7890cae713bf4e8f6d52cd" args="" -->
Chris@1 193 <div class="memitem">
Chris@1 194 <div class="memproto">
Chris@1 195 <table class="memname">
Chris@1 196 <tr>
Chris@1 197 <td class="memname">char* <a class="el" href="struct__VampFeature.html#a6662b7489a7890cae713bf4e8f6d52cd">_VampFeature::label</a></td>
Chris@1 198 </tr>
Chris@1 199 </table>
Chris@1 200 </div>
Chris@1 201 <div class="memdoc">
Chris@1 202
Chris@1 203 <p>Label for this returned sample. </p>
Chris@1 204 <p>May be NULL. </p>
Chris@1 205
Chris@1 206 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00192">192</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 207
Chris@1 208 </div>
Chris@1 209 </div>
Chris@1 210 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 211 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
Chris@1 212 </ul>
Chris@1 213 </div>
Chris@1 214 </div>
Chris@1 215 <div id="nav-path" class="navpath">
Chris@1 216 <ul>
Chris@1 217 <li class="navelem"><a class="el" href="struct__VampFeature.html">_VampFeature</a> </li>
Chris@1 218
Chris@1 219 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
Chris@1 220 <a href="http://www.doxygen.org/index.html">
Chris@1 221 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 222 </ul>
Chris@1 223 </div>
Chris@1 224
Chris@1 225
Chris@1 226 </body>
Chris@1 227 </html>