Mercurial > hg > vamp-docs
diff code-docs/struct__VampOutputDescriptor.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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-docs/struct__VampOutputDescriptor.html Tue Oct 04 14:56:07 2011 +0100 @@ -0,0 +1,401 @@ +<!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: _VampOutputDescriptor 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 +  <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 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 List</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class 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__VampOutputDescriptor.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">_VampOutputDescriptor Struct Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="_VampOutputDescriptor" --> +<p><code>#include <<a class="el" href="vamp_8h_source.html">vamp.h</a>></code></p> + +<p><a href="struct__VampOutputDescriptor-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">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a461161b2010370176115967e4f58a5f5">identifier</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the output. <a href="#a461161b2010370176115967e4f58a5f5"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#af4fca576bd47167fd2bf9b43d588815f">name</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the output. <a href="#af4fca576bd47167fd2bf9b43d588815f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#abfa911b138cfb80cf63e8f2e0fa0fb89">description</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the output. <a href="#abfa911b138cfb80cf63e8f2e0fa0fb89"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#ad038caa8e596dfd037035637202f1d63">unit</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the unit of the output. <a href="#ad038caa8e596dfd037035637202f1d63"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#ae8571f5a2bc740738af0cb7dda0c4749">hasFixedBinCount</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if output has equal number of values for each returned result. <a href="#ae8571f5a2bc740738af0cb7dda0c4749"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a652ee422092720e44d23d98bdb68f978">binCount</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of values per result, if hasFixedBinCount. <a href="#a652ee422092720e44d23d98bdb68f978"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a10fffaa32bd894843ff7592240dfe447">binNames</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Names of returned value bins, if hasFixedBinCount. <a href="#a10fffaa32bd894843ff7592240dfe447"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#af6b512d772023b4e852216689c1c4465">hasKnownExtents</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if each returned value falls within the same fixed min/max range. <a href="#af6b512d772023b4e852216689c1c4465"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a9a28180989e3d028c12a98517479dc46">minValue</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value for a returned result in any bin, if hasKnownExtents. <a href="#a9a28180989e3d028c12a98517479dc46"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a4cbe540a247df60f85b00b2aa16461ee">maxValue</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value for a returned result in any bin, if hasKnownExtents. <a href="#a4cbe540a247df60f85b00b2aa16461ee"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#ab56cf0bbb17136819024574d5cc65e30">isQuantized</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if returned results are quantized to a particular resolution. <a href="#ab56cf0bbb17136819024574d5cc65e30"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a71aa40222dda4321030cccd0bb655fe3">quantizeStep</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution for returned results, if isQuantized. <a href="#a71aa40222dda4321030cccd0bb655fe3"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a5da1d27cc99badc214640e859b882072">sampleType</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Time positioning method for returned results (see VampSampleType). <a href="#a5da1d27cc99badc214640e859b882072"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#a1ccf193317b2b9c2eb0dbd8dcf61d26e">sampleRate</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample rate of returned results, if sampleType is vampFixedSampleRate. <a href="#a1ccf193317b2b9c2eb0dbd8dcf61d26e"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#af792a96dbf292ec966b9b68250febd99">hasDuration</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if the returned results for this output are known to have a duration field. <a href="#af792a96dbf292ec966b9b68250febd99"></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#l00118">118</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="a461161b2010370176115967e4f58a5f5"></a><!-- doxytag: member="_VampOutputDescriptor::identifier" ref="a461161b2010370176115967e4f58a5f5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#a461161b2010370176115967e4f58a5f5">_VampOutputDescriptor::identifier</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Computer-usable name of the output. </p> +<p>Must not change. [a-zA-Z0-9_] </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00121">121</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af4fca576bd47167fd2bf9b43d588815f"></a><!-- doxytag: member="_VampOutputDescriptor::name" ref="af4fca576bd47167fd2bf9b43d588815f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#af4fca576bd47167fd2bf9b43d588815f">_VampOutputDescriptor::name</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Human-readable name of the output. </p> +<p>May be translatable. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00124">124</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="abfa911b138cfb80cf63e8f2e0fa0fb89"></a><!-- doxytag: member="_VampOutputDescriptor::description" ref="abfa911b138cfb80cf63e8f2e0fa0fb89" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#abfa911b138cfb80cf63e8f2e0fa0fb89">_VampOutputDescriptor::description</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Human-readable short text about the output. </p> +<p>May be translatable. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00127">127</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ad038caa8e596dfd037035637202f1d63"></a><!-- doxytag: member="_VampOutputDescriptor::unit" ref="ad038caa8e596dfd037035637202f1d63" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#ad038caa8e596dfd037035637202f1d63">_VampOutputDescriptor::unit</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Human-readable name of the unit of the output. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00130">130</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ae8571f5a2bc740738af0cb7dda0c4749"></a><!-- doxytag: member="_VampOutputDescriptor::hasFixedBinCount" ref="ae8571f5a2bc740738af0cb7dda0c4749" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#ae8571f5a2bc740738af0cb7dda0c4749">_VampOutputDescriptor::hasFixedBinCount</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>1 if output has equal number of values for each returned result. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00133">133</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a652ee422092720e44d23d98bdb68f978"></a><!-- doxytag: member="_VampOutputDescriptor::binCount" ref="a652ee422092720e44d23d98bdb68f978" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int <a class="el" href="struct__VampOutputDescriptor.html#a652ee422092720e44d23d98bdb68f978">_VampOutputDescriptor::binCount</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Number of values per result, if hasFixedBinCount. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00136">136</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a10fffaa32bd894843ff7592240dfe447"></a><!-- doxytag: member="_VampOutputDescriptor::binNames" ref="a10fffaa32bd894843ff7592240dfe447" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char** <a class="el" href="struct__VampOutputDescriptor.html#a10fffaa32bd894843ff7592240dfe447">_VampOutputDescriptor::binNames</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Names of returned value bins, if hasFixedBinCount. </p> +<p>May be NULL. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00139">139</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af6b512d772023b4e852216689c1c4465"></a><!-- doxytag: member="_VampOutputDescriptor::hasKnownExtents" ref="af6b512d772023b4e852216689c1c4465" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#af6b512d772023b4e852216689c1c4465">_VampOutputDescriptor::hasKnownExtents</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>1 if each returned value falls within the same fixed min/max range. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00142">142</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9a28180989e3d028c12a98517479dc46"></a><!-- doxytag: member="_VampOutputDescriptor::minValue" ref="a9a28180989e3d028c12a98517479dc46" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#a9a28180989e3d028c12a98517479dc46">_VampOutputDescriptor::minValue</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Minimum value for a returned result in any bin, if hasKnownExtents. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00145">145</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a4cbe540a247df60f85b00b2aa16461ee"></a><!-- doxytag: member="_VampOutputDescriptor::maxValue" ref="a4cbe540a247df60f85b00b2aa16461ee" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#a4cbe540a247df60f85b00b2aa16461ee">_VampOutputDescriptor::maxValue</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Maximum value for a returned result in any bin, if hasKnownExtents. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00148">148</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ab56cf0bbb17136819024574d5cc65e30"></a><!-- doxytag: member="_VampOutputDescriptor::isQuantized" ref="ab56cf0bbb17136819024574d5cc65e30" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#ab56cf0bbb17136819024574d5cc65e30">_VampOutputDescriptor::isQuantized</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>1 if returned results are quantized to a particular resolution. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00151">151</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a71aa40222dda4321030cccd0bb655fe3"></a><!-- doxytag: member="_VampOutputDescriptor::quantizeStep" ref="a71aa40222dda4321030cccd0bb655fe3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#a71aa40222dda4321030cccd0bb655fe3">_VampOutputDescriptor::quantizeStep</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Quantization resolution for returned results, if isQuantized. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00154">154</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a5da1d27cc99badc214640e859b882072"></a><!-- doxytag: member="_VampOutputDescriptor::sampleType" ref="a5da1d27cc99badc214640e859b882072" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> <a class="el" href="struct__VampOutputDescriptor.html#a5da1d27cc99badc214640e859b882072">_VampOutputDescriptor::sampleType</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Time positioning method for returned results (see VampSampleType). </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00157">157</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a1ccf193317b2b9c2eb0dbd8dcf61d26e"></a><!-- doxytag: member="_VampOutputDescriptor::sampleRate" ref="a1ccf193317b2b9c2eb0dbd8dcf61d26e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#a1ccf193317b2b9c2eb0dbd8dcf61d26e">_VampOutputDescriptor::sampleRate</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Sample rate of returned results, if sampleType is vampFixedSampleRate. </p> +<p>"Resolution" of result, if sampleType is vampVariableSampleRate. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00161">161</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af792a96dbf292ec966b9b68250febd99"></a><!-- doxytag: member="_VampOutputDescriptor::hasDuration" ref="af792a96dbf292ec966b9b68250febd99" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#af792a96dbf292ec966b9b68250febd99">_VampOutputDescriptor::hasDuration</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>1 if the returned results for this output are known to have a duration field. </p> +<p>This field is new in <a class="el" href="namespaceVamp.html">Vamp</a> API version 2; it must not be tested for plugins that report an older API version in their plugin descriptor. </p> + +<p>Definition at line <a class="el" href="vamp_8h_source.html#l00170">170</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__VampOutputDescriptor.html">_VampOutputDescriptor</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>