cannam@50
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
cannam@50
|
2 <html xmlns="http://www.w3.org/1999/xhtml">
|
cannam@50
|
3 <head>
|
cannam@50
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
cannam@50
|
5 <title>VampPluginSDK: Vamp::Plugin::OutputDescriptor Struct Reference</title>
|
cannam@50
|
6
|
cannam@50
|
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
cannam@50
|
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
cannam@50
|
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
cannam@50
|
10 <script type="text/javascript" src="jquery.js"></script>
|
cannam@50
|
11 <script type="text/javascript" src="resize.js"></script>
|
cannam@50
|
12 <script type="text/javascript" src="navtree.js"></script>
|
cannam@50
|
13 <script type="text/javascript">
|
cannam@50
|
14 $(document).ready(initResizable);
|
cannam@50
|
15 </script>
|
cannam@50
|
16
|
cannam@50
|
17
|
cannam@50
|
18 </head>
|
cannam@50
|
19 <body>
|
cannam@50
|
20 <div id="top"><!-- do not remove this div! -->
|
cannam@50
|
21
|
cannam@50
|
22
|
cannam@50
|
23 <div id="titlearea">
|
cannam@50
|
24 <table cellspacing="0" cellpadding="0">
|
cannam@50
|
25 <tbody>
|
cannam@50
|
26 <tr style="height: 56px;">
|
cannam@50
|
27
|
cannam@50
|
28
|
cannam@50
|
29 <td style="padding-left: 0.5em;">
|
cannam@50
|
30 <div id="projectname">VampPluginSDK
|
cannam@50
|
31  <span id="projectnumber">2.1</span>
|
cannam@50
|
32 </div>
|
cannam@50
|
33
|
cannam@50
|
34 </td>
|
cannam@50
|
35
|
cannam@50
|
36
|
cannam@50
|
37
|
cannam@50
|
38 </tr>
|
cannam@50
|
39 </tbody>
|
cannam@50
|
40 </table>
|
cannam@50
|
41 </div>
|
cannam@50
|
42
|
cannam@50
|
43 <!-- Generated by Doxygen 1.7.5.1 -->
|
cannam@50
|
44 <div id="navrow1" class="tabs">
|
cannam@50
|
45 <ul class="tablist">
|
cannam@50
|
46 <li><a href="index.html"><span>Main Page</span></a></li>
|
cannam@0
|
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
cannam@0
|
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
cannam@0
|
49 <li><a href="files.html"><span>Files</span></a></li>
|
cannam@0
|
50 <li><a href="dirs.html"><span>Directories</span></a></li>
|
cannam@0
|
51 </ul>
|
cannam@0
|
52 </div>
|
cannam@50
|
53 <div id="navrow2" class="tabs2">
|
cannam@50
|
54 <ul class="tablist">
|
cannam@50
|
55 <li><a href="annotated.html"><span>Class List</span></a></li>
|
cannam@50
|
56 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
cannam@50
|
57 <li><a href="functions.html"><span>Class Members</span></a></li>
|
cannam@0
|
58 </ul>
|
cannam@0
|
59 </div>
|
cannam@50
|
60 </div>
|
cannam@50
|
61 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
cannam@50
|
62 <div id="nav-tree">
|
cannam@50
|
63 <div id="nav-tree-contents">
|
cannam@50
|
64 </div>
|
cannam@50
|
65 </div>
|
cannam@50
|
66 <div id="splitbar" style="-moz-user-select:none;"
|
cannam@50
|
67 class="ui-resizable-handle">
|
cannam@0
|
68 </div>
|
cannam@0
|
69 </div>
|
cannam@50
|
70 <script type="text/javascript">
|
cannam@50
|
71 initNavTree('structVamp_1_1Plugin_1_1OutputDescriptor.html','');
|
cannam@50
|
72 </script>
|
cannam@50
|
73 <div id="doc-content">
|
cannam@50
|
74 <div class="header">
|
cannam@50
|
75 <div class="summary">
|
cannam@50
|
76 <a href="#pub-types">Public Types</a> |
|
cannam@50
|
77 <a href="#pub-methods">Public Member Functions</a> |
|
cannam@50
|
78 <a href="#pub-attribs">Public Attributes</a> </div>
|
cannam@50
|
79 <div class="headertitle">
|
cannam@50
|
80 <div class="title">Vamp::Plugin::OutputDescriptor Struct Reference</div> </div>
|
cannam@50
|
81 </div>
|
cannam@0
|
82 <div class="contents">
|
cannam@50
|
83 <!-- doxytag: class="Vamp::Plugin::OutputDescriptor" -->
|
cannam@50
|
84 <p><code>#include <<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>></code></p>
|
cannam@0
|
85
|
cannam@50
|
86 <p><a href="structVamp_1_1Plugin_1_1OutputDescriptor-members.html">List of all members.</a></p>
|
cannam@50
|
87 <table class="memberdecls">
|
cannam@50
|
88 <tr><td colspan="2"><h2><a name="pub-types"></a>
|
cannam@50
|
89 Public Types</h2></td></tr>
|
cannam@50
|
90 <tr><td class="memItemLeft" align="right" valign="top">enum  </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>,
|
cannam@50
|
91 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>,
|
cannam@50
|
92 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">VariableSampleRate</a>
|
cannam@0
|
93 }</td></tr>
|
cannam@50
|
94 <tr><td colspan="2"><h2><a name="pub-methods"></a>
|
cannam@50
|
95 Public Member Functions</h2></td></tr>
|
cannam@50
|
96 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">OutputDescriptor</a> ()</td></tr>
|
cannam@50
|
97 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
|
cannam@50
|
98 Public Attributes</h2></td></tr>
|
cannam@50
|
99 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">identifier</a></td></tr>
|
cannam@50
|
100 <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#ae2c893ddb1860589517ab7eaa989a18b"></a><br/></td></tr>
|
cannam@50
|
101 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">name</a></td></tr>
|
cannam@50
|
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">The human-readable name of the output. <a href="#ab824b2b34ee50f897a30901c620e8d87"></a><br/></td></tr>
|
cannam@50
|
103 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">description</a></td></tr>
|
cannam@50
|
104 <tr><td class="mdescLeft"> </td><td class="mdescRight">A human-readable short text describing the output. <a href="#af9b4fe8f78e7126ead820ba5dc55efd1"></a><br/></td></tr>
|
cannam@50
|
105 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">unit</a></td></tr>
|
cannam@50
|
106 <tr><td class="mdescLeft"> </td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#aa057a8833fa037f06ac9f7b85b85d5e4"></a><br/></td></tr>
|
cannam@50
|
107 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">hasFixedBinCount</a></td></tr>
|
cannam@50
|
108 <tr><td class="mdescLeft"> </td><td class="mdescRight">True if the output has the same number of values per sample for every output sample. <a href="#af0e577e1a256ff6eed6ea42133fec77d"></a><br/></td></tr>
|
cannam@50
|
109 <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">binCount</a></td></tr>
|
cannam@50
|
110 <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of values per result of the output. <a href="#afdd006959a995e40ef7d565a3a4df6dc"></a><br/></td></tr>
|
cannam@50
|
111 <tr><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">binNames</a></td></tr>
|
cannam@50
|
112 <tr><td class="mdescLeft"> </td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate. <a href="#a31d9b79e2d8241344f551a22fcb5c8c7"></a><br/></td></tr>
|
cannam@50
|
113 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">hasKnownExtents</a></td></tr>
|
cannam@50
|
114 <tr><td class="mdescLeft"> </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"></a><br/></td></tr>
|
cannam@50
|
115 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">minValue</a></td></tr>
|
cannam@50
|
116 <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value of the results in the output. <a href="#ac9f5924c0be7571bba8e7ae7e7a921f4"></a><br/></td></tr>
|
cannam@50
|
117 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">maxValue</a></td></tr>
|
cannam@50
|
118 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of the results in the output. <a href="#a907b4e8fbb48a46ac5a05f880d72719f"></a><br/></td></tr>
|
cannam@50
|
119 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">isQuantized</a></td></tr>
|
cannam@50
|
120 <tr><td class="mdescLeft"> </td><td class="mdescRight">True if the output values are quantized to a particular resolution. <a href="#a1b4858928d23bfd7d5bc557c82a83fb4"></a><br/></td></tr>
|
cannam@50
|
121 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">quantizeStep</a></td></tr>
|
cannam@50
|
122 <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#a3bed37153067b625b95acb40b60dbf0b"></a><br/></td></tr>
|
cannam@50
|
123 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a></td></tr>
|
cannam@50
|
124 <tr><td class="mdescLeft"> </td><td class="mdescRight">Positioning in time of the output results. <a href="#a0d1194980d44e31b25ef3b4b070d6b5d"></a><br/></td></tr>
|
cannam@50
|
125 <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">sampleRate</a></td></tr>
|
cannam@50
|
126 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#add0cbbdfa9c91764037c39365b1d42af"></a><br/></td></tr>
|
cannam@50
|
127 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">hasDuration</a></td></tr>
|
cannam@50
|
128 <tr><td class="mdescLeft"> </td><td class="mdescRight">True if the returned results for this output are known to have a duration field. <a href="#ab0d7cc6ab19e53b5bd12ee234f549ea3"></a><br/></td></tr>
|
cannam@0
|
129 </table>
|
cannam@50
|
130 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
cannam@50
|
131 <div class="textblock">
|
cannam@50
|
132 <p>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>
|
cannam@50
|
133 </div><hr/><h2>Member Enumeration Documentation</h2>
|
cannam@50
|
134 <a class="anchor" id="abffa9ed50cd756df70fd51f0355f448c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::SampleType" ref="abffa9ed50cd756df70fd51f0355f448c" args="" -->
|
cannam@0
|
135 <div class="memitem">
|
cannam@0
|
136 <div class="memproto">
|
cannam@0
|
137 <table class="memname">
|
cannam@0
|
138 <tr>
|
cannam@50
|
139 <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a></td>
|
cannam@0
|
140 </tr>
|
cannam@0
|
141 </table>
|
cannam@0
|
142 </div>
|
cannam@0
|
143 <div class="memdoc">
|
cannam@50
|
144 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
|
cannam@50
|
145 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca"></a><!-- doxytag: member="OneSamplePerStep" ref="abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca" args="" -->OneSamplePerStep</em> </td><td>
|
cannam@50
|
146 <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>
|
cannam@50
|
147 </td></tr>
|
cannam@50
|
148 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629"></a><!-- doxytag: member="FixedSampleRate" ref="abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629" args="" -->FixedSampleRate</em> </td><td>
|
cannam@50
|
149 <p>Results are evenly spaced in time (sampleRate specified below) </p>
|
cannam@50
|
150 </td></tr>
|
cannam@50
|
151 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e"></a><!-- doxytag: member="VariableSampleRate" ref="abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e" args="" -->VariableSampleRate</em> </td><td>
|
cannam@50
|
152 <p>Results are unevenly spaced and have individual timestamps. </p>
|
cannam@50
|
153 </td></tr>
|
cannam@0
|
154 </table>
|
cannam@50
|
155 </dd>
|
cannam@0
|
156 </dl>
|
cannam@0
|
157
|
cannam@50
|
158 <p>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>
|
cannam@21
|
159
|
cannam@21
|
160 </div>
|
cannam@50
|
161 </div>
|
cannam@50
|
162 <hr/><h2>Constructor & Destructor Documentation</h2>
|
cannam@50
|
163 <a class="anchor" id="a1ebf91cc3f60e4cbba818c10591cd344"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::OutputDescriptor" ref="a1ebf91cc3f60e4cbba818c10591cd344" args="()" -->
|
cannam@21
|
164 <div class="memitem">
|
cannam@21
|
165 <div class="memproto">
|
cannam@21
|
166 <table class="memname">
|
cannam@21
|
167 <tr>
|
cannam@50
|
168 <td class="memname">Vamp::Plugin::OutputDescriptor::OutputDescriptor </td>
|
cannam@21
|
169 <td>(</td>
|
cannam@50
|
170 <td class="paramname"></td><td>)</td>
|
cannam@21
|
171 <td><code> [inline]</code></td>
|
cannam@21
|
172 </tr>
|
cannam@21
|
173 </table>
|
cannam@21
|
174 </div>
|
cannam@21
|
175 <div class="memdoc">
|
cannam@21
|
176
|
cannam@50
|
177 <p>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>
|
cannam@0
|
178
|
cannam@0
|
179 </div>
|
cannam@50
|
180 </div>
|
cannam@50
|
181 <hr/><h2>Member Data Documentation</h2>
|
cannam@50
|
182 <a class="anchor" id="ae2c893ddb1860589517ab7eaa989a18b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="ae2c893ddb1860589517ab7eaa989a18b" args="" -->
|
cannam@0
|
183 <div class="memitem">
|
cannam@0
|
184 <div class="memproto">
|
cannam@0
|
185 <table class="memname">
|
cannam@0
|
186 <tr>
|
cannam@50
|
187 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">Vamp::Plugin::OutputDescriptor::identifier</a></td>
|
cannam@0
|
188 </tr>
|
cannam@0
|
189 </table>
|
cannam@0
|
190 </div>
|
cannam@0
|
191 <div class="memdoc">
|
cannam@0
|
192
|
cannam@50
|
193 <p>The name of the output, in computer-usable form. </p>
|
cannam@50
|
194 <p>Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" </p>
|
cannam@0
|
195
|
cannam@50
|
196 <p>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>
|
cannam@50
|
197
|
cannam@50
|
198 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
199
|
cannam@0
|
200 </div>
|
cannam@50
|
201 </div>
|
cannam@50
|
202 <a class="anchor" id="ab824b2b34ee50f897a30901c620e8d87"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="ab824b2b34ee50f897a30901c620e8d87" args="" -->
|
cannam@0
|
203 <div class="memitem">
|
cannam@0
|
204 <div class="memproto">
|
cannam@0
|
205 <table class="memname">
|
cannam@0
|
206 <tr>
|
cannam@50
|
207 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">Vamp::Plugin::OutputDescriptor::name</a></td>
|
cannam@0
|
208 </tr>
|
cannam@0
|
209 </table>
|
cannam@0
|
210 </div>
|
cannam@0
|
211 <div class="memdoc">
|
cannam@0
|
212
|
cannam@50
|
213 <p>The human-readable name of the output. </p>
|
cannam@50
|
214 <p>Example: "Zero Crossing Counts" </p>
|
cannam@0
|
215
|
cannam@50
|
216 <p>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>
|
cannam@50
|
217
|
cannam@50
|
218 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
219
|
cannam@0
|
220 </div>
|
cannam@50
|
221 </div>
|
cannam@50
|
222 <a class="anchor" id="af9b4fe8f78e7126ead820ba5dc55efd1"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="af9b4fe8f78e7126ead820ba5dc55efd1" args="" -->
|
cannam@0
|
223 <div class="memitem">
|
cannam@0
|
224 <div class="memproto">
|
cannam@0
|
225 <table class="memname">
|
cannam@0
|
226 <tr>
|
cannam@50
|
227 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">Vamp::Plugin::OutputDescriptor::description</a></td>
|
cannam@0
|
228 </tr>
|
cannam@0
|
229 </table>
|
cannam@0
|
230 </div>
|
cannam@0
|
231 <div class="memdoc">
|
cannam@0
|
232
|
cannam@50
|
233 <p>A human-readable short text describing the output. </p>
|
cannam@50
|
234 <p>May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" </p>
|
cannam@0
|
235
|
cannam@50
|
236 <p>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>
|
cannam@50
|
237
|
cannam@50
|
238 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
239
|
cannam@0
|
240 </div>
|
cannam@50
|
241 </div>
|
cannam@50
|
242 <a class="anchor" id="aa057a8833fa037f06ac9f7b85b85d5e4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="aa057a8833fa037f06ac9f7b85b85d5e4" args="" -->
|
cannam@0
|
243 <div class="memitem">
|
cannam@0
|
244 <div class="memproto">
|
cannam@0
|
245 <table class="memname">
|
cannam@0
|
246 <tr>
|
cannam@50
|
247 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">Vamp::Plugin::OutputDescriptor::unit</a></td>
|
cannam@0
|
248 </tr>
|
cannam@0
|
249 </table>
|
cannam@0
|
250 </div>
|
cannam@0
|
251 <div class="memdoc">
|
cannam@0
|
252
|
cannam@50
|
253 <p>The unit of the output, in human-readable form. </p>
|
cannam@0
|
254
|
cannam@50
|
255 <p>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>
|
cannam@0
|
256
|
cannam@50
|
257 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
258
|
cannam@0
|
259 </div>
|
cannam@50
|
260 </div>
|
cannam@50
|
261 <a class="anchor" id="af0e577e1a256ff6eed6ea42133fec77d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="af0e577e1a256ff6eed6ea42133fec77d" args="" -->
|
cannam@0
|
262 <div class="memitem">
|
cannam@0
|
263 <div class="memproto">
|
cannam@0
|
264 <table class="memname">
|
cannam@0
|
265 <tr>
|
cannam@50
|
266 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a></td>
|
cannam@0
|
267 </tr>
|
cannam@0
|
268 </table>
|
cannam@0
|
269 </div>
|
cannam@0
|
270 <div class="memdoc">
|
cannam@0
|
271
|
cannam@50
|
272 <p>True if the output has the same number of values per sample for every output sample. </p>
|
cannam@50
|
273 <p>Outputs for which this is false are unlikely to be very useful in a general-purpose host. </p>
|
cannam@0
|
274
|
cannam@50
|
275 <p>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>
|
cannam@50
|
276
|
cannam@50
|
277 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
278
|
cannam@0
|
279 </div>
|
cannam@50
|
280 </div>
|
cannam@50
|
281 <a class="anchor" id="afdd006959a995e40ef7d565a3a4df6dc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="afdd006959a995e40ef7d565a3a4df6dc" args="" -->
|
cannam@0
|
282 <div class="memitem">
|
cannam@0
|
283 <div class="memproto">
|
cannam@0
|
284 <table class="memname">
|
cannam@0
|
285 <tr>
|
cannam@50
|
286 <td class="memname">size_t <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">Vamp::Plugin::OutputDescriptor::binCount</a></td>
|
cannam@0
|
287 </tr>
|
cannam@0
|
288 </table>
|
cannam@0
|
289 </div>
|
cannam@0
|
290 <div class="memdoc">
|
cannam@0
|
291
|
cannam@50
|
292 <p>The number of values per result of the output. </p>
|
cannam@50
|
293 <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>
|
cannam@0
|
294
|
cannam@50
|
295 <p>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>
|
cannam@50
|
296
|
cannam@50
|
297 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
298
|
cannam@0
|
299 </div>
|
cannam@50
|
300 </div>
|
cannam@50
|
301 <a class="anchor" id="a31d9b79e2d8241344f551a22fcb5c8c7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="a31d9b79e2d8241344f551a22fcb5c8c7" args="" -->
|
cannam@0
|
302 <div class="memitem">
|
cannam@0
|
303 <div class="memproto">
|
cannam@0
|
304 <table class="memname">
|
cannam@0
|
305 <tr>
|
cannam@50
|
306 <td class="memname">std::vector<std::string> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">Vamp::Plugin::OutputDescriptor::binNames</a></td>
|
cannam@0
|
307 </tr>
|
cannam@0
|
308 </table>
|
cannam@0
|
309 </div>
|
cannam@0
|
310 <div class="memdoc">
|
cannam@0
|
311
|
cannam@50
|
312 <p>The (human-readable) names of each of the bins, if appropriate. </p>
|
cannam@50
|
313 <p>This is always optional. </p>
|
cannam@50
|
314
|
cannam@50
|
315 <p>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>
|
cannam@0
|
316
|
cannam@0
|
317 </div>
|
cannam@50
|
318 </div>
|
cannam@50
|
319 <a class="anchor" id="ae9ccb65f99f477096b65dd031f4c5e31"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="ae9ccb65f99f477096b65dd031f4c5e31" args="" -->
|
cannam@0
|
320 <div class="memitem">
|
cannam@0
|
321 <div class="memproto">
|
cannam@0
|
322 <table class="memname">
|
cannam@0
|
323 <tr>
|
cannam@50
|
324 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a></td>
|
cannam@0
|
325 </tr>
|
cannam@0
|
326 </table>
|
cannam@0
|
327 </div>
|
cannam@0
|
328 <div class="memdoc">
|
cannam@0
|
329
|
cannam@50
|
330 <p>True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). </p>
|
cannam@50
|
331 <p>Undefined if binCount is zero. </p>
|
cannam@0
|
332
|
cannam@50
|
333 <p>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>
|
cannam@50
|
334
|
cannam@50
|
335 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
336
|
cannam@0
|
337 </div>
|
cannam@50
|
338 </div>
|
cannam@50
|
339 <a class="anchor" id="ac9f5924c0be7571bba8e7ae7e7a921f4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="ac9f5924c0be7571bba8e7ae7e7a921f4" args="" -->
|
cannam@0
|
340 <div class="memitem">
|
cannam@0
|
341 <div class="memproto">
|
cannam@0
|
342 <table class="memname">
|
cannam@0
|
343 <tr>
|
cannam@50
|
344 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">Vamp::Plugin::OutputDescriptor::minValue</a></td>
|
cannam@0
|
345 </tr>
|
cannam@0
|
346 </table>
|
cannam@0
|
347 </div>
|
cannam@0
|
348 <div class="memdoc">
|
cannam@0
|
349
|
cannam@50
|
350 <p>Minimum value of the results in the output. </p>
|
cannam@50
|
351 <p>Undefined if hasKnownExtents is false or binCount is zero. </p>
|
cannam@0
|
352
|
cannam@50
|
353 <p>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>
|
cannam@50
|
354
|
cannam@50
|
355 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
|
cannam@0
|
356
|
cannam@0
|
357 </div>
|
cannam@50
|
358 </div>
|
cannam@50
|
359 <a class="anchor" id="a907b4e8fbb48a46ac5a05f880d72719f"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="a907b4e8fbb48a46ac5a05f880d72719f" args="" -->
|
cannam@0
|
360 <div class="memitem">
|
cannam@0
|
361 <div class="memproto">
|
cannam@0
|
362 <table class="memname">
|
cannam@0
|
363 <tr>
|
cannam@50
|
364 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">Vamp::Plugin::OutputDescriptor::maxValue</a></td>
|
cannam@0
|
365 </tr>
|
cannam@0
|
366 </table>
|
cannam@0
|
367 </div>
|
cannam@0
|
368 <div class="memdoc">
|
cannam@0
|
369
|
cannam@50
|
370 <p>Maximum value of the results in the output. </p>
|
cannam@50
|
371 <p>Undefined if hasKnownExtents is false or binCount is zero. </p>
|
cannam@0
|
372
|
cannam@50
|
373 <p>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>
|
cannam@50
|
374
|
cannam@50
|
375 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
|
cannam@0
|
376
|
cannam@0
|
377 </div>
|
cannam@50
|
378 </div>
|
cannam@50
|
379 <a class="anchor" id="a1b4858928d23bfd7d5bc557c82a83fb4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="a1b4858928d23bfd7d5bc557c82a83fb4" args="" -->
|
cannam@0
|
380 <div class="memitem">
|
cannam@0
|
381 <div class="memproto">
|
cannam@0
|
382 <table class="memname">
|
cannam@0
|
383 <tr>
|
cannam@50
|
384 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">Vamp::Plugin::OutputDescriptor::isQuantized</a></td>
|
cannam@0
|
385 </tr>
|
cannam@0
|
386 </table>
|
cannam@0
|
387 </div>
|
cannam@0
|
388 <div class="memdoc">
|
cannam@0
|
389
|
cannam@50
|
390 <p>True if the output values are quantized to a particular resolution. </p>
|
cannam@50
|
391 <p>Undefined if binCount is zero. </p>
|
cannam@0
|
392
|
cannam@50
|
393 <p>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>
|
cannam@50
|
394
|
cannam@50
|
395 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
396
|
cannam@0
|
397 </div>
|
cannam@50
|
398 </div>
|
cannam@50
|
399 <a class="anchor" id="a3bed37153067b625b95acb40b60dbf0b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="a3bed37153067b625b95acb40b60dbf0b" args="" -->
|
cannam@0
|
400 <div class="memitem">
|
cannam@0
|
401 <div class="memproto">
|
cannam@0
|
402 <table class="memname">
|
cannam@0
|
403 <tr>
|
cannam@50
|
404 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">Vamp::Plugin::OutputDescriptor::quantizeStep</a></td>
|
cannam@0
|
405 </tr>
|
cannam@0
|
406 </table>
|
cannam@0
|
407 </div>
|
cannam@0
|
408 <div class="memdoc">
|
cannam@0
|
409
|
cannam@50
|
410 <p>Quantization resolution of the output values (e.g. </p>
|
cannam@50
|
411 <p>1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. </p>
|
cannam@0
|
412
|
cannam@50
|
413 <p>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>
|
cannam@50
|
414
|
cannam@50
|
415 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
|
cannam@0
|
416
|
cannam@0
|
417 </div>
|
cannam@50
|
418 </div>
|
cannam@50
|
419 <a class="anchor" id="a0d1194980d44e31b25ef3b4b070d6b5d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="a0d1194980d44e31b25ef3b4b070d6b5d" args="" -->
|
cannam@0
|
420 <div class="memitem">
|
cannam@0
|
421 <div class="memproto">
|
cannam@0
|
422 <table class="memname">
|
cannam@0
|
423 <tr>
|
cannam@50
|
424 <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">Vamp::Plugin::OutputDescriptor::sampleType</a></td>
|
cannam@0
|
425 </tr>
|
cannam@0
|
426 </table>
|
cannam@0
|
427 </div>
|
cannam@0
|
428 <div class="memdoc">
|
cannam@0
|
429
|
cannam@50
|
430 <p>Positioning in time of the output results. </p>
|
cannam@0
|
431
|
cannam@50
|
432 <p>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>
|
cannam@0
|
433
|
cannam@50
|
434 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">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>
|
cannam@0
|
435
|
cannam@0
|
436 </div>
|
cannam@50
|
437 </div>
|
cannam@50
|
438 <a class="anchor" id="add0cbbdfa9c91764037c39365b1d42af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="add0cbbdfa9c91764037c39365b1d42af" args="" -->
|
cannam@0
|
439 <div class="memitem">
|
cannam@0
|
440 <div class="memproto">
|
cannam@0
|
441 <table class="memname">
|
cannam@0
|
442 <tr>
|
cannam@50
|
443 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">Vamp::Plugin::OutputDescriptor::sampleRate</a></td>
|
cannam@0
|
444 </tr>
|
cannam@0
|
445 </table>
|
cannam@0
|
446 </div>
|
cannam@0
|
447 <div class="memdoc">
|
cannam@0
|
448
|
cannam@50
|
449 <p>Sample rate of the output results, as samples per second. </p>
|
cannam@50
|
450 <p>Undefined if sampleType is OneSamplePerStep.</p>
|
cannam@50
|
451 <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>
|
cannam@0
|
452
|
cannam@50
|
453 <p>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>
|
cannam@50
|
454
|
cannam@50
|
455 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
|
cannam@21
|
456
|
cannam@21
|
457 </div>
|
cannam@50
|
458 </div>
|
cannam@50
|
459 <a class="anchor" id="ab0d7cc6ab19e53b5bd12ee234f549ea3"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasDuration" ref="ab0d7cc6ab19e53b5bd12ee234f549ea3" args="" -->
|
cannam@21
|
460 <div class="memitem">
|
cannam@21
|
461 <div class="memproto">
|
cannam@21
|
462 <table class="memname">
|
cannam@21
|
463 <tr>
|
cannam@50
|
464 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">Vamp::Plugin::OutputDescriptor::hasDuration</a></td>
|
cannam@21
|
465 </tr>
|
cannam@21
|
466 </table>
|
cannam@21
|
467 </div>
|
cannam@21
|
468 <div class="memdoc">
|
cannam@21
|
469
|
cannam@50
|
470 <p>True if the returned results for this output are known to have a duration field. </p>
|
cannam@21
|
471
|
cannam@50
|
472 <p>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>
|
cannam@21
|
473
|
cannam@50
|
474 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
|
cannam@0
|
475
|
cannam@0
|
476 </div>
|
cannam@0
|
477 </div>
|
cannam@50
|
478 <hr/>The documentation for this struct was generated from the following file:<ul>
|
cannam@50
|
479 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li>
|
cannam@50
|
480 </ul>
|
cannam@50
|
481 </div>
|
cannam@50
|
482 </div>
|
cannam@50
|
483 <div id="nav-path" class="navpath">
|
cannam@50
|
484 <ul>
|
cannam@50
|
485 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
|
cannam@50
|
486 <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li>
|
cannam@50
|
487 <li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> </li>
|
cannam@50
|
488
|
cannam@50
|
489 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
|
cannam@50
|
490 <a href="http://www.doxygen.org/index.html">
|
cannam@50
|
491 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
|
cannam@50
|
492 </ul>
|
cannam@50
|
493 </div>
|
cannam@50
|
494
|
cannam@50
|
495
|
cannam@0
|
496 </body>
|
cannam@0
|
497 </html>
|