Mercurial > hg > vamp-website
view code-doc/struct__VampOutputDescriptor.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | 351c4ebce5f9 |
| children | 0976232e353b |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: _VampOutputDescriptor Struct Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.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 class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>_VampOutputDescriptor Struct Reference</h1><!-- doxytag: class="_VampOutputDescriptor" --><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><hr><a name="_details"></a><h2>Detailed Description</h2> <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> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#461161b2010370176115967e4f58a5f5">identifier</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the output. <a href="#461161b2010370176115967e4f58a5f5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#f4fca576bd47167fd2bf9b43d588815f">name</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the output. <a href="#f4fca576bd47167fd2bf9b43d588815f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#bfa911b138cfb80cf63e8f2e0fa0fb89">description</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the output. <a href="#bfa911b138cfb80cf63e8f2e0fa0fb89"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#d038caa8e596dfd037035637202f1d63">unit</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the unit of the output. <a href="#d038caa8e596dfd037035637202f1d63"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#e8571f5a2bc740738af0cb7dda0c4749">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="#e8571f5a2bc740738af0cb7dda0c4749"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#652ee422092720e44d23d98bdb68f978">binCount</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of values per result, if hasFixedBinCount. <a href="#652ee422092720e44d23d98bdb68f978"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#10fffaa32bd894843ff7592240dfe447">binNames</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of returned value bins, if hasFixedBinCount. <a href="#10fffaa32bd894843ff7592240dfe447"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#f6b512d772023b4e852216689c1c4465">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="#f6b512d772023b4e852216689c1c4465"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#9a28180989e3d028c12a98517479dc46">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="#9a28180989e3d028c12a98517479dc46"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#4cbe540a247df60f85b00b2aa16461ee">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="#4cbe540a247df60f85b00b2aa16461ee"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#b56cf0bbb17136819024574d5cc65e30">isQuantized</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">1 if returned results are quantized to a particular resolution. <a href="#b56cf0bbb17136819024574d5cc65e30"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#71aa40222dda4321030cccd0bb655fe3">quantizeStep</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution for returned results, if isQuantized. <a href="#71aa40222dda4321030cccd0bb655fe3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#5da1d27cc99badc214640e859b882072">sampleType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Time positioning method for returned results (see VampSampleType). <a href="#5da1d27cc99badc214640e859b882072"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e">sampleRate</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sample rate of returned results, if sampleType is vampFixedSampleRate. <a href="#1ccf193317b2b9c2eb0dbd8dcf61d26e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html#f792a96dbf292ec966b9b68250febd99">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="#f792a96dbf292ec966b9b68250febd99"></a><br></td></tr> </table> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="461161b2010370176115967e4f58a5f5"></a><!-- doxytag: member="_VampOutputDescriptor::identifier" ref="461161b2010370176115967e4f58a5f5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#461161b2010370176115967e4f58a5f5">_VampOutputDescriptor::identifier</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Computer-usable name of the output. <p> Must not change. [a-zA-Z0-9_] <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><p> <a class="anchor" name="f4fca576bd47167fd2bf9b43d588815f"></a><!-- doxytag: member="_VampOutputDescriptor::name" ref="f4fca576bd47167fd2bf9b43d588815f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#f4fca576bd47167fd2bf9b43d588815f">_VampOutputDescriptor::name</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Human-readable name of the output. <p> May be translatable. <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><p> <a class="anchor" name="bfa911b138cfb80cf63e8f2e0fa0fb89"></a><!-- doxytag: member="_VampOutputDescriptor::description" ref="bfa911b138cfb80cf63e8f2e0fa0fb89" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#bfa911b138cfb80cf63e8f2e0fa0fb89">_VampOutputDescriptor::description</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Human-readable short text about the output. <p> May be translatable. <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><p> <a class="anchor" name="d038caa8e596dfd037035637202f1d63"></a><!-- doxytag: member="_VampOutputDescriptor::unit" ref="d038caa8e596dfd037035637202f1d63" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="struct__VampOutputDescriptor.html#d038caa8e596dfd037035637202f1d63">_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><p> <a class="anchor" name="e8571f5a2bc740738af0cb7dda0c4749"></a><!-- doxytag: member="_VampOutputDescriptor::hasFixedBinCount" ref="e8571f5a2bc740738af0cb7dda0c4749" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#e8571f5a2bc740738af0cb7dda0c4749">_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><p> <a class="anchor" name="652ee422092720e44d23d98bdb68f978"></a><!-- doxytag: member="_VampOutputDescriptor::binCount" ref="652ee422092720e44d23d98bdb68f978" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="struct__VampOutputDescriptor.html#652ee422092720e44d23d98bdb68f978">_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><p> <a class="anchor" name="10fffaa32bd894843ff7592240dfe447"></a><!-- doxytag: member="_VampOutputDescriptor::binNames" ref="10fffaa32bd894843ff7592240dfe447" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char** <a class="el" href="struct__VampOutputDescriptor.html#10fffaa32bd894843ff7592240dfe447">_VampOutputDescriptor::binNames</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Names of returned value bins, if hasFixedBinCount. <p> May be NULL. <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><p> <a class="anchor" name="f6b512d772023b4e852216689c1c4465"></a><!-- doxytag: member="_VampOutputDescriptor::hasKnownExtents" ref="f6b512d772023b4e852216689c1c4465" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#f6b512d772023b4e852216689c1c4465">_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><p> <a class="anchor" name="9a28180989e3d028c12a98517479dc46"></a><!-- doxytag: member="_VampOutputDescriptor::minValue" ref="9a28180989e3d028c12a98517479dc46" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#9a28180989e3d028c12a98517479dc46">_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><p> <a class="anchor" name="4cbe540a247df60f85b00b2aa16461ee"></a><!-- doxytag: member="_VampOutputDescriptor::maxValue" ref="4cbe540a247df60f85b00b2aa16461ee" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#4cbe540a247df60f85b00b2aa16461ee">_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><p> <a class="anchor" name="b56cf0bbb17136819024574d5cc65e30"></a><!-- doxytag: member="_VampOutputDescriptor::isQuantized" ref="b56cf0bbb17136819024574d5cc65e30" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#b56cf0bbb17136819024574d5cc65e30">_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><p> <a class="anchor" name="71aa40222dda4321030cccd0bb655fe3"></a><!-- doxytag: member="_VampOutputDescriptor::quantizeStep" ref="71aa40222dda4321030cccd0bb655fe3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#71aa40222dda4321030cccd0bb655fe3">_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><p> <a class="anchor" name="5da1d27cc99badc214640e859b882072"></a><!-- doxytag: member="_VampOutputDescriptor::sampleType" ref="5da1d27cc99badc214640e859b882072" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> <a class="el" href="struct__VampOutputDescriptor.html#5da1d27cc99badc214640e859b882072">_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><p> <a class="anchor" name="1ccf193317b2b9c2eb0dbd8dcf61d26e"></a><!-- doxytag: member="_VampOutputDescriptor::sampleRate" ref="1ccf193317b2b9c2eb0dbd8dcf61d26e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="struct__VampOutputDescriptor.html#1ccf193317b2b9c2eb0dbd8dcf61d26e">_VampOutputDescriptor::sampleRate</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Sample rate of returned results, if sampleType is vampFixedSampleRate. <p> "Resolution" of result, if sampleType is vampVariableSampleRate. <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><p> <a class="anchor" name="f792a96dbf292ec966b9b68250febd99"></a><!-- doxytag: member="_VampOutputDescriptor::hasDuration" ref="f792a96dbf292ec966b9b68250febd99" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="struct__VampOutputDescriptor.html#f792a96dbf292ec966b9b68250febd99">_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> 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>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><p> <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></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>