Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 7:66d125fb8b42 tip

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