comparison code-doc/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 50:8260c0f4e05b website

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