Mercurial > hg > vamp-docs

diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/code-docs/struct__VampFeature.html	Tue Oct 04 14:56:07 2011 +0100
@@ -0,0 +1,227 @@
+<!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: _VampFeature 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__VampFeature.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">_VampFeature Struct Reference</div>  </div>
+</div>
+<div class="contents">
+<!-- doxytag: class="_VampFeature" -->
+<p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
+
+<p><a href="struct__VampFeature-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">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html#abe6aa7a08185beeb9deca2d08d99859f">hasTimestamp</a></td></tr>
+<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>
+<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>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Seconds component of timestamp.  <a href="#a31f0b57050e33d082692536097953d9c"></a><br/></td></tr>
+<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>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Nanoseconds component of timestamp.  <a href="#a8874cb23600c6b10ca6e8a40920d999e"></a><br/></td></tr>
+<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>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of values.  <a href="#ab1ce7c8a2b489e9b0694a967497a29fd"></a><br/></td></tr>
+<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>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Values for this returned sample.  <a href="#ae4030f941ddb2bab8bc147b88e1f1c15"></a><br/></td></tr>
+<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>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Label for this returned sample.  <a href="#a6662b7489a7890cae713bf4e8f6d52cd"></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#l00174">174</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="abe6aa7a08185beeb9deca2d08d99859f"></a><!-- doxytag: member="_VampFeature::hasTimestamp" ref="abe6aa7a08185beeb9deca2d08d99859f" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="struct__VampFeature.html#abe6aa7a08185beeb9deca2d08d99859f">_VampFeature::hasTimestamp</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>1 if the feature has a timestamp (i.e. </p>
+<p>if vampVariableSampleRate). </p>
+
+<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>
+
+</div>
+</div>
+<a class="anchor" id="a31f0b57050e33d082692536097953d9c"></a><!-- doxytag: member="_VampFeature::sec" ref="a31f0b57050e33d082692536097953d9c" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="struct__VampFeature.html#a31f0b57050e33d082692536097953d9c">_VampFeature::sec</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Seconds component of timestamp. </p>
+
+<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>
+
+</div>
+</div>
+<a class="anchor" id="a8874cb23600c6b10ca6e8a40920d999e"></a><!-- doxytag: member="_VampFeature::nsec" ref="a8874cb23600c6b10ca6e8a40920d999e" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int <a class="el" href="struct__VampFeature.html#a8874cb23600c6b10ca6e8a40920d999e">_VampFeature::nsec</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Nanoseconds component of timestamp. </p>
+
+<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>
+
+</div>
+</div>
+<a class="anchor" id="ab1ce7c8a2b489e9b0694a967497a29fd"></a><!-- doxytag: member="_VampFeature::valueCount" ref="ab1ce7c8a2b489e9b0694a967497a29fd" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned int <a class="el" href="struct__VampFeature.html#ab1ce7c8a2b489e9b0694a967497a29fd">_VampFeature::valueCount</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Number of values. </p>
+<p>Must be binCount if hasFixedBinCount. </p>
+
+<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>
+
+</div>
+</div>
+<a class="anchor" id="ae4030f941ddb2bab8bc147b88e1f1c15"></a><!-- doxytag: member="_VampFeature::values" ref="ae4030f941ddb2bab8bc147b88e1f1c15" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">float* <a class="el" href="struct__VampFeature.html#ae4030f941ddb2bab8bc147b88e1f1c15">_VampFeature::values</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Values for this returned sample. </p>
+
+<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>
+
+</div>
+</div>
+<a class="anchor" id="a6662b7489a7890cae713bf4e8f6d52cd"></a><!-- doxytag: member="_VampFeature::label" ref="a6662b7489a7890cae713bf4e8f6d52cd" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* <a class="el" href="struct__VampFeature.html#a6662b7489a7890cae713bf4e8f6d52cd">_VampFeature::label</a></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Label for this returned sample. </p>
+<p>May be NULL. </p>
+
+<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>
+
+</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__VampFeature.html">_VampFeature</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>