Mercurial > hg > vamp-website

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