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