Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::Plugin::OutputDescriptor Struct Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1Plugin.html">Plugin</a>::<a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@0 29 <h1>Vamp::Plugin::OutputDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::OutputDescriptor" --><code>#include &lt;<a class="el" href="Plugin_8h-source.html">Plugin.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@0 33 <a href="structVamp_1_1Plugin_1_1OutputDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 34
cannam@0 35 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00198">198</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 36 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 37 <tr><td></td></tr>
cannam@0 38 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@0 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> { <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca">OneSamplePerStep</a>,
cannam@0 40 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>,
cannam@0 41 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e">VariableSampleRate</a>
cannam@0 42 }</td></tr>
cannam@0 43
cannam@0 44 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@0 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">identifier</a></td></tr>
cannam@0 46
cannam@0 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#e2c893ddb1860589517ab7eaa989a18b"></a><br></td></tr>
cannam@0 48 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">name</a></td></tr>
cannam@0 49
cannam@0 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the output. <a href="#b824b2b34ee50f897a30901c620e8d87"></a><br></td></tr>
cannam@0 51 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">description</a></td></tr>
cannam@0 52
cannam@0 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the output. <a href="#f9b4fe8f78e7126ead820ba5dc55efd1"></a><br></td></tr>
cannam@0 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">unit</a></td></tr>
cannam@0 55
cannam@0 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#a057a8833fa037f06ac9f7b85b85d5e4"></a><br></td></tr>
cannam@0 57 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d">hasFixedBinCount</a></td></tr>
cannam@0 58
cannam@0 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the output has the same number of values per sample for every output sample. <a href="#f0e577e1a256ff6eed6ea42133fec77d"></a><br></td></tr>
cannam@0 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc">binCount</a></td></tr>
cannam@0 61
cannam@0 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of values per result of the output. <a href="#fdd006959a995e40ef7d565a3a4df6dc"></a><br></td></tr>
cannam@0 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7">binNames</a></td></tr>
cannam@0 64
cannam@0 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate. <a href="#31d9b79e2d8241344f551a22fcb5c8c7"></a><br></td></tr>
cannam@0 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">hasKnownExtents</a></td></tr>
cannam@0 67
cannam@0 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). <a href="#e9ccb65f99f477096b65dd031f4c5e31"></a><br></td></tr>
cannam@0 69 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">minValue</a></td></tr>
cannam@0 70
cannam@0 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum value of the results in the output. <a href="#c9f5924c0be7571bba8e7ae7e7a921f4"></a><br></td></tr>
cannam@0 72 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">maxValue</a></td></tr>
cannam@0 73
cannam@0 74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum value of the results in the output. <a href="#907b4e8fbb48a46ac5a05f880d72719f"></a><br></td></tr>
cannam@0 75 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">isQuantized</a></td></tr>
cannam@0 76
cannam@0 77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the output values are quantized to a particular resolution. <a href="#1b4858928d23bfd7d5bc557c82a83fb4"></a><br></td></tr>
cannam@0 78 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">quantizeStep</a></td></tr>
cannam@0 79
cannam@0 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#3bed37153067b625b95acb40b60dbf0b"></a><br></td></tr>
cannam@0 81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a></td></tr>
cannam@0 82
cannam@0 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Positioning in time of the output results. <a href="#0d1194980d44e31b25ef3b4b070d6b5d"></a><br></td></tr>
cannam@0 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af">sampleRate</a></td></tr>
cannam@0 85
cannam@0 86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#dd0cbbdfa9c91764037c39365b1d42af"></a><br></td></tr>
cannam@0 87 </table>
cannam@0 88 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 89 <a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::SampleType" ref="bffa9ed50cd756df70fd51f0355f448c" args="" -->
cannam@0 90 <div class="memitem">
cannam@0 91 <div class="memproto">
cannam@0 92 <table class="memname">
cannam@0 93 <tr>
cannam@0 94 <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a> </td>
cannam@0 95 </tr>
cannam@0 96 </table>
cannam@0 97 </div>
cannam@0 98 <div class="memdoc">
cannam@0 99
cannam@0 100 <p>
cannam@0 101 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 102 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 103 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca"></a><!-- doxytag: member="OneSamplePerStep" ref="bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca" args="" -->OneSamplePerStep</em>&nbsp;</td><td>
cannam@0 104 Results from each <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> align with that call's block start. </td></tr>
cannam@0 105 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629"></a><!-- doxytag: member="FixedSampleRate" ref="bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629" args="" -->FixedSampleRate</em>&nbsp;</td><td>
cannam@0 106 Results are evenly spaced in time (sampleRate specified below). </td></tr>
cannam@0 107 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e"></a><!-- doxytag: member="VariableSampleRate" ref="bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e" args="" -->VariableSampleRate</em>&nbsp;</td><td>
cannam@0 108 Results are unevenly spaced and have individual timestamps. </td></tr>
cannam@0 109 </table>
cannam@0 110 </dl>
cannam@0 111
cannam@0 112 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00279">279</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 113
cannam@0 114 </div>
cannam@0 115 </div><p>
cannam@0 116 <hr><h2>Member Data Documentation</h2>
cannam@0 117 <a class="anchor" name="e2c893ddb1860589517ab7eaa989a18b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="e2c893ddb1860589517ab7eaa989a18b" args="" -->
cannam@0 118 <div class="memitem">
cannam@0 119 <div class="memproto">
cannam@0 120 <table class="memname">
cannam@0 121 <tr>
cannam@0 122 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">Vamp::Plugin::OutputDescriptor::identifier</a> </td>
cannam@0 123 </tr>
cannam@0 124 </table>
cannam@0 125 </div>
cannam@0 126 <div class="memdoc">
cannam@0 127
cannam@0 128 <p>
cannam@0 129 The name of the output, in computer-usable form.
cannam@0 130 <p>
cannam@0 131 Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count"
cannam@0 132 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00206">206</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 133
cannam@0 134 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 135
cannam@0 136 </div>
cannam@0 137 </div><p>
cannam@0 138 <a class="anchor" name="b824b2b34ee50f897a30901c620e8d87"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="b824b2b34ee50f897a30901c620e8d87" args="" -->
cannam@0 139 <div class="memitem">
cannam@0 140 <div class="memproto">
cannam@0 141 <table class="memname">
cannam@0 142 <tr>
cannam@0 143 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">Vamp::Plugin::OutputDescriptor::name</a> </td>
cannam@0 144 </tr>
cannam@0 145 </table>
cannam@0 146 </div>
cannam@0 147 <div class="memdoc">
cannam@0 148
cannam@0 149 <p>
cannam@0 150 The human-readable name of the output.
cannam@0 151 <p>
cannam@0 152 Example: "Zero Crossing Counts"
cannam@0 153 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00212">212</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 154
cannam@0 155 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 156
cannam@0 157 </div>
cannam@0 158 </div><p>
cannam@0 159 <a class="anchor" name="f9b4fe8f78e7126ead820ba5dc55efd1"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="f9b4fe8f78e7126ead820ba5dc55efd1" args="" -->
cannam@0 160 <div class="memitem">
cannam@0 161 <div class="memproto">
cannam@0 162 <table class="memname">
cannam@0 163 <tr>
cannam@0 164 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">Vamp::Plugin::OutputDescriptor::description</a> </td>
cannam@0 165 </tr>
cannam@0 166 </table>
cannam@0 167 </div>
cannam@0 168 <div class="memdoc">
cannam@0 169
cannam@0 170 <p>
cannam@0 171 A human-readable short text describing the output.
cannam@0 172 <p>
cannam@0 173 May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block"
cannam@0 174 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00219">219</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 175
cannam@0 176 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 177
cannam@0 178 </div>
cannam@0 179 </div><p>
cannam@0 180 <a class="anchor" name="a057a8833fa037f06ac9f7b85b85d5e4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="a057a8833fa037f06ac9f7b85b85d5e4" args="" -->
cannam@0 181 <div class="memitem">
cannam@0 182 <div class="memproto">
cannam@0 183 <table class="memname">
cannam@0 184 <tr>
cannam@0 185 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">Vamp::Plugin::OutputDescriptor::unit</a> </td>
cannam@0 186 </tr>
cannam@0 187 </table>
cannam@0 188 </div>
cannam@0 189 <div class="memdoc">
cannam@0 190
cannam@0 191 <p>
cannam@0 192 The unit of the output, in human-readable form.
cannam@0 193 <p>
cannam@0 194
cannam@0 195 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00224">224</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 196
cannam@0 197 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 198
cannam@0 199 </div>
cannam@0 200 </div><p>
cannam@0 201 <a class="anchor" name="f0e577e1a256ff6eed6ea42133fec77d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="f0e577e1a256ff6eed6ea42133fec77d" args="" -->
cannam@0 202 <div class="memitem">
cannam@0 203 <div class="memproto">
cannam@0 204 <table class="memname">
cannam@0 205 <tr>
cannam@0 206 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a> </td>
cannam@0 207 </tr>
cannam@0 208 </table>
cannam@0 209 </div>
cannam@0 210 <div class="memdoc">
cannam@0 211
cannam@0 212 <p>
cannam@0 213 True if the output has the same number of values per sample for every output sample.
cannam@0 214 <p>
cannam@0 215 Outputs for which this is false are unlikely to be very useful in a general-purpose host.
cannam@0 216 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00231">231</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 217
cannam@0 218 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 219
cannam@0 220 </div>
cannam@0 221 </div><p>
cannam@0 222 <a class="anchor" name="fdd006959a995e40ef7d565a3a4df6dc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="fdd006959a995e40ef7d565a3a4df6dc" args="" -->
cannam@0 223 <div class="memitem">
cannam@0 224 <div class="memproto">
cannam@0 225 <table class="memname">
cannam@0 226 <tr>
cannam@0 227 <td class="memname">size_t <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc">Vamp::Plugin::OutputDescriptor::binCount</a> </td>
cannam@0 228 </tr>
cannam@0 229 </table>
cannam@0 230 </div>
cannam@0 231 <div class="memdoc">
cannam@0 232
cannam@0 233 <p>
cannam@0 234 The number of values per result of the output.
cannam@0 235 <p>
cannam@0 236 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).
cannam@0 237 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00239">239</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 238
cannam@0 239 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 240
cannam@0 241 </div>
cannam@0 242 </div><p>
cannam@0 243 <a class="anchor" name="31d9b79e2d8241344f551a22fcb5c8c7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="31d9b79e2d8241344f551a22fcb5c8c7" args="" -->
cannam@0 244 <div class="memitem">
cannam@0 245 <div class="memproto">
cannam@0 246 <table class="memname">
cannam@0 247 <tr>
cannam@0 248 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7">Vamp::Plugin::OutputDescriptor::binNames</a> </td>
cannam@0 249 </tr>
cannam@0 250 </table>
cannam@0 251 </div>
cannam@0 252 <div class="memdoc">
cannam@0 253
cannam@0 254 <p>
cannam@0 255 The (human-readable) names of each of the bins, if appropriate.
cannam@0 256 <p>
cannam@0 257 This is always optional.
cannam@0 258 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00245">245</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 259
cannam@0 260 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
cannam@0 261
cannam@0 262 </div>
cannam@0 263 </div><p>
cannam@0 264 <a class="anchor" name="e9ccb65f99f477096b65dd031f4c5e31"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="e9ccb65f99f477096b65dd031f4c5e31" args="" -->
cannam@0 265 <div class="memitem">
cannam@0 266 <div class="memproto">
cannam@0 267 <table class="memname">
cannam@0 268 <tr>
cannam@0 269 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a> </td>
cannam@0 270 </tr>
cannam@0 271 </table>
cannam@0 272 </div>
cannam@0 273 <div class="memdoc">
cannam@0 274
cannam@0 275 <p>
cannam@0 276 True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).
cannam@0 277 <p>
cannam@0 278 Undefined if binCount is zero.
cannam@0 279 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00252">252</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 280
cannam@0 281 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 282
cannam@0 283 </div>
cannam@0 284 </div><p>
cannam@0 285 <a class="anchor" name="c9f5924c0be7571bba8e7ae7e7a921f4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="c9f5924c0be7571bba8e7ae7e7a921f4" args="" -->
cannam@0 286 <div class="memitem">
cannam@0 287 <div class="memproto">
cannam@0 288 <table class="memname">
cannam@0 289 <tr>
cannam@0 290 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">Vamp::Plugin::OutputDescriptor::minValue</a> </td>
cannam@0 291 </tr>
cannam@0 292 </table>
cannam@0 293 </div>
cannam@0 294 <div class="memdoc">
cannam@0 295
cannam@0 296 <p>
cannam@0 297 Minimum value of the results in the output.
cannam@0 298 <p>
cannam@0 299 Undefined if hasKnownExtents is false or binCount is zero.
cannam@0 300 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00258">258</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 301
cannam@0 302 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
cannam@0 303
cannam@0 304 </div>
cannam@0 305 </div><p>
cannam@0 306 <a class="anchor" name="907b4e8fbb48a46ac5a05f880d72719f"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="907b4e8fbb48a46ac5a05f880d72719f" args="" -->
cannam@0 307 <div class="memitem">
cannam@0 308 <div class="memproto">
cannam@0 309 <table class="memname">
cannam@0 310 <tr>
cannam@0 311 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">Vamp::Plugin::OutputDescriptor::maxValue</a> </td>
cannam@0 312 </tr>
cannam@0 313 </table>
cannam@0 314 </div>
cannam@0 315 <div class="memdoc">
cannam@0 316
cannam@0 317 <p>
cannam@0 318 Maximum value of the results in the output.
cannam@0 319 <p>
cannam@0 320 Undefined if hasKnownExtents is false or binCount is zero.
cannam@0 321 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00264">264</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 322
cannam@0 323 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>.</p>
cannam@0 324
cannam@0 325 </div>
cannam@0 326 </div><p>
cannam@0 327 <a class="anchor" name="1b4858928d23bfd7d5bc557c82a83fb4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="1b4858928d23bfd7d5bc557c82a83fb4" args="" -->
cannam@0 328 <div class="memitem">
cannam@0 329 <div class="memproto">
cannam@0 330 <table class="memname">
cannam@0 331 <tr>
cannam@0 332 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">Vamp::Plugin::OutputDescriptor::isQuantized</a> </td>
cannam@0 333 </tr>
cannam@0 334 </table>
cannam@0 335 </div>
cannam@0 336 <div class="memdoc">
cannam@0 337
cannam@0 338 <p>
cannam@0 339 True if the output values are quantized to a particular resolution.
cannam@0 340 <p>
cannam@0 341 Undefined if binCount is zero.
cannam@0 342 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00270">270</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 343
cannam@0 344 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 345
cannam@0 346 </div>
cannam@0 347 </div><p>
cannam@0 348 <a class="anchor" name="3bed37153067b625b95acb40b60dbf0b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="3bed37153067b625b95acb40b60dbf0b" args="" -->
cannam@0 349 <div class="memitem">
cannam@0 350 <div class="memproto">
cannam@0 351 <table class="memname">
cannam@0 352 <tr>
cannam@0 353 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">Vamp::Plugin::OutputDescriptor::quantizeStep</a> </td>
cannam@0 354 </tr>
cannam@0 355 </table>
cannam@0 356 </div>
cannam@0 357 <div class="memdoc">
cannam@0 358
cannam@0 359 <p>
cannam@0 360 Quantization resolution of the output values (e.g.
cannam@0 361 <p>
cannam@0 362 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero.
cannam@0 363 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00277">277</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 364
cannam@0 365 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
cannam@0 366
cannam@0 367 </div>
cannam@0 368 </div><p>
cannam@0 369 <a class="anchor" name="0d1194980d44e31b25ef3b4b070d6b5d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="0d1194980d44e31b25ef3b4b070d6b5d" args="" -->
cannam@0 370 <div class="memitem">
cannam@0 371 <div class="memproto">
cannam@0 372 <table class="memname">
cannam@0 373 <tr>
cannam@0 374 <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d">Vamp::Plugin::OutputDescriptor::sampleType</a> </td>
cannam@0 375 </tr>
cannam@0 376 </table>
cannam@0 377 </div>
cannam@0 378 <div class="memdoc">
cannam@0 379
cannam@0 380 <p>
cannam@0 381 Positioning in time of the output results.
cannam@0 382 <p>
cannam@0 383
cannam@0 384 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00294">294</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 385
cannam@0 386 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00112">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 387
cannam@0 388 </div>
cannam@0 389 </div><p>
cannam@0 390 <a class="anchor" name="dd0cbbdfa9c91764037c39365b1d42af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="dd0cbbdfa9c91764037c39365b1d42af" args="" -->
cannam@0 391 <div class="memitem">
cannam@0 392 <div class="memproto">
cannam@0 393 <table class="memname">
cannam@0 394 <tr>
cannam@0 395 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af">Vamp::Plugin::OutputDescriptor::sampleRate</a> </td>
cannam@0 396 </tr>
cannam@0 397 </table>
cannam@0 398 </div>
cannam@0 399 <div class="memdoc">
cannam@0 400
cannam@0 401 <p>
cannam@0 402 Sample rate of the output results, as samples per second.
cannam@0 403 <p>
cannam@0 404 Undefined if sampleType is OneSamplePerStep.<p>
cannam@0 405 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.
cannam@0 406 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00306">306</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 407
cannam@0 408 <p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00637">Vamp::PluginAdapterBase::Impl::getOutputDescriptor()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00110">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00303">Vamp::PluginHostAdapter::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
cannam@0 409
cannam@0 410 </div>
cannam@0 411 </div><p>
cannam@0 412 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@0 413 <li><a class="el" href="Plugin_8h-source.html">Plugin.h</a></ul>
cannam@0 414 </div>
cannam@0 415 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp;
cannam@0 416 <a href="http://www.doxygen.org/index.html">
cannam@0 417 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 418 </body>
cannam@0 419 </html>