Mercurial > hg > vamp-docs

view code-docs/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
line wrap: on
line source
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VampPluginSDK: Vamp::Plugin::OutputDescriptor Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structVamp_1_1Plugin_1_1OutputDescriptor.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structVamp_1_1Plugin_1_1OutputDescriptor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Vamp::Plugin::OutputDescriptor Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:abffa9ed50cd756df70fd51f0355f448c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> { <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca">OneSamplePerStep</a>, 
<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>, 
<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">VariableSampleRate</a>
 }</td></tr>
<tr class="separator:abffa9ed50cd756df70fd51f0355f448c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1ebf91cc3f60e4cbba818c10591cd344"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">OutputDescriptor</a> ()</td></tr>
<tr class="separator:a1ebf91cc3f60e4cbba818c10591cd344"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae2c893ddb1860589517ab7eaa989a18b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">identifier</a></td></tr>
<tr class="memdesc:ae2c893ddb1860589517ab7eaa989a18b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the output, in computer-usable form.  <a href="#ae2c893ddb1860589517ab7eaa989a18b">More...</a><br /></td></tr>
<tr class="separator:ae2c893ddb1860589517ab7eaa989a18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab824b2b34ee50f897a30901c620e8d87"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">name</a></td></tr>
<tr class="memdesc:ab824b2b34ee50f897a30901c620e8d87"><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the output.  <a href="#ab824b2b34ee50f897a30901c620e8d87">More...</a><br /></td></tr>
<tr class="separator:ab824b2b34ee50f897a30901c620e8d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b4fe8f78e7126ead820ba5dc55efd1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">description</a></td></tr>
<tr class="memdesc:af9b4fe8f78e7126ead820ba5dc55efd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A human-readable short text describing the output.  <a href="#af9b4fe8f78e7126ead820ba5dc55efd1">More...</a><br /></td></tr>
<tr class="separator:af9b4fe8f78e7126ead820ba5dc55efd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa057a8833fa037f06ac9f7b85b85d5e4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">unit</a></td></tr>
<tr class="memdesc:aa057a8833fa037f06ac9f7b85b85d5e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unit of the output, in human-readable form.  <a href="#aa057a8833fa037f06ac9f7b85b85d5e4">More...</a><br /></td></tr>
<tr class="separator:aa057a8833fa037f06ac9f7b85b85d5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0e577e1a256ff6eed6ea42133fec77d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">hasFixedBinCount</a></td></tr>
<tr class="memdesc:af0e577e1a256ff6eed6ea42133fec77d"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the output has the same number of values per sample for every output sample.  <a href="#af0e577e1a256ff6eed6ea42133fec77d">More...</a><br /></td></tr>
<tr class="separator:af0e577e1a256ff6eed6ea42133fec77d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdd006959a995e40ef7d565a3a4df6dc"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">binCount</a></td></tr>
<tr class="memdesc:afdd006959a995e40ef7d565a3a4df6dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of values per result of the output.  <a href="#afdd006959a995e40ef7d565a3a4df6dc">More...</a><br /></td></tr>
<tr class="separator:afdd006959a995e40ef7d565a3a4df6dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31d9b79e2d8241344f551a22fcb5c8c7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">binNames</a></td></tr>
<tr class="memdesc:a31d9b79e2d8241344f551a22fcb5c8c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate.  <a href="#a31d9b79e2d8241344f551a22fcb5c8c7">More...</a><br /></td></tr>
<tr class="separator:a31d9b79e2d8241344f551a22fcb5c8c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9ccb65f99f477096b65dd031f4c5e31"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">hasKnownExtents</a></td></tr>
<tr class="memdesc:ae9ccb65f99f477096b65dd031f4c5e31"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).  <a href="#ae9ccb65f99f477096b65dd031f4c5e31">More...</a><br /></td></tr>
<tr class="separator:ae9ccb65f99f477096b65dd031f4c5e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9f5924c0be7571bba8e7ae7e7a921f4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">minValue</a></td></tr>
<tr class="memdesc:ac9f5924c0be7571bba8e7ae7e7a921f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value of the results in the output.  <a href="#ac9f5924c0be7571bba8e7ae7e7a921f4">More...</a><br /></td></tr>
<tr class="separator:ac9f5924c0be7571bba8e7ae7e7a921f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a907b4e8fbb48a46ac5a05f880d72719f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">maxValue</a></td></tr>
<tr class="memdesc:a907b4e8fbb48a46ac5a05f880d72719f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value of the results in the output.  <a href="#a907b4e8fbb48a46ac5a05f880d72719f">More...</a><br /></td></tr>
<tr class="separator:a907b4e8fbb48a46ac5a05f880d72719f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b4858928d23bfd7d5bc557c82a83fb4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">isQuantized</a></td></tr>
<tr class="memdesc:a1b4858928d23bfd7d5bc557c82a83fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the output values are quantized to a particular resolution.  <a href="#a1b4858928d23bfd7d5bc557c82a83fb4">More...</a><br /></td></tr>
<tr class="separator:a1b4858928d23bfd7d5bc557c82a83fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bed37153067b625b95acb40b60dbf0b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">quantizeStep</a></td></tr>
<tr class="memdesc:a3bed37153067b625b95acb40b60dbf0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution of the output values (e.g.  <a href="#a3bed37153067b625b95acb40b60dbf0b">More...</a><br /></td></tr>
<tr class="separator:a3bed37153067b625b95acb40b60dbf0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1194980d44e31b25ef3b4b070d6b5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a></td></tr>
<tr class="memdesc:a0d1194980d44e31b25ef3b4b070d6b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Positioning in time of the output results.  <a href="#a0d1194980d44e31b25ef3b4b070d6b5d">More...</a><br /></td></tr>
<tr class="separator:a0d1194980d44e31b25ef3b4b070d6b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add0cbbdfa9c91764037c39365b1d42af"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">sampleRate</a></td></tr>
<tr class="memdesc:add0cbbdfa9c91764037c39365b1d42af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample rate of the output results, as samples per second.  <a href="#add0cbbdfa9c91764037c39365b1d42af">More...</a><br /></td></tr>
<tr class="separator:add0cbbdfa9c91764037c39365b1d42af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0d7cc6ab19e53b5bd12ee234f549ea3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">hasDuration</a></td></tr>
<tr class="memdesc:ab0d7cc6ab19e53b5bd12ee234f549ea3"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the returned results for this output are known to have a duration field.  <a href="#ab0d7cc6ab19e53b5bd12ee234f549ea3">More...</a><br /></td></tr>
<tr class="separator:ab0d7cc6ab19e53b5bd12ee234f549ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00206">206</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="abffa9ed50cd756df70fd51f0355f448c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abffa9ed50cd756df70fd51f0355f448c">&#9670;&nbsp;</a></span>SampleType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca"></a>OneSamplePerStep&#160;</td><td class="fielddoc"><p>Results from each <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data. ">process()</a> align with that call's block start. </p>
</td></tr>
<tr><td class="fieldname"><a id="abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629"></a>FixedSampleRate&#160;</td><td class="fielddoc"><p>Results are evenly spaced in time (sampleRate specified below) </p>
</td></tr>
<tr><td class="fieldname"><a id="abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e"></a>VariableSampleRate&#160;</td><td class="fielddoc"><p>Results are unevenly spaced and have individual timestamps. </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00287">287</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1ebf91cc3f60e4cbba818c10591cd344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ebf91cc3f60e4cbba818c10591cd344">&#9670;&nbsp;</a></span>OutputDescriptor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Vamp::Plugin::OutputDescriptor::OutputDescriptor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae2c893ddb1860589517ab7eaa989a18b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c893ddb1860589517ab7eaa989a18b">&#9670;&nbsp;</a></span>identifier</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::OutputDescriptor::identifier</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of the output, in computer-usable form. </p>
<p>Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">214</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="ab824b2b34ee50f897a30901c620e8d87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab824b2b34ee50f897a30901c620e8d87">&#9670;&nbsp;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::OutputDescriptor::name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The human-readable name of the output. </p>
<p>Example: "Zero Crossing Counts" </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">220</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="af9b4fe8f78e7126ead820ba5dc55efd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9b4fe8f78e7126ead820ba5dc55efd1">&#9670;&nbsp;</a></span>description</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::OutputDescriptor::description</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A human-readable short text describing the output. </p>
<p>May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">227</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="aa057a8833fa037f06ac9f7b85b85d5e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa057a8833fa037f06ac9f7b85b85d5e4">&#9670;&nbsp;</a></span>unit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::OutputDescriptor::unit</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The unit of the output, in human-readable form. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">232</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="af0e577e1a256ff6eed6ea42133fec77d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0e577e1a256ff6eed6ea42133fec77d">&#9670;&nbsp;</a></span>hasFixedBinCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::OutputDescriptor::hasFixedBinCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if the output has the same number of values per sample for every output sample. </p>
<p>Outputs for which this is false are unlikely to be very useful in a general-purpose host. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">239</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="afdd006959a995e40ef7d565a3a4df6dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdd006959a995e40ef7d565a3a4df6dc">&#9670;&nbsp;</a></span>binCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t Vamp::Plugin::OutputDescriptor::binCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The number of values per result of the output. </p>
<p>Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty). </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">247</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="a31d9b79e2d8241344f551a22fcb5c8c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31d9b79e2d8241344f551a22fcb5c8c7">&#9670;&nbsp;</a></span>binNames</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;std::string&gt; Vamp::Plugin::OutputDescriptor::binNames</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The (human-readable) names of each of the bins, if appropriate. </p>
<p>This is always optional. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00253">253</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

