Mercurial > hg > vamp-docs

annotate code-docs/struct__VampPluginDescriptor.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: _VampPluginDescriptor 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('struct__VampPluginDescriptor.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@6 63 <a href="#pub-attribs">Public Attributes</a> &#124;
Chris@6 64 <a href="struct__VampPluginDescriptor-members.html">List of all members</a> </div>
Chris@1 65 <div class="headertitle">
Chris@1 66 <div class="title">_VampPluginDescriptor Struct Reference</div> </div>
Chris@3 67 </div><!--header-->
Chris@1 68 <div class="contents">
Chris@3 69
Chris@1 70 <p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>
Chris@1 71 <table class="memberdecls">
Chris@6 72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Chris@1 73 Public Attributes</h2></td></tr>
Chris@3 74 <tr class="memitem:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ab6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr>
Chris@6 75 <tr class="memdesc:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">API version with which this descriptor is compatible. <a href="#ab6c87760e87ddaa9ac3491bccaaa28c2">More...</a><br /></td></tr>
Chris@6 76 <tr class="separator:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 77 <tr class="memitem:a4915ec8276749cb505c01d25a6d02219"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4915ec8276749cb505c01d25a6d02219">identifier</a></td></tr>
Chris@6 78 <tr class="memdesc:a4915ec8276749cb505c01d25a6d02219"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the plugin. <a href="#a4915ec8276749cb505c01d25a6d02219">More...</a><br /></td></tr>
Chris@6 79 <tr class="separator:a4915ec8276749cb505c01d25a6d02219"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 80 <tr class="memitem:a9dd5a0190e4d453ff36b5acb7000b150"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9dd5a0190e4d453ff36b5acb7000b150">name</a></td></tr>
Chris@6 81 <tr class="memdesc:a9dd5a0190e4d453ff36b5acb7000b150"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the plugin. <a href="#a9dd5a0190e4d453ff36b5acb7000b150">More...</a><br /></td></tr>
Chris@6 82 <tr class="separator:a9dd5a0190e4d453ff36b5acb7000b150"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 83 <tr class="memitem:a9ff8050f92f1a04a68bb34a9d368295e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9ff8050f92f1a04a68bb34a9d368295e">description</a></td></tr>
Chris@6 84 <tr class="memdesc:a9ff8050f92f1a04a68bb34a9d368295e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the plugin. <a href="#a9ff8050f92f1a04a68bb34a9d368295e">More...</a><br /></td></tr>
Chris@6 85 <tr class="separator:a9ff8050f92f1a04a68bb34a9d368295e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 86 <tr class="memitem:a4dca3d57331802964716edfa80580c9b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4dca3d57331802964716edfa80580c9b">maker</a></td></tr>
Chris@6 87 <tr class="memdesc:a4dca3d57331802964716edfa80580c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of plugin's author or vendor. <a href="#a4dca3d57331802964716edfa80580c9b">More...</a><br /></td></tr>
Chris@6 88 <tr class="separator:a4dca3d57331802964716edfa80580c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 89 <tr class="memitem:a04427c420d9252c7796c0bf5101345ae"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a04427c420d9252c7796c0bf5101345ae">pluginVersion</a></td></tr>
Chris@6 90 <tr class="memdesc:a04427c420d9252c7796c0bf5101345ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Version number of the plugin. <a href="#a04427c420d9252c7796c0bf5101345ae">More...</a><br /></td></tr>
Chris@6 91 <tr class="separator:a04427c420d9252c7796c0bf5101345ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 92 <tr class="memitem:ae704bba384af0de056a26da1b13ee521"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae704bba384af0de056a26da1b13ee521">copyright</a></td></tr>
Chris@6 93 <tr class="memdesc:ae704bba384af0de056a26da1b13ee521"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable summary of copyright or licensing for plugin. <a href="#ae704bba384af0de056a26da1b13ee521">More...</a><br /></td></tr>
Chris@6 94 <tr class="separator:ae704bba384af0de056a26da1b13ee521"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 95 <tr class="memitem:ae6271dc3ea0cea959c84a64185492cab"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae6271dc3ea0cea959c84a64185492cab">parameterCount</a></td></tr>
Chris@6 96 <tr class="memdesc:ae6271dc3ea0cea959c84a64185492cab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of parameter inputs. <a href="#ae6271dc3ea0cea959c84a64185492cab">More...</a><br /></td></tr>
Chris@6 97 <tr class="separator:ae6271dc3ea0cea959c84a64185492cab"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 98 <tr class="memitem:a64d614862604c31d6b84c49005f51913"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a64d614862604c31d6b84c49005f51913">parameters</a></td></tr>
Chris@6 99 <tr class="memdesc:a64d614862604c31d6b84c49005f51913"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed descriptors for parameter inputs. <a href="#a64d614862604c31d6b84c49005f51913">More...</a><br /></td></tr>
Chris@6 100 <tr class="separator:a64d614862604c31d6b84c49005f51913"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 101 <tr class="memitem:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a1962666aa173e7a9a2c30dc82e4b2e00">programCount</a></td></tr>
Chris@6 102 <tr class="memdesc:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of programs. <a href="#a1962666aa173e7a9a2c30dc82e4b2e00">More...</a><br /></td></tr>
Chris@6 103 <tr class="separator:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 104 <tr class="memitem:ad488470c582d8472d86455889d71c5ec"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad488470c582d8472d86455889d71c5ec">programs</a></td></tr>
Chris@6 105 <tr class="memdesc:ad488470c582d8472d86455889d71c5ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fixed names for programs. <a href="#ad488470c582d8472d86455889d71c5ec">More...</a><br /></td></tr>
Chris@6 106 <tr class="separator:ad488470c582d8472d86455889d71c5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 107 <tr class="memitem:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#affc4d1796da7ced2c0cbb2cc2c4a22f4">inputDomain</a></td></tr>
Chris@6 108 <tr class="memdesc:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preferred input domain for audio input (time or frequency). <a href="#affc4d1796da7ced2c0cbb2cc2c4a22f4">More...</a><br /></td></tr>
Chris@6 109 <tr class="separator:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 110 <tr class="memitem:aa5fa3dfd0b85668a658096de5271c305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aa5fa3dfd0b85668a658096de5271c305">instantiate</a> )(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td></tr>
Chris@6 111 <tr class="memdesc:aa5fa3dfd0b85668a658096de5271c305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and return a new instance of this plugin. <a href="#aa5fa3dfd0b85668a658096de5271c305">More...</a><br /></td></tr>
Chris@6 112 <tr class="separator:aa5fa3dfd0b85668a658096de5271c305"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 113 <tr class="memitem:a70974d8d28534c006af87c4470d12b69"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a70974d8d28534c006af87c4470d12b69">cleanup</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 114 <tr class="memdesc:a70974d8d28534c006af87c4470d12b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an instance of this plugin. <a href="#a70974d8d28534c006af87c4470d12b69">More...</a><br /></td></tr>
Chris@6 115 <tr class="separator:a70974d8d28534c006af87c4470d12b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 116 <tr class="memitem:a7c26381e66fc2b1fccbe9a0e5a0ff2be"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a7c26381e66fc2b1fccbe9a0e5a0ff2be">initialise</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td></tr>
Chris@6 117 <tr class="memdesc:a7c26381e66fc2b1fccbe9a0e5a0ff2be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise an instance following parameter configuration. <a href="#a7c26381e66fc2b1fccbe9a0e5a0ff2be">More...</a><br /></td></tr>
Chris@6 118 <tr class="separator:a7c26381e66fc2b1fccbe9a0e5a0ff2be"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 119 <tr class="memitem:a0bb0a037c2cb6baf3abac6b03d4a0009"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a0bb0a037c2cb6baf3abac6b03d4a0009">reset</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 120 <tr class="memdesc:a0bb0a037c2cb6baf3abac6b03d4a0009"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset an instance, ready to use again on new input data. <a href="#a0bb0a037c2cb6baf3abac6b03d4a0009">More...</a><br /></td></tr>
Chris@6 121 <tr class="separator:a0bb0a037c2cb6baf3abac6b03d4a0009"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 122 <tr class="memitem:a153dc1fa458602a408d8ae909e4b9780"><td class="memItemLeft" align="right" valign="top">float(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a153dc1fa458602a408d8ae909e4b9780">getParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td></tr>
Chris@6 123 <tr class="memdesc:a153dc1fa458602a408d8ae909e4b9780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a parameter value. <a href="#a153dc1fa458602a408d8ae909e4b9780">More...</a><br /></td></tr>
Chris@6 124 <tr class="separator:a153dc1fa458602a408d8ae909e4b9780"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 125 <tr class="memitem:abe2500934c8aae78d0ecd6b4541d8946"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#abe2500934c8aae78d0ecd6b4541d8946">setParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td></tr>
Chris@6 126 <tr class="memdesc:abe2500934c8aae78d0ecd6b4541d8946"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a parameter value. <a href="#abe2500934c8aae78d0ecd6b4541d8946">More...</a><br /></td></tr>
Chris@6 127 <tr class="separator:abe2500934c8aae78d0ecd6b4541d8946"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 128 <tr class="memitem:a2d13712798238db503005808b736cb18"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a2d13712798238db503005808b736cb18">getCurrentProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 129 <tr class="memdesc:a2d13712798238db503005808b736cb18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current program (if programCount &gt; 0). <a href="#a2d13712798238db503005808b736cb18">More...</a><br /></td></tr>
Chris@6 130 <tr class="separator:a2d13712798238db503005808b736cb18"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 131 <tr class="memitem:a688596d8abcdd638250799314ef9cb19"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a688596d8abcdd638250799314ef9cb19">selectProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
Chris@6 132 <tr class="memdesc:a688596d8abcdd638250799314ef9cb19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current program. <a href="#a688596d8abcdd638250799314ef9cb19">More...</a><br /></td></tr>
Chris@6 133 <tr class="separator:a688596d8abcdd638250799314ef9cb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 134 <tr class="memitem:ae8efb5dec4a16b74fbb32ef36fc90e09"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae8efb5dec4a16b74fbb32ef36fc90e09">getPreferredStepSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 135 <tr class="memdesc:ae8efb5dec4a16b74fbb32ef36fc90e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's preferred processing window increment in samples. <a href="#ae8efb5dec4a16b74fbb32ef36fc90e09">More...</a><br /></td></tr>
Chris@6 136 <tr class="separator:ae8efb5dec4a16b74fbb32ef36fc90e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 137 <tr class="memitem:a3052e7f14ad1dfc3000b3b91dddf8c61"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a3052e7f14ad1dfc3000b3b91dddf8c61">getPreferredBlockSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 138 <tr class="memdesc:a3052e7f14ad1dfc3000b3b91dddf8c61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the plugin's preferred processing window size in samples. <a href="#a3052e7f14ad1dfc3000b3b91dddf8c61">More...</a><br /></td></tr>
Chris@6 139 <tr class="separator:a3052e7f14ad1dfc3000b3b91dddf8c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 140 <tr class="memitem:a8a9be1cf9e70d46d20cac1b0049149cd"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a8a9be1cf9e70d46d20cac1b0049149cd">getMinChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 141 <tr class="memdesc:a8a9be1cf9e70d46d20cac1b0049149cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the minimum number of input channels this plugin can handle. <a href="#a8a9be1cf9e70d46d20cac1b0049149cd">More...</a><br /></td></tr>
Chris@6 142 <tr class="separator:a8a9be1cf9e70d46d20cac1b0049149cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 143 <tr class="memitem:af34bce679c821c38dbd212a0ef1bf867"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#af34bce679c821c38dbd212a0ef1bf867">getMaxChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 144 <tr class="memdesc:af34bce679c821c38dbd212a0ef1bf867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum number of input channels this plugin can handle. <a href="#af34bce679c821c38dbd212a0ef1bf867">More...</a><br /></td></tr>
Chris@6 145 <tr class="separator:af34bce679c821c38dbd212a0ef1bf867"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 146 <tr class="memitem:a71825defc0052a8ac307e2c333c4b935"><td class="memItemLeft" align="right" valign="top">unsigned int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a71825defc0052a8ac307e2c333c4b935">getOutputCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 147 <tr class="memdesc:a71825defc0052a8ac307e2c333c4b935"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of feature outputs (distinct sets of results). <a href="#a71825defc0052a8ac307e2c333c4b935">More...</a><br /></td></tr>
Chris@6 148 <tr class="separator:a71825defc0052a8ac307e2c333c4b935"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 149 <tr class="memitem:a033116c818aafe70e7fd15d240234754"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a033116c818aafe70e7fd15d240234754">getOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
Chris@6 150 <tr class="memdesc:a033116c818aafe70e7fd15d240234754"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a descriptor for a given feature output. <a href="#a033116c818aafe70e7fd15d240234754">More...</a><br /></td></tr>
Chris@6 151 <tr class="separator:a033116c818aafe70e7fd15d240234754"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 152 <tr class="memitem:a69f9fef2ed20a88985c960de4428cecb"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a69f9fef2ed20a88985c960de4428cecb">releaseOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td></tr>
Chris@6 153 <tr class="memdesc:a69f9fef2ed20a88985c960de4428cecb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a descriptor for a feature output. <a href="#a69f9fef2ed20a88985c960de4428cecb">More...</a><br /></td></tr>
Chris@6 154 <tr class="separator:a69f9fef2ed20a88985c960de4428cecb"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 155 <tr class="memitem:aff1c25291c967cb2f198b900e551a7eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aff1c25291c967cb2f198b900e551a7eb">process</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td></tr>
Chris@6 156 <tr class="memdesc:aff1c25291c967cb2f198b900e551a7eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process an input block and return a set of features. <a href="#aff1c25291c967cb2f198b900e551a7eb">More...</a><br /></td></tr>
Chris@6 157 <tr class="separator:aff1c25291c967cb2f198b900e551a7eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 158 <tr class="memitem:ad897b43458161a43cf6085198217d197"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad897b43458161a43cf6085198217d197">getRemainingFeatures</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
Chris@6 159 <tr class="memdesc:ad897b43458161a43cf6085198217d197"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return any remaining features at the end of processing. <a href="#ad897b43458161a43cf6085198217d197">More...</a><br /></td></tr>
Chris@6 160 <tr class="separator:ad897b43458161a43cf6085198217d197"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 161 <tr class="memitem:ab4ed73ea986582ab1b7e6c44149a982a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ab4ed73ea986582ab1b7e6c44149a982a">releaseFeatureSet</a> )(<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td></tr>
Chris@6 162 <tr class="memdesc:ab4ed73ea986582ab1b7e6c44149a982a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release a feature set returned from process or getRemainingFeatures. <a href="#ab4ed73ea986582ab1b7e6c44149a982a">More...</a><br /></td></tr>
Chris@6 163 <tr class="separator:ab4ed73ea986582ab1b7e6c44149a982a"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 164 </table>
Chris@6 165 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 166 <div class="textblock">
Chris@6 167 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00248">248</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@6 168 </div><h2 class="groupheader">Member Data Documentation</h2>
Chris@6 169 <a id="ab6c87760e87ddaa9ac3491bccaaa28c2"></a>
Chris@6 170 <h2 class="memtitle"><span class="permalink"><a href="#ab6c87760e87ddaa9ac3491bccaaa28c2">&#9670;&nbsp;</a></span>vampApiVersion</h2>
Chris@6 171
Chris@1 172 <div class="memitem">
Chris@1 173 <div class="memproto">
Chris@1 174 <table class="memname">
Chris@1 175 <tr>
Chris@6 176 <td class="memname">unsigned int _VampPluginDescriptor::vampApiVersion</td>
Chris@1 177 </tr>
Chris@1 178 </table>
Chris@6 179 </div><div class="memdoc">
Chris@1 180
Chris@1 181 <p>API version with which this descriptor is compatible. </p>
Chris@1 182
Chris@6 183 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00251">251</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 184
Chris@1 185 </div>
Chris@1 186 </div>
Chris@6 187 <a id="a4915ec8276749cb505c01d25a6d02219"></a>
Chris@6 188 <h2 class="memtitle"><span class="permalink"><a href="#a4915ec8276749cb505c01d25a6d02219">&#9670;&nbsp;</a></span>identifier</h2>
Chris@6 189
Chris@1 190 <div class="memitem">
Chris@1 191 <div class="memproto">
Chris@1 192 <table class="memname">
Chris@1 193 <tr>
Chris@6 194 <td class="memname">const char* _VampPluginDescriptor::identifier</td>
Chris@1 195 </tr>
Chris@1 196 </table>
Chris@6 197 </div><div class="memdoc">
Chris@1 198
Chris@1 199 <p>Computer-usable name of the plugin. </p>
Chris@6 200 <p>Must not change. [a-zA-Z0-9_-] </p>
Chris@1 201
Chris@6 202 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00254">254</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 203
Chris@1 204 </div>
Chris@1 205 </div>
Chris@6 206 <a id="a9dd5a0190e4d453ff36b5acb7000b150"></a>
Chris@6 207 <h2 class="memtitle"><span class="permalink"><a href="#a9dd5a0190e4d453ff36b5acb7000b150">&#9670;&nbsp;</a></span>name</h2>
Chris@6 208
Chris@1 209 <div class="memitem">
Chris@1 210 <div class="memproto">
Chris@1 211 <table class="memname">
Chris@1 212 <tr>
Chris@6 213 <td class="memname">const char* _VampPluginDescriptor::name</td>
Chris@1 214 </tr>
Chris@1 215 </table>
Chris@6 216 </div><div class="memdoc">
Chris@1 217
Chris@1 218 <p>Human-readable name of the plugin. </p>
Chris@1 219 <p>May be translatable. </p>
Chris@1 220
Chris@6 221 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00257">257</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 222
Chris@1 223 </div>
Chris@1 224 </div>
Chris@6 225 <a id="a9ff8050f92f1a04a68bb34a9d368295e"></a>
Chris@6 226 <h2 class="memtitle"><span class="permalink"><a href="#a9ff8050f92f1a04a68bb34a9d368295e">&#9670;&nbsp;</a></span>description</h2>
Chris@6 227
Chris@1 228 <div class="memitem">
Chris@1 229 <div class="memproto">
Chris@1 230 <table class="memname">
Chris@1 231 <tr>
Chris@6 232 <td class="memname">const char* _VampPluginDescriptor::description</td>
Chris@1 233 </tr>
Chris@1 234 </table>
Chris@6 235 </div><div class="memdoc">
Chris@1 236
Chris@1 237 <p>Human-readable short text about the plugin. </p>
Chris@1 238 <p>May be translatable. </p>
Chris@1 239
Chris@6 240 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00260">260</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 241
Chris@1 242 </div>
Chris@1 243 </div>
Chris@6 244 <a id="a4dca3d57331802964716edfa80580c9b"></a>
Chris@6 245 <h2 class="memtitle"><span class="permalink"><a href="#a4dca3d57331802964716edfa80580c9b">&#9670;&nbsp;</a></span>maker</h2>
Chris@6 246
Chris@1 247 <div class="memitem">
Chris@1 248 <div class="memproto">
Chris@1 249 <table class="memname">
Chris@1 250 <tr>
Chris@6 251 <td class="memname">const char* _VampPluginDescriptor::maker</td>
Chris@1 252 </tr>
Chris@1 253 </table>
Chris@6 254 </div><div class="memdoc">
Chris@1 255
Chris@1 256 <p>Human-readable name of plugin's author or vendor. </p>
Chris@1 257
Chris@6 258 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00263">263</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 259
Chris@1 260 </div>
Chris@1 261 </div>
Chris@6 262 <a id="a04427c420d9252c7796c0bf5101345ae"></a>
Chris@6 263 <h2 class="memtitle"><span class="permalink"><a href="#a04427c420d9252c7796c0bf5101345ae">&#9670;&nbsp;</a></span>pluginVersion</h2>
Chris@6 264
Chris@1 265 <div class="memitem">
Chris@1 266 <div class="memproto">
Chris@1 267 <table class="memname">
Chris@1 268 <tr>
Chris@6 269 <td class="memname">int _VampPluginDescriptor::pluginVersion</td>
Chris@1 270 </tr>
Chris@1 271 </table>
Chris@6 272 </div><div class="memdoc">
Chris@1 273
Chris@1 274 <p>Version number of the plugin. </p>
Chris@1 275
Chris@6 276 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00266">266</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 277
Chris@1 278 </div>
Chris@1 279 </div>
Chris@6 280 <a id="ae704bba384af0de056a26da1b13ee521"></a>
Chris@6 281 <h2 class="memtitle"><span class="permalink"><a href="#ae704bba384af0de056a26da1b13ee521">&#9670;&nbsp;</a></span>copyright</h2>
Chris@6 282
Chris@1 283 <div class="memitem">
Chris@1 284 <div class="memproto">
Chris@1 285 <table class="memname">
Chris@1 286 <tr>
Chris@6 287 <td class="memname">const char* _VampPluginDescriptor::copyright</td>
Chris@1 288 </tr>
Chris@1 289 </table>
Chris@6 290 </div><div class="memdoc">
Chris@1 291
Chris@1 292 <p>Human-readable summary of copyright or licensing for plugin. </p>
Chris@1 293
Chris@6 294 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00269">269</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 295
Chris@1 296 </div>
Chris@1 297 </div>
Chris@6 298 <a id="ae6271dc3ea0cea959c84a64185492cab"></a>
Chris@6 299 <h2 class="memtitle"><span class="permalink"><a href="#ae6271dc3ea0cea959c84a64185492cab">&#9670;&nbsp;</a></span>parameterCount</h2>
Chris@6 300
Chris@1 301 <div class="memitem">
Chris@1 302 <div class="memproto">
Chris@1 303 <table class="memname">
Chris@1 304 <tr>
Chris@6 305 <td class="memname">unsigned int _VampPluginDescriptor::parameterCount</td>
Chris@1 306 </tr>
Chris@1 307 </table>
Chris@6 308 </div><div class="memdoc">
Chris@1 309
Chris@1 310 <p>Number of parameter inputs. </p>
Chris@1 311
Chris@6 312 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00272">272</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 313
Chris@1 314 </div>
Chris@1 315 </div>
Chris@6 316 <a id="a64d614862604c31d6b84c49005f51913"></a>
Chris@6 317 <h2 class="memtitle"><span class="permalink"><a href="#a64d614862604c31d6b84c49005f51913">&#9670;&nbsp;</a></span>parameters</h2>
Chris@6 318
Chris@1 319 <div class="memitem">
Chris@1 320 <div class="memproto">
Chris@1 321 <table class="memname">
Chris@1 322 <tr>
Chris@6 323 <td class="memname">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a>** _VampPluginDescriptor::parameters</td>
Chris@1 324 </tr>
Chris@1 325 </table>
Chris@6 326 </div><div class="memdoc">
Chris@1 327
Chris@1 328 <p>Fixed descriptors for parameter inputs. </p>
Chris@1 329
Chris@6 330 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00275">275</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 331
Chris@1 332 </div>
Chris@1 333 </div>
Chris@6 334 <a id="a1962666aa173e7a9a2c30dc82e4b2e00"></a>
Chris@6 335 <h2 class="memtitle"><span class="permalink"><a href="#a1962666aa173e7a9a2c30dc82e4b2e00">&#9670;&nbsp;</a></span>programCount</h2>
Chris@6 336
Chris@1 337 <div class="memitem">
Chris@1 338 <div class="memproto">
Chris@1 339 <table class="memname">
Chris@1 340 <tr>
Chris@6 341 <td class="memname">unsigned int _VampPluginDescriptor::programCount</td>
Chris@1 342 </tr>
Chris@1 343 </table>
Chris@6 344 </div><div class="memdoc">
Chris@1 345
Chris@1 346 <p>Number of programs. </p>
Chris@1 347
Chris@6 348 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00278">278</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 349
Chris@1 350 </div>
Chris@1 351 </div>
Chris@6 352 <a id="ad488470c582d8472d86455889d71c5ec"></a>
Chris@6 353 <h2 class="memtitle"><span class="permalink"><a href="#ad488470c582d8472d86455889d71c5ec">&#9670;&nbsp;</a></span>programs</h2>
Chris@6 354
Chris@1 355 <div class="memitem">
Chris@1 356 <div class="memproto">
Chris@1 357 <table class="memname">
Chris@1 358 <tr>
Chris@6 359 <td class="memname">const char** _VampPluginDescriptor::programs</td>
Chris@1 360 </tr>
Chris@1 361 </table>
Chris@6 362 </div><div class="memdoc">
Chris@1 363
Chris@1 364 <p>Fixed names for programs. </p>
Chris@1 365
Chris@6 366 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00281">281</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 367
Chris@1 368 </div>
Chris@1 369 </div>
Chris@6 370 <a id="affc4d1796da7ced2c0cbb2cc2c4a22f4"></a>
Chris@6 371 <h2 class="memtitle"><span class="permalink"><a href="#affc4d1796da7ced2c0cbb2cc2c4a22f4">&#9670;&nbsp;</a></span>inputDomain</h2>
Chris@6 372
Chris@1 373 <div class="memitem">
Chris@1 374 <div class="memproto">
Chris@1 375 <table class="memname">
Chris@1 376 <tr>
Chris@6 377 <td class="memname"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> _VampPluginDescriptor::inputDomain</td>
Chris@1 378 </tr>
Chris@1 379 </table>
Chris@6 380 </div><div class="memdoc">
Chris@1 381
Chris@1 382 <p>Preferred input domain for audio input (time or frequency). </p>
Chris@1 383
Chris@6 384 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00284">284</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 385
Chris@1 386 </div>
Chris@1 387 </div>
Chris@6 388 <a id="aa5fa3dfd0b85668a658096de5271c305"></a>
Chris@6 389 <h2 class="memtitle"><span class="permalink"><a href="#aa5fa3dfd0b85668a658096de5271c305">&#9670;&nbsp;</a></span>instantiate</h2>
Chris@6 390
Chris@1 391 <div class="memitem">
Chris@1 392 <div class="memproto">
Chris@1 393 <table class="memname">
Chris@1 394 <tr>
Chris@6 395 <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* _VampPluginDescriptor::instantiate) (const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td>
Chris@1 396 </tr>
Chris@1 397 </table>
Chris@6 398 </div><div class="memdoc">
Chris@1 399
Chris@1 400 <p>Create and return a new instance of this plugin. </p>
Chris@1 401
Chris@6 402 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00287">287</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 403
Chris@1 404 </div>
Chris@1 405 </div>
Chris@6 406 <a id="a70974d8d28534c006af87c4470d12b69"></a>
Chris@6 407 <h2 class="memtitle"><span class="permalink"><a href="#a70974d8d28534c006af87c4470d12b69">&#9670;&nbsp;</a></span>cleanup</h2>
Chris@6 408
Chris@1 409 <div class="memitem">
Chris@1 410 <div class="memproto">
Chris@1 411 <table class="memname">
Chris@1 412 <tr>
Chris@6 413 <td class="memname">void(* _VampPluginDescriptor::cleanup) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 414 </tr>
Chris@1 415 </table>
Chris@6 416 </div><div class="memdoc">
Chris@1 417
Chris@1 418 <p>Destroy an instance of this plugin. </p>
Chris@1 419
Chris@6 420 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00291">291</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 421
Chris@1 422 </div>
Chris@1 423 </div>
Chris@6 424 <a id="a7c26381e66fc2b1fccbe9a0e5a0ff2be"></a>
Chris@6 425 <h2 class="memtitle"><span class="permalink"><a href="#a7c26381e66fc2b1fccbe9a0e5a0ff2be">&#9670;&nbsp;</a></span>initialise</h2>
Chris@6 426
Chris@1 427 <div class="memitem">
Chris@1 428 <div class="memproto">
Chris@1 429 <table class="memname">
Chris@1 430 <tr>
Chris@6 431 <td class="memname">int(* _VampPluginDescriptor::initialise) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td>
Chris@1 432 </tr>
Chris@1 433 </table>
Chris@6 434 </div><div class="memdoc">
Chris@1 435
Chris@1 436 <p>Initialise an instance following parameter configuration. </p>
Chris@1 437
Chris@6 438 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00294">294</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 439
Chris@1 440 </div>
Chris@1 441 </div>
Chris@6 442 <a id="a0bb0a037c2cb6baf3abac6b03d4a0009"></a>
Chris@6 443 <h2 class="memtitle"><span class="permalink"><a href="#a0bb0a037c2cb6baf3abac6b03d4a0009">&#9670;&nbsp;</a></span>reset</h2>
Chris@6 444
Chris@1 445 <div class="memitem">
Chris@1 446 <div class="memproto">
Chris@1 447 <table class="memname">
Chris@1 448 <tr>
Chris@6 449 <td class="memname">void(* _VampPluginDescriptor::reset) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 450 </tr>
Chris@1 451 </table>
Chris@6 452 </div><div class="memdoc">
Chris@1 453
Chris@1 454 <p>Reset an instance, ready to use again on new input data. </p>
Chris@1 455
Chris@6 456 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00300">300</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 457
Chris@1 458 </div>
Chris@1 459 </div>
Chris@6 460 <a id="a153dc1fa458602a408d8ae909e4b9780"></a>
Chris@6 461 <h2 class="memtitle"><span class="permalink"><a href="#a153dc1fa458602a408d8ae909e4b9780">&#9670;&nbsp;</a></span>getParameter</h2>
Chris@6 462
Chris@1 463 <div class="memitem">
Chris@1 464 <div class="memproto">
Chris@1 465 <table class="memname">
Chris@1 466 <tr>
Chris@6 467 <td class="memname">float(* _VampPluginDescriptor::getParameter) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td>
Chris@1 468 </tr>
Chris@1 469 </table>
Chris@6 470 </div><div class="memdoc">
Chris@1 471
Chris@1 472 <p>Get a parameter value. </p>
Chris@1 473
Chris@6 474 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00303">303</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 475
Chris@1 476 </div>
Chris@1 477 </div>
Chris@6 478 <a id="abe2500934c8aae78d0ecd6b4541d8946"></a>
Chris@6 479 <h2 class="memtitle"><span class="permalink"><a href="#abe2500934c8aae78d0ecd6b4541d8946">&#9670;&nbsp;</a></span>setParameter</h2>
Chris@6 480
Chris@1 481 <div class="memitem">
Chris@1 482 <div class="memproto">
Chris@1 483 <table class="memname">
Chris@1 484 <tr>
Chris@6 485 <td class="memname">void(* _VampPluginDescriptor::setParameter) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td>
Chris@1 486 </tr>
Chris@1 487 </table>
Chris@6 488 </div><div class="memdoc">
Chris@1 489
Chris@1 490 <p>Set a parameter value. </p>
Chris@1 491 <p>May only be called before initialise. </p>
Chris@1 492
Chris@6 493 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00306">306</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 494
Chris@1 495 </div>
Chris@1 496 </div>
Chris@6 497 <a id="a2d13712798238db503005808b736cb18"></a>
Chris@6 498 <h2 class="memtitle"><span class="permalink"><a href="#a2d13712798238db503005808b736cb18">&#9670;&nbsp;</a></span>getCurrentProgram</h2>
Chris@6 499
Chris@1 500 <div class="memitem">
Chris@1 501 <div class="memproto">
Chris@1 502 <table class="memname">
Chris@1 503 <tr>
Chris@6 504 <td class="memname">unsigned int(* _VampPluginDescriptor::getCurrentProgram) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 505 </tr>
Chris@1 506 </table>
Chris@6 507 </div><div class="memdoc">
Chris@1 508
Chris@1 509 <p>Get the current program (if programCount &gt; 0). </p>
Chris@1 510
Chris@6 511 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00309">309</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 512
Chris@1 513 </div>
Chris@1 514 </div>
Chris@6 515 <a id="a688596d8abcdd638250799314ef9cb19"></a>
Chris@6 516 <h2 class="memtitle"><span class="permalink"><a href="#a688596d8abcdd638250799314ef9cb19">&#9670;&nbsp;</a></span>selectProgram</h2>
Chris@6 517
Chris@1 518 <div class="memitem">
Chris@1 519 <div class="memproto">
Chris@1 520 <table class="memname">
Chris@1 521 <tr>
Chris@6 522 <td class="memname">void(* _VampPluginDescriptor::selectProgram) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td>
Chris@1 523 </tr>
Chris@1 524 </table>
Chris@6 525 </div><div class="memdoc">
Chris@1 526
Chris@1 527 <p>Set the current program. </p>
Chris@1 528 <p>May only be called before initialise. </p>
Chris@1 529
Chris@6 530 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00312">312</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 531
Chris@1 532 </div>
Chris@1 533 </div>
Chris@6 534 <a id="ae8efb5dec4a16b74fbb32ef36fc90e09"></a>
Chris@6 535 <h2 class="memtitle"><span class="permalink"><a href="#ae8efb5dec4a16b74fbb32ef36fc90e09">&#9670;&nbsp;</a></span>getPreferredStepSize</h2>
Chris@6 536
Chris@1 537 <div class="memitem">
Chris@1 538 <div class="memproto">
Chris@1 539 <table class="memname">
Chris@1 540 <tr>
Chris@6 541 <td class="memname">unsigned int(* _VampPluginDescriptor::getPreferredStepSize) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 542 </tr>
Chris@1 543 </table>
Chris@6 544 </div><div class="memdoc">
Chris@1 545
Chris@1 546 <p>Get the plugin's preferred processing window increment in samples. </p>
Chris@1 547
Chris@6 548 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00315">315</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 549
Chris@1 550 </div>
Chris@1 551 </div>
Chris@6 552 <a id="a3052e7f14ad1dfc3000b3b91dddf8c61"></a>
Chris@6 553 <h2 class="memtitle"><span class="permalink"><a href="#a3052e7f14ad1dfc3000b3b91dddf8c61">&#9670;&nbsp;</a></span>getPreferredBlockSize</h2>
Chris@6 554
Chris@1 555 <div class="memitem">
Chris@1 556 <div class="memproto">
Chris@1 557 <table class="memname">
Chris@1 558 <tr>
Chris@6 559 <td class="memname">unsigned int(* _VampPluginDescriptor::getPreferredBlockSize) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 560 </tr>
Chris@1 561 </table>
Chris@6 562 </div><div class="memdoc">
Chris@1 563
Chris@1 564 <p>Get the plugin's preferred processing window size in samples. </p>
Chris@1 565
Chris@6 566 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00318">318</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 567
Chris@1 568 </div>
Chris@1 569 </div>
Chris@6 570 <a id="a8a9be1cf9e70d46d20cac1b0049149cd"></a>
Chris@6 571 <h2 class="memtitle"><span class="permalink"><a href="#a8a9be1cf9e70d46d20cac1b0049149cd">&#9670;&nbsp;</a></span>getMinChannelCount</h2>
Chris@6 572
Chris@1 573 <div class="memitem">
Chris@1 574 <div class="memproto">
Chris@1 575 <table class="memname">
Chris@1 576 <tr>
Chris@6 577 <td class="memname">unsigned int(* _VampPluginDescriptor::getMinChannelCount) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 578 </tr>
Chris@1 579 </table>
Chris@6 580 </div><div class="memdoc">
Chris@1 581
Chris@1 582 <p>Get the minimum number of input channels this plugin can handle. </p>
Chris@1 583
Chris@6 584 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00321">321</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 585
Chris@1 586 </div>
Chris@1 587 </div>
Chris@6 588 <a id="af34bce679c821c38dbd212a0ef1bf867"></a>
Chris@6 589 <h2 class="memtitle"><span class="permalink"><a href="#af34bce679c821c38dbd212a0ef1bf867">&#9670;&nbsp;</a></span>getMaxChannelCount</h2>
Chris@6 590
Chris@1 591 <div class="memitem">
Chris@1 592 <div class="memproto">
Chris@1 593 <table class="memname">
Chris@1 594 <tr>
Chris@6 595 <td class="memname">unsigned int(* _VampPluginDescriptor::getMaxChannelCount) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 596 </tr>
Chris@1 597 </table>
Chris@6 598 </div><div class="memdoc">
Chris@1 599
Chris@1 600 <p>Get the maximum number of input channels this plugin can handle. </p>
Chris@1 601
Chris@6 602 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00324">324</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 603
Chris@1 604 </div>
Chris@1 605 </div>
Chris@6 606 <a id="a71825defc0052a8ac307e2c333c4b935"></a>
Chris@6 607 <h2 class="memtitle"><span class="permalink"><a href="#a71825defc0052a8ac307e2c333c4b935">&#9670;&nbsp;</a></span>getOutputCount</h2>
Chris@6 608
Chris@1 609 <div class="memitem">
Chris@1 610 <div class="memproto">
Chris@1 611 <table class="memname">
Chris@1 612 <tr>
Chris@6 613 <td class="memname">unsigned int(* _VampPluginDescriptor::getOutputCount) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 614 </tr>
Chris@1 615 </table>
Chris@6 616 </div><div class="memdoc">
Chris@1 617
Chris@1 618 <p>Get the number of feature outputs (distinct sets of results). </p>
Chris@1 619
Chris@6 620 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00327">327</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 621
Chris@1 622 </div>
Chris@1 623 </div>
Chris@6 624 <a id="a033116c818aafe70e7fd15d240234754"></a>
Chris@6 625 <h2 class="memtitle"><span class="permalink"><a href="#a033116c818aafe70e7fd15d240234754">&#9670;&nbsp;</a></span>getOutputDescriptor</h2>
Chris@6 626
Chris@1 627 <div class="memitem">
Chris@1 628 <div class="memproto">
Chris@1 629 <table class="memname">
Chris@1 630 <tr>
Chris@6 631 <td class="memname"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a>*(* _VampPluginDescriptor::getOutputDescriptor) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td>
Chris@1 632 </tr>
Chris@1 633 </table>
Chris@6 634 </div><div class="memdoc">
Chris@1 635
Chris@1 636 <p>Get a descriptor for a given feature output. </p>
Chris@1 637 <p>Returned pointer is valid only until next call to getOutputDescriptor for this handle, or releaseOutputDescriptor for this descriptor. Host must call releaseOutputDescriptor after use. </p>
Chris@1 638
Chris@6 639 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00333">333</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 640
Chris@1 641 </div>
Chris@1 642 </div>
Chris@6 643 <a id="a69f9fef2ed20a88985c960de4428cecb"></a>
Chris@6 644 <h2 class="memtitle"><span class="permalink"><a href="#a69f9fef2ed20a88985c960de4428cecb">&#9670;&nbsp;</a></span>releaseOutputDescriptor</h2>
Chris@6 645
Chris@1 646 <div class="memitem">
Chris@1 647 <div class="memproto">
Chris@1 648 <table class="memname">
Chris@1 649 <tr>
Chris@6 650 <td class="memname">void(* _VampPluginDescriptor::releaseOutputDescriptor) (<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td>
Chris@1 651 </tr>
Chris@1 652 </table>
Chris@6 653 </div><div class="memdoc">
Chris@1 654
Chris@1 655 <p>Destroy a descriptor for a feature output. </p>
Chris@1 656
Chris@6 657 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00337">337</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 658
Chris@1 659 </div>
Chris@1 660 </div>
Chris@6 661 <a id="aff1c25291c967cb2f198b900e551a7eb"></a>
Chris@6 662 <h2 class="memtitle"><span class="permalink"><a href="#aff1c25291c967cb2f198b900e551a7eb">&#9670;&nbsp;</a></span>process</h2>
Chris@6 663
Chris@1 664 <div class="memitem">
Chris@1 665 <div class="memproto">
Chris@1 666 <table class="memname">
Chris@1 667 <tr>
Chris@6 668 <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* _VampPluginDescriptor::process) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td>
Chris@1 669 </tr>
Chris@1 670 </table>
Chris@6 671 </div><div class="memdoc">
Chris@1 672
Chris@1 673 <p>Process an input block and return a set of features. </p>
Chris@1 674 <p>Returned pointer is valid only until next call to process, getRemainingFeatures, or cleanup for this handle, or releaseFeatureSet for this feature set. Host must call releaseFeatureSet after use. </p>
Chris@1 675
Chris@6 676 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00344">344</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 677
Chris@1 678 </div>
Chris@1 679 </div>
Chris@6 680 <a id="ad897b43458161a43cf6085198217d197"></a>
Chris@6 681 <h2 class="memtitle"><span class="permalink"><a href="#ad897b43458161a43cf6085198217d197">&#9670;&nbsp;</a></span>getRemainingFeatures</h2>
Chris@6 682
Chris@1 683 <div class="memitem">
Chris@1 684 <div class="memproto">
Chris@1 685 <table class="memname">
Chris@1 686 <tr>
Chris@6 687 <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* _VampPluginDescriptor::getRemainingFeatures) (<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
Chris@1 688 </tr>
Chris@1 689 </table>
Chris@6 690 </div><div class="memdoc">
Chris@1 691
Chris@1 692 <p>Return any remaining features at the end of processing. </p>
Chris@1 693
Chris@6 694 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00350">350</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 695
Chris@1 696 </div>
Chris@1 697 </div>
Chris@6 698 <a id="ab4ed73ea986582ab1b7e6c44149a982a"></a>
Chris@6 699 <h2 class="memtitle"><span class="permalink"><a href="#ab4ed73ea986582ab1b7e6c44149a982a">&#9670;&nbsp;</a></span>releaseFeatureSet</h2>
Chris@6 700
Chris@1 701 <div class="memitem">
Chris@1 702 <div class="memproto">
Chris@1 703 <table class="memname">
Chris@1 704 <tr>
Chris@6 705 <td class="memname">void(* _VampPluginDescriptor::releaseFeatureSet) (<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td>
Chris@1 706 </tr>
Chris@1 707 </table>
Chris@6 708 </div><div class="memdoc">
Chris@1 709
Chris@1 710 <p>Release a feature set returned from process or getRemainingFeatures. </p>
Chris@1 711
Chris@6 712 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00353">353</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
Chris@1 713
Chris@1 714 </div>
Chris@1 715 </div>
Chris@1 716 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 717 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
Chris@1 718 </ul>
Chris@3 719 </div><!-- contents -->
Chris@6 720 </div><!-- doc-content -->
Chris@6 721 <!-- start footer part -->
Chris@6 722 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 723 <ul>
Chris@6 724 <li class="navelem"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></li>
Chris@6 725 <li class="footer">Generated by
Chris@6 726 <a href="http://www.doxygen.org/index.html">
Chris@6 727 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 728 </ul>
Chris@1 729 </div>
Chris@1 730 </body>
Chris@1 731 </html>