</div>
</div>
<a id="ae9ccb65f99f477096b65dd031f4c5e31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9ccb65f99f477096b65dd031f4c5e31">&#9670;&nbsp;</a></span>hasKnownExtents</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::OutputDescriptor::hasKnownExtents</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). </p>
<p>Undefined if binCount is zero. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">260</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="ac9f5924c0be7571bba8e7ae7e7a921f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9f5924c0be7571bba8e7ae7e7a921f4">&#9670;&nbsp;</a></span>minValue</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Vamp::Plugin::OutputDescriptor::minValue</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minimum value of the results in the output. </p>
<p>Undefined if hasKnownExtents is false or binCount is zero. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00266">266</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="a907b4e8fbb48a46ac5a05f880d72719f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a907b4e8fbb48a46ac5a05f880d72719f">&#9670;&nbsp;</a></span>maxValue</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Vamp::Plugin::OutputDescriptor::maxValue</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum value of the results in the output. </p>
<p>Undefined if hasKnownExtents is false or binCount is zero. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00272">272</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="a1b4858928d23bfd7d5bc557c82a83fb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b4858928d23bfd7d5bc557c82a83fb4">&#9670;&nbsp;</a></span>isQuantized</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::OutputDescriptor::isQuantized</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if the output values are quantized to a particular resolution. </p>
<p>Undefined if binCount is zero. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">278</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="a3bed37153067b625b95acb40b60dbf0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bed37153067b625b95acb40b60dbf0b">&#9670;&nbsp;</a></span>quantizeStep</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Vamp::Plugin::OutputDescriptor::quantizeStep</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Quantization resolution of the output values (e.g. </p>
<p>1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00285">285</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="a0d1194980d44e31b25ef3b4b070d6b5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1194980d44e31b25ef3b4b070d6b5d">&#9670;&nbsp;</a></span>sampleType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> Vamp::Plugin::OutputDescriptor::sampleType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Positioning in time of the output results. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">302</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00129">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="add0cbbdfa9c91764037c39365b1d42af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add0cbbdfa9c91764037c39365b1d42af">&#9670;&nbsp;</a></span>sampleRate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float Vamp::Plugin::OutputDescriptor::sampleRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sample rate of the output results, as samples per second. </p>
<p>Undefined if sampleType is OneSamplePerStep.</p>
<p>If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">314</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00112">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>

</div>
</div>
<a id="ab0d7cc6ab19e53b5bd12ee234f549ea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0d7cc6ab19e53b5bd12ee234f549ea3">&#9670;&nbsp;</a></span>hasDuration</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::OutputDescriptor::hasDuration</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>True if the returned results for this output are known to have a duration field. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00320">320</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></li><li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>