|
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@1
|
6 <title>VampPluginSDK: _VampPluginDescriptor Struct Reference</title>
|
|
Chris@1
|
7
|
|
Chris@1
|
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
Chris@1
|
10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
11 <script type="text/javascript" src="jquery.js"></script>
|
|
Chris@1
|
12 <script type="text/javascript" src="resize.js"></script>
|
|
Chris@1
|
13 <script type="text/javascript" src="navtree.js"></script>
|
|
Chris@1
|
14 <script type="text/javascript">
|
|
Chris@1
|
15 $(document).ready(initResizable);
|
|
Chris@1
|
16 </script>
|
|
Chris@1
|
17
|
|
Chris@1
|
18
|
|
Chris@1
|
19 </head>
|
|
Chris@1
|
20 <body>
|
|
Chris@1
|
21 <div id="top"><!-- do not remove this div! -->
|
|
Chris@1
|
22
|
|
Chris@1
|
23
|
|
Chris@1
|
24 <div id="titlearea">
|
|
Chris@1
|
25 <table cellspacing="0" cellpadding="0">
|
|
Chris@1
|
26 <tbody>
|
|
Chris@1
|
27 <tr style="height: 56px;">
|
|
Chris@1
|
28
|
|
Chris@1
|
29
|
|
Chris@1
|
30 <td style="padding-left: 0.5em;">
|
|
Chris@1
|
31 <div id="projectname">VampPluginSDK
|
|
Chris@3
|
32  <span id="projectnumber">2.4</span>
|
|
Chris@1
|
33 </div>
|
|
Chris@1
|
34
|
|
Chris@1
|
35 </td>
|
|
Chris@1
|
36
|
|
Chris@1
|
37
|
|
Chris@1
|
38
|
|
Chris@1
|
39 </tr>
|
|
Chris@1
|
40 </tbody>
|
|
Chris@1
|
41 </table>
|
|
Chris@1
|
42 </div>
|
|
Chris@1
|
43
|
|
Chris@3
|
44 <!-- Generated by Doxygen 1.8.0 -->
|
|
Chris@1
|
45 <div id="navrow1" class="tabs">
|
|
Chris@1
|
46 <ul class="tablist">
|
|
Chris@1
|
47 <li><a href="index.html"><span>Main Page</span></a></li>
|
|
Chris@1
|
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
Chris@1
|
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
Chris@1
|
50 <li><a href="files.html"><span>Files</span></a></li>
|
|
Chris@1
|
51 <li><a href="dirs.html"><span>Directories</span></a></li>
|
|
Chris@1
|
52 </ul>
|
|
Chris@1
|
53 </div>
|
|
Chris@1
|
54 <div id="navrow2" class="tabs2">
|
|
Chris@1
|
55 <ul class="tablist">
|
|
Chris@1
|
56 <li><a href="annotated.html"><span>Class List</span></a></li>
|
|
Chris@1
|
57 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
Chris@1
|
58 <li><a href="functions.html"><span>Class Members</span></a></li>
|
|
Chris@1
|
59 </ul>
|
|
Chris@1
|
60 </div>
|
|
Chris@1
|
61 </div>
|
|
Chris@1
|
62 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
Chris@1
|
63 <div id="nav-tree">
|
|
Chris@1
|
64 <div id="nav-tree-contents">
|
|
Chris@1
|
65 </div>
|
|
Chris@1
|
66 </div>
|
|
Chris@1
|
67 <div id="splitbar" style="-moz-user-select:none;"
|
|
Chris@1
|
68 class="ui-resizable-handle">
|
|
Chris@1
|
69 </div>
|
|
Chris@1
|
70 </div>
|
|
Chris@1
|
71 <script type="text/javascript">
|
|
Chris@1
|
72 initNavTree('struct__VampPluginDescriptor.html','');
|
|
Chris@1
|
73 </script>
|
|
Chris@1
|
74 <div id="doc-content">
|
|
Chris@1
|
75 <div class="header">
|
|
Chris@1
|
76 <div class="summary">
|
|
Chris@1
|
77 <a href="#pub-attribs">Public Attributes</a> </div>
|
|
Chris@1
|
78 <div class="headertitle">
|
|
Chris@1
|
79 <div class="title">_VampPluginDescriptor Struct Reference</div> </div>
|
|
Chris@3
|
80 </div><!--header-->
|
|
Chris@1
|
81 <div class="contents">
|
|
Chris@3
|
82
|
|
Chris@1
|
83 <p><code>#include <<a class="el" href="vamp_8h_source.html">vamp.h</a>></code></p>
|
|
Chris@1
|
84
|
|
Chris@1
|
85 <p><a href="struct__VampPluginDescriptor-members.html">List of all members.</a></p>
|
|
Chris@1
|
86 <table class="memberdecls">
|
|
Chris@1
|
87 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
|
|
Chris@1
|
88 Public Attributes</h2></td></tr>
|
|
Chris@3
|
89 <tr class="memitem:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ab6c87760e87ddaa9ac3491bccaaa28c2">vampApiVersion</a></td></tr>
|
|
Chris@3
|
90 <tr class="memdesc:ab6c87760e87ddaa9ac3491bccaaa28c2"><td class="mdescLeft"> </td><td class="mdescRight">API version with which this descriptor is compatible. <a href="#ab6c87760e87ddaa9ac3491bccaaa28c2"></a><br/></td></tr>
|
|
Chris@3
|
91 <tr class="memitem:a4915ec8276749cb505c01d25a6d02219"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4915ec8276749cb505c01d25a6d02219">identifier</a></td></tr>
|
|
Chris@3
|
92 <tr class="memdesc:a4915ec8276749cb505c01d25a6d02219"><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the plugin. <a href="#a4915ec8276749cb505c01d25a6d02219"></a><br/></td></tr>
|
|
Chris@3
|
93 <tr class="memitem:a9dd5a0190e4d453ff36b5acb7000b150"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9dd5a0190e4d453ff36b5acb7000b150">name</a></td></tr>
|
|
Chris@3
|
94 <tr class="memdesc:a9dd5a0190e4d453ff36b5acb7000b150"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the plugin. <a href="#a9dd5a0190e4d453ff36b5acb7000b150"></a><br/></td></tr>
|
|
Chris@3
|
95 <tr class="memitem:a9ff8050f92f1a04a68bb34a9d368295e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a9ff8050f92f1a04a68bb34a9d368295e">description</a></td></tr>
|
|
Chris@3
|
96 <tr class="memdesc:a9ff8050f92f1a04a68bb34a9d368295e"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the plugin. <a href="#a9ff8050f92f1a04a68bb34a9d368295e"></a><br/></td></tr>
|
|
Chris@3
|
97 <tr class="memitem:a4dca3d57331802964716edfa80580c9b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a4dca3d57331802964716edfa80580c9b">maker</a></td></tr>
|
|
Chris@3
|
98 <tr class="memdesc:a4dca3d57331802964716edfa80580c9b"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of plugin's author or vendor. <a href="#a4dca3d57331802964716edfa80580c9b"></a><br/></td></tr>
|
|
Chris@3
|
99 <tr class="memitem:a04427c420d9252c7796c0bf5101345ae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a04427c420d9252c7796c0bf5101345ae">pluginVersion</a></td></tr>
|
|
Chris@3
|
100 <tr class="memdesc:a04427c420d9252c7796c0bf5101345ae"><td class="mdescLeft"> </td><td class="mdescRight">Version number of the plugin. <a href="#a04427c420d9252c7796c0bf5101345ae"></a><br/></td></tr>
|
|
Chris@3
|
101 <tr class="memitem:ae704bba384af0de056a26da1b13ee521"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae704bba384af0de056a26da1b13ee521">copyright</a></td></tr>
|
|
Chris@3
|
102 <tr class="memdesc:ae704bba384af0de056a26da1b13ee521"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable summary of copyright or licensing for plugin. <a href="#ae704bba384af0de056a26da1b13ee521"></a><br/></td></tr>
|
|
Chris@3
|
103 <tr class="memitem:ae6271dc3ea0cea959c84a64185492cab"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ae6271dc3ea0cea959c84a64185492cab">parameterCount</a></td></tr>
|
|
Chris@3
|
104 <tr class="memdesc:ae6271dc3ea0cea959c84a64185492cab"><td class="mdescLeft"> </td><td class="mdescRight">Number of parameter inputs. <a href="#ae6271dc3ea0cea959c84a64185492cab"></a><br/></td></tr>
|
|
Chris@3
|
105 <tr class="memitem:a64d614862604c31d6b84c49005f51913"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a64d614862604c31d6b84c49005f51913">parameters</a></td></tr>
|
|
Chris@3
|
106 <tr class="memdesc:a64d614862604c31d6b84c49005f51913"><td class="mdescLeft"> </td><td class="mdescRight">Fixed descriptors for parameter inputs. <a href="#a64d614862604c31d6b84c49005f51913"></a><br/></td></tr>
|
|
Chris@3
|
107 <tr class="memitem:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a1962666aa173e7a9a2c30dc82e4b2e00">programCount</a></td></tr>
|
|
Chris@3
|
108 <tr class="memdesc:a1962666aa173e7a9a2c30dc82e4b2e00"><td class="mdescLeft"> </td><td class="mdescRight">Number of programs. <a href="#a1962666aa173e7a9a2c30dc82e4b2e00"></a><br/></td></tr>
|
|
Chris@3
|
109 <tr class="memitem:ad488470c582d8472d86455889d71c5ec"><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad488470c582d8472d86455889d71c5ec">programs</a></td></tr>
|
|
Chris@3
|
110 <tr class="memdesc:ad488470c582d8472d86455889d71c5ec"><td class="mdescLeft"> </td><td class="mdescRight">Fixed names for programs. <a href="#ad488470c582d8472d86455889d71c5ec"></a><br/></td></tr>
|
|
Chris@3
|
111 <tr class="memitem:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#affc4d1796da7ced2c0cbb2cc2c4a22f4">inputDomain</a></td></tr>
|
|
Chris@3
|
112 <tr class="memdesc:affc4d1796da7ced2c0cbb2cc2c4a22f4"><td class="mdescLeft"> </td><td class="mdescRight">Preferred input domain for audio input (time or frequency). <a href="#affc4d1796da7ced2c0cbb2cc2c4a22f4"></a><br/></td></tr>
|
|
Chris@3
|
113 <tr class="memitem:a19c4ce36fdeb88eeedb539efc544b8ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a19c4ce36fdeb88eeedb539efc544b8ee">instantiate</a> )(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td></tr>
|
|
Chris@3
|
114 <tr class="memdesc:a19c4ce36fdeb88eeedb539efc544b8ee"><td class="mdescLeft"> </td><td class="mdescRight">Create and return a new instance of this plugin. <a href="#a19c4ce36fdeb88eeedb539efc544b8ee"></a><br/></td></tr>
|
|
Chris@3
|
115 <tr class="memitem:a0e4522c33e59c3c518b9262f2477bc27"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a0e4522c33e59c3c518b9262f2477bc27">cleanup</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
116 <tr class="memdesc:a0e4522c33e59c3c518b9262f2477bc27"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an instance of this plugin. <a href="#a0e4522c33e59c3c518b9262f2477bc27"></a><br/></td></tr>
|
|
Chris@3
|
117 <tr class="memitem:ad0978f17a5e568079470a1978a9aad22"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad0978f17a5e568079470a1978a9aad22">initialise</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td></tr>
|
|
Chris@3
|
118 <tr class="memdesc:ad0978f17a5e568079470a1978a9aad22"><td class="mdescLeft"> </td><td class="mdescRight">Initialise an instance following parameter configuration. <a href="#ad0978f17a5e568079470a1978a9aad22"></a><br/></td></tr>
|
|
Chris@3
|
119 <tr class="memitem:a12267f6b506aeda3792ff7c982b02336"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a12267f6b506aeda3792ff7c982b02336">reset</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
120 <tr class="memdesc:a12267f6b506aeda3792ff7c982b02336"><td class="mdescLeft"> </td><td class="mdescRight">Reset an instance, ready to use again on new input data. <a href="#a12267f6b506aeda3792ff7c982b02336"></a><br/></td></tr>
|
|
Chris@3
|
121 <tr class="memitem:a07174981875b55ee2ec7521a7f4fc395"><td class="memItemLeft" align="right" valign="top">float(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a07174981875b55ee2ec7521a7f4fc395">getParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td></tr>
|
|
Chris@3
|
122 <tr class="memdesc:a07174981875b55ee2ec7521a7f4fc395"><td class="mdescLeft"> </td><td class="mdescRight">Get a parameter value. <a href="#a07174981875b55ee2ec7521a7f4fc395"></a><br/></td></tr>
|
|
Chris@3
|
123 <tr class="memitem:aad3cfc7a3b432df40bd9db13eee6a481"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aad3cfc7a3b432df40bd9db13eee6a481">setParameter</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td></tr>
|
|
Chris@3
|
124 <tr class="memdesc:aad3cfc7a3b432df40bd9db13eee6a481"><td class="mdescLeft"> </td><td class="mdescRight">Set a parameter value. <a href="#aad3cfc7a3b432df40bd9db13eee6a481"></a><br/></td></tr>
|
|
Chris@3
|
125 <tr class="memitem:a861a77525a95d424cb846820b018af53"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a861a77525a95d424cb846820b018af53">getCurrentProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
126 <tr class="memdesc:a861a77525a95d424cb846820b018af53"><td class="mdescLeft"> </td><td class="mdescRight">Get the current program (if programCount > 0). <a href="#a861a77525a95d424cb846820b018af53"></a><br/></td></tr>
|
|
Chris@3
|
127 <tr class="memitem:ad9af40cb165ca187e49250964af5f5cf"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad9af40cb165ca187e49250964af5f5cf">selectProgram</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
|
|
Chris@3
|
128 <tr class="memdesc:ad9af40cb165ca187e49250964af5f5cf"><td class="mdescLeft"> </td><td class="mdescRight">Set the current program. <a href="#ad9af40cb165ca187e49250964af5f5cf"></a><br/></td></tr>
|
|
Chris@3
|
129 <tr class="memitem:a2beddf2ce156c05dd24477ac663adcbb"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a2beddf2ce156c05dd24477ac663adcbb">getPreferredStepSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
130 <tr class="memdesc:a2beddf2ce156c05dd24477ac663adcbb"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's preferred processing window increment in samples. <a href="#a2beddf2ce156c05dd24477ac663adcbb"></a><br/></td></tr>
|
|
Chris@3
|
131 <tr class="memitem:ac626e42554ab1532c8d8b5132a0faee8"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac626e42554ab1532c8d8b5132a0faee8">getPreferredBlockSize</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
132 <tr class="memdesc:ac626e42554ab1532c8d8b5132a0faee8"><td class="mdescLeft"> </td><td class="mdescRight">Get the plugin's preferred processing window size in samples. <a href="#ac626e42554ab1532c8d8b5132a0faee8"></a><br/></td></tr>
|
|
Chris@3
|
133 <tr class="memitem:af175ca17716db5a7545b61b01caabd92"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#af175ca17716db5a7545b61b01caabd92">getMinChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
134 <tr class="memdesc:af175ca17716db5a7545b61b01caabd92"><td class="mdescLeft"> </td><td class="mdescRight">Get the minimum number of input channels this plugin can handle. <a href="#af175ca17716db5a7545b61b01caabd92"></a><br/></td></tr>
|
|
Chris@3
|
135 <tr class="memitem:ad1600203418d9646332f5b917284261b"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad1600203418d9646332f5b917284261b">getMaxChannelCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
136 <tr class="memdesc:ad1600203418d9646332f5b917284261b"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum number of input channels this plugin can handle. <a href="#ad1600203418d9646332f5b917284261b"></a><br/></td></tr>
|
|
Chris@3
|
137 <tr class="memitem:aa8fc88da704e24b2b5f674821dd380c1"><td class="memItemLeft" align="right" valign="top">unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#aa8fc88da704e24b2b5f674821dd380c1">getOutputCount</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
138 <tr class="memdesc:aa8fc88da704e24b2b5f674821dd380c1"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of feature outputs (distinct sets of results). <a href="#aa8fc88da704e24b2b5f674821dd380c1"></a><br/></td></tr>
|
|
Chris@3
|
139 <tr class="memitem:a92c58b8ff99ad0c23a42333aa55c144d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a92c58b8ff99ad0c23a42333aa55c144d">getOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td></tr>
|
|
Chris@3
|
140 <tr class="memdesc:a92c58b8ff99ad0c23a42333aa55c144d"><td class="mdescLeft"> </td><td class="mdescRight">Get a descriptor for a given feature output. <a href="#a92c58b8ff99ad0c23a42333aa55c144d"></a><br/></td></tr>
|
|
Chris@3
|
141 <tr class="memitem:a8cc38edc921616e67e551aa03397ec79"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#a8cc38edc921616e67e551aa03397ec79">releaseOutputDescriptor</a> )(<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td></tr>
|
|
Chris@3
|
142 <tr class="memdesc:a8cc38edc921616e67e551aa03397ec79"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a descriptor for a feature output. <a href="#a8cc38edc921616e67e551aa03397ec79"></a><br/></td></tr>
|
|
Chris@3
|
143 <tr class="memitem:ac5a0a75b6e68b22fed536765d1f2f254"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac5a0a75b6e68b22fed536765d1f2f254">process</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td></tr>
|
|
Chris@3
|
144 <tr class="memdesc:ac5a0a75b6e68b22fed536765d1f2f254"><td class="mdescLeft"> </td><td class="mdescRight">Process an input block and return a set of features. <a href="#ac5a0a75b6e68b22fed536765d1f2f254"></a><br/></td></tr>
|
|
Chris@3
|
145 <tr class="memitem:ad22c666188aadab83c354a0edb18fcf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ad22c666188aadab83c354a0edb18fcf0">getRemainingFeatures</a> )(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td></tr>
|
|
Chris@3
|
146 <tr class="memdesc:ad22c666188aadab83c354a0edb18fcf0"><td class="mdescLeft"> </td><td class="mdescRight">Return any remaining features at the end of processing. <a href="#ad22c666188aadab83c354a0edb18fcf0"></a><br/></td></tr>
|
|
Chris@3
|
147 <tr class="memitem:ac4bafe8ad2734d21a433d745b18e7d63"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html#ac4bafe8ad2734d21a433d745b18e7d63">releaseFeatureSet</a> )(<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td></tr>
|
|
Chris@3
|
148 <tr class="memdesc:ac4bafe8ad2734d21a433d745b18e7d63"><td class="mdescLeft"> </td><td class="mdescRight">Release a feature set returned from process or getRemainingFeatures. <a href="#ac4bafe8ad2734d21a433d745b18e7d63"></a><br/></td></tr>
|
|
Chris@1
|
149 </table>
|
|
Chris@1
|
150 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
Chris@1
|
151 <div class="textblock">
|
|
Chris@1
|
152 <p>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@1
|
153 </div><hr/><h2>Member Data Documentation</h2>
|
|
Chris@3
|
154 <a class="anchor" id="ab6c87760e87ddaa9ac3491bccaaa28c2"></a>
|
|
Chris@1
|
155 <div class="memitem">
|
|
Chris@1
|
156 <div class="memproto">
|
|
Chris@1
|
157 <table class="memname">
|
|
Chris@1
|
158 <tr>
|
|
Chris@1
|
159 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#ab6c87760e87ddaa9ac3491bccaaa28c2">_VampPluginDescriptor::vampApiVersion</a></td>
|
|
Chris@1
|
160 </tr>
|
|
Chris@1
|
161 </table>
|
|
Chris@1
|
162 </div>
|
|
Chris@1
|
163 <div class="memdoc">
|
|
Chris@1
|
164
|
|
Chris@1
|
165 <p>API version with which this descriptor is compatible. </p>
|
|
Chris@1
|
166
|
|
Chris@1
|
167 <p>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
|
168
|
|
Chris@1
|
169 </div>
|
|
Chris@1
|
170 </div>
|
|
Chris@3
|
171 <a class="anchor" id="a4915ec8276749cb505c01d25a6d02219"></a>
|
|
Chris@1
|
172 <div class="memitem">
|
|
Chris@1
|
173 <div class="memproto">
|
|
Chris@1
|
174 <table class="memname">
|
|
Chris@1
|
175 <tr>
|
|
Chris@1
|
176 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a4915ec8276749cb505c01d25a6d02219">_VampPluginDescriptor::identifier</a></td>
|
|
Chris@1
|
177 </tr>
|
|
Chris@1
|
178 </table>
|
|
Chris@1
|
179 </div>
|
|
Chris@1
|
180 <div class="memdoc">
|
|
Chris@1
|
181
|
|
Chris@1
|
182 <p>Computer-usable name of the plugin. </p>
|
|
Chris@1
|
183 <p>Must not change. [a-zA-Z0-9_] </p>
|
|
Chris@1
|
184
|
|
Chris@1
|
185 <p>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
|
186
|
|
Chris@1
|
187 </div>
|
|
Chris@1
|
188 </div>
|
|
Chris@3
|
189 <a class="anchor" id="a9dd5a0190e4d453ff36b5acb7000b150"></a>
|
|
Chris@1
|
190 <div class="memitem">
|
|
Chris@1
|
191 <div class="memproto">
|
|
Chris@1
|
192 <table class="memname">
|
|
Chris@1
|
193 <tr>
|
|
Chris@1
|
194 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a9dd5a0190e4d453ff36b5acb7000b150">_VampPluginDescriptor::name</a></td>
|
|
Chris@1
|
195 </tr>
|
|
Chris@1
|
196 </table>
|
|
Chris@1
|
197 </div>
|
|
Chris@1
|
198 <div class="memdoc">
|
|
Chris@1
|
199
|
|
Chris@1
|
200 <p>Human-readable name of the plugin. </p>
|
|
Chris@1
|
201 <p>May be translatable. </p>
|
|
Chris@1
|
202
|
|
Chris@1
|
203 <p>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
|
204
|
|
Chris@1
|
205 </div>
|
|
Chris@1
|
206 </div>
|
|
Chris@3
|
207 <a class="anchor" id="a9ff8050f92f1a04a68bb34a9d368295e"></a>
|
|
Chris@1
|
208 <div class="memitem">
|
|
Chris@1
|
209 <div class="memproto">
|
|
Chris@1
|
210 <table class="memname">
|
|
Chris@1
|
211 <tr>
|
|
Chris@1
|
212 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a9ff8050f92f1a04a68bb34a9d368295e">_VampPluginDescriptor::description</a></td>
|
|
Chris@1
|
213 </tr>
|
|
Chris@1
|
214 </table>
|
|
Chris@1
|
215 </div>
|
|
Chris@1
|
216 <div class="memdoc">
|
|
Chris@1
|
217
|
|
Chris@1
|
218 <p>Human-readable short text about the plugin. </p>
|
|
Chris@1
|
219 <p>May be translatable. </p>
|
|
Chris@1
|
220
|
|
Chris@1
|
221 <p>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
|
222
|
|
Chris@1
|
223 </div>
|
|
Chris@1
|
224 </div>
|
|
Chris@3
|
225 <a class="anchor" id="a4dca3d57331802964716edfa80580c9b"></a>
|
|
Chris@1
|
226 <div class="memitem">
|
|
Chris@1
|
227 <div class="memproto">
|
|
Chris@1
|
228 <table class="memname">
|
|
Chris@1
|
229 <tr>
|
|
Chris@1
|
230 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#a4dca3d57331802964716edfa80580c9b">_VampPluginDescriptor::maker</a></td>
|
|
Chris@1
|
231 </tr>
|
|
Chris@1
|
232 </table>
|
|
Chris@1
|
233 </div>
|
|
Chris@1
|
234 <div class="memdoc">
|
|
Chris@1
|
235
|
|
Chris@1
|
236 <p>Human-readable name of plugin's author or vendor. </p>
|
|
Chris@1
|
237
|
|
Chris@1
|
238 <p>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
|
239
|
|
Chris@1
|
240 </div>
|
|
Chris@1
|
241 </div>
|
|
Chris@3
|
242 <a class="anchor" id="a04427c420d9252c7796c0bf5101345ae"></a>
|
|
Chris@1
|
243 <div class="memitem">
|
|
Chris@1
|
244 <div class="memproto">
|
|
Chris@1
|
245 <table class="memname">
|
|
Chris@1
|
246 <tr>
|
|
Chris@1
|
247 <td class="memname">int <a class="el" href="struct__VampPluginDescriptor.html#a04427c420d9252c7796c0bf5101345ae">_VampPluginDescriptor::pluginVersion</a></td>
|
|
Chris@1
|
248 </tr>
|
|
Chris@1
|
249 </table>
|
|
Chris@1
|
250 </div>
|
|
Chris@1
|
251 <div class="memdoc">
|
|
Chris@1
|
252
|
|
Chris@1
|
253 <p>Version number of the plugin. </p>
|
|
Chris@1
|
254
|
|
Chris@1
|
255 <p>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
|
256
|
|
Chris@1
|
257 </div>
|
|
Chris@1
|
258 </div>
|
|
Chris@3
|
259 <a class="anchor" id="ae704bba384af0de056a26da1b13ee521"></a>
|
|
Chris@1
|
260 <div class="memitem">
|
|
Chris@1
|
261 <div class="memproto">
|
|
Chris@1
|
262 <table class="memname">
|
|
Chris@1
|
263 <tr>
|
|
Chris@1
|
264 <td class="memname">const char* <a class="el" href="struct__VampPluginDescriptor.html#ae704bba384af0de056a26da1b13ee521">_VampPluginDescriptor::copyright</a></td>
|
|
Chris@1
|
265 </tr>
|
|
Chris@1
|
266 </table>
|
|
Chris@1
|
267 </div>
|
|
Chris@1
|
268 <div class="memdoc">
|
|
Chris@1
|
269
|
|
Chris@1
|
270 <p>Human-readable summary of copyright or licensing for plugin. </p>
|
|
Chris@1
|
271
|
|
Chris@1
|
272 <p>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
|
273
|
|
Chris@1
|
274 </div>
|
|
Chris@1
|
275 </div>
|
|
Chris@3
|
276 <a class="anchor" id="ae6271dc3ea0cea959c84a64185492cab"></a>
|
|
Chris@1
|
277 <div class="memitem">
|
|
Chris@1
|
278 <div class="memproto">
|
|
Chris@1
|
279 <table class="memname">
|
|
Chris@1
|
280 <tr>
|
|
Chris@1
|
281 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#ae6271dc3ea0cea959c84a64185492cab">_VampPluginDescriptor::parameterCount</a></td>
|
|
Chris@1
|
282 </tr>
|
|
Chris@1
|
283 </table>
|
|
Chris@1
|
284 </div>
|
|
Chris@1
|
285 <div class="memdoc">
|
|
Chris@1
|
286
|
|
Chris@1
|
287 <p>Number of parameter inputs. </p>
|
|
Chris@1
|
288
|
|
Chris@1
|
289 <p>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
|
290
|
|
Chris@1
|
291 </div>
|
|
Chris@1
|
292 </div>
|
|
Chris@3
|
293 <a class="anchor" id="a64d614862604c31d6b84c49005f51913"></a>
|
|
Chris@1
|
294 <div class="memitem">
|
|
Chris@1
|
295 <div class="memproto">
|
|
Chris@1
|
296 <table class="memname">
|
|
Chris@1
|
297 <tr>
|
|
Chris@1
|
298 <td class="memname">const <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a>** <a class="el" href="struct__VampPluginDescriptor.html#a64d614862604c31d6b84c49005f51913">_VampPluginDescriptor::parameters</a></td>
|
|
Chris@1
|
299 </tr>
|
|
Chris@1
|
300 </table>
|
|
Chris@1
|
301 </div>
|
|
Chris@1
|
302 <div class="memdoc">
|
|
Chris@1
|
303
|
|
Chris@1
|
304 <p>Fixed descriptors for parameter inputs. </p>
|
|
Chris@1
|
305
|
|
Chris@1
|
306 <p>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
|
307
|
|
Chris@1
|
308 </div>
|
|
Chris@1
|
309 </div>
|
|
Chris@3
|
310 <a class="anchor" id="a1962666aa173e7a9a2c30dc82e4b2e00"></a>
|
|
Chris@1
|
311 <div class="memitem">
|
|
Chris@1
|
312 <div class="memproto">
|
|
Chris@1
|
313 <table class="memname">
|
|
Chris@1
|
314 <tr>
|
|
Chris@1
|
315 <td class="memname">unsigned int <a class="el" href="struct__VampPluginDescriptor.html#a1962666aa173e7a9a2c30dc82e4b2e00">_VampPluginDescriptor::programCount</a></td>
|
|
Chris@1
|
316 </tr>
|
|
Chris@1
|
317 </table>
|
|
Chris@1
|
318 </div>
|
|
Chris@1
|
319 <div class="memdoc">
|
|
Chris@1
|
320
|
|
Chris@1
|
321 <p>Number of programs. </p>
|
|
Chris@1
|
322
|
|
Chris@1
|
323 <p>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
|
324
|
|
Chris@1
|
325 </div>
|
|
Chris@1
|
326 </div>
|
|
Chris@3
|
327 <a class="anchor" id="ad488470c582d8472d86455889d71c5ec"></a>
|
|
Chris@1
|
328 <div class="memitem">
|
|
Chris@1
|
329 <div class="memproto">
|
|
Chris@1
|
330 <table class="memname">
|
|
Chris@1
|
331 <tr>
|
|
Chris@1
|
332 <td class="memname">const char** <a class="el" href="struct__VampPluginDescriptor.html#ad488470c582d8472d86455889d71c5ec">_VampPluginDescriptor::programs</a></td>
|
|
Chris@1
|
333 </tr>
|
|
Chris@1
|
334 </table>
|
|
Chris@1
|
335 </div>
|
|
Chris@1
|
336 <div class="memdoc">
|
|
Chris@1
|
337
|
|
Chris@1
|
338 <p>Fixed names for programs. </p>
|
|
Chris@1
|
339
|
|
Chris@1
|
340 <p>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
|
341
|
|
Chris@1
|
342 </div>
|
|
Chris@1
|
343 </div>
|
|
Chris@3
|
344 <a class="anchor" id="affc4d1796da7ced2c0cbb2cc2c4a22f4"></a>
|
|
Chris@1
|
345 <div class="memitem">
|
|
Chris@1
|
346 <div class="memproto">
|
|
Chris@1
|
347 <table class="memname">
|
|
Chris@1
|
348 <tr>
|
|
Chris@1
|
349 <td class="memname"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> <a class="el" href="struct__VampPluginDescriptor.html#affc4d1796da7ced2c0cbb2cc2c4a22f4">_VampPluginDescriptor::inputDomain</a></td>
|
|
Chris@1
|
350 </tr>
|
|
Chris@1
|
351 </table>
|
|
Chris@1
|
352 </div>
|
|
Chris@1
|
353 <div class="memdoc">
|
|
Chris@1
|
354
|
|
Chris@1
|
355 <p>Preferred input domain for audio input (time or frequency). </p>
|
|
Chris@1
|
356
|
|
Chris@1
|
357 <p>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
|
358
|
|
Chris@1
|
359 </div>
|
|
Chris@1
|
360 </div>
|
|
Chris@3
|
361 <a class="anchor" id="a19c4ce36fdeb88eeedb539efc544b8ee"></a>
|
|
Chris@1
|
362 <div class="memitem">
|
|
Chris@1
|
363 <div class="memproto">
|
|
Chris@1
|
364 <table class="memname">
|
|
Chris@1
|
365 <tr>
|
|
Chris@1
|
366 <td class="memname"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>(* <a class="el" href="struct__VampPluginDescriptor.html#a19c4ce36fdeb88eeedb539efc544b8ee">_VampPluginDescriptor::instantiate</a>)(const struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> *, float inputSampleRate)</td>
|
|
Chris@1
|
367 </tr>
|
|
Chris@1
|
368 </table>
|
|
Chris@1
|
369 </div>
|
|
Chris@1
|
370 <div class="memdoc">
|
|
Chris@1
|
371
|
|
Chris@1
|
372 <p>Create and return a new instance of this plugin. </p>
|
|
Chris@1
|
373
|
|
Chris@1
|
374 <p>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
|
375
|
|
Chris@1
|
376 </div>
|
|
Chris@1
|
377 </div>
|
|
Chris@3
|
378 <a class="anchor" id="a0e4522c33e59c3c518b9262f2477bc27"></a>
|
|
Chris@1
|
379 <div class="memitem">
|
|
Chris@1
|
380 <div class="memproto">
|
|
Chris@1
|
381 <table class="memname">
|
|
Chris@1
|
382 <tr>
|
|
Chris@1
|
383 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a0e4522c33e59c3c518b9262f2477bc27">_VampPluginDescriptor::cleanup</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
384 </tr>
|
|
Chris@1
|
385 </table>
|
|
Chris@1
|
386 </div>
|
|
Chris@1
|
387 <div class="memdoc">
|
|
Chris@1
|
388
|
|
Chris@1
|
389 <p>Destroy an instance of this plugin. </p>
|
|
Chris@1
|
390
|
|
Chris@1
|
391 <p>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
|
392
|
|
Chris@1
|
393 </div>
|
|
Chris@1
|
394 </div>
|
|
Chris@3
|
395 <a class="anchor" id="ad0978f17a5e568079470a1978a9aad22"></a>
|
|
Chris@1
|
396 <div class="memitem">
|
|
Chris@1
|
397 <div class="memproto">
|
|
Chris@1
|
398 <table class="memname">
|
|
Chris@1
|
399 <tr>
|
|
Chris@1
|
400 <td class="memname">int(* <a class="el" href="struct__VampPluginDescriptor.html#ad0978f17a5e568079470a1978a9aad22">_VampPluginDescriptor::initialise</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int inputChannels, unsigned int stepSize, unsigned int blockSize)</td>
|
|
Chris@1
|
401 </tr>
|
|
Chris@1
|
402 </table>
|
|
Chris@1
|
403 </div>
|
|
Chris@1
|
404 <div class="memdoc">
|
|
Chris@1
|
405
|
|
Chris@1
|
406 <p>Initialise an instance following parameter configuration. </p>
|
|
Chris@1
|
407
|
|
Chris@1
|
408 <p>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
|
409
|
|
Chris@1
|
410 </div>
|
|
Chris@1
|
411 </div>
|
|
Chris@3
|
412 <a class="anchor" id="a12267f6b506aeda3792ff7c982b02336"></a>
|
|
Chris@1
|
413 <div class="memitem">
|
|
Chris@1
|
414 <div class="memproto">
|
|
Chris@1
|
415 <table class="memname">
|
|
Chris@1
|
416 <tr>
|
|
Chris@1
|
417 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a12267f6b506aeda3792ff7c982b02336">_VampPluginDescriptor::reset</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
418 </tr>
|
|
Chris@1
|
419 </table>
|
|
Chris@1
|
420 </div>
|
|
Chris@1
|
421 <div class="memdoc">
|
|
Chris@1
|
422
|
|
Chris@1
|
423 <p>Reset an instance, ready to use again on new input data. </p>
|
|
Chris@1
|
424
|
|
Chris@1
|
425 <p>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
|
426
|
|
Chris@1
|
427 </div>
|
|
Chris@1
|
428 </div>
|
|
Chris@3
|
429 <a class="anchor" id="a07174981875b55ee2ec7521a7f4fc395"></a>
|
|
Chris@1
|
430 <div class="memitem">
|
|
Chris@1
|
431 <div class="memproto">
|
|
Chris@1
|
432 <table class="memname">
|
|
Chris@1
|
433 <tr>
|
|
Chris@1
|
434 <td class="memname">float(* <a class="el" href="struct__VampPluginDescriptor.html#a07174981875b55ee2ec7521a7f4fc395">_VampPluginDescriptor::getParameter</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int)</td>
|
|
Chris@1
|
435 </tr>
|
|
Chris@1
|
436 </table>
|
|
Chris@1
|
437 </div>
|
|
Chris@1
|
438 <div class="memdoc">
|
|
Chris@1
|
439
|
|
Chris@1
|
440 <p>Get a parameter value. </p>
|
|
Chris@1
|
441
|
|
Chris@1
|
442 <p>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
|
443
|
|
Chris@1
|
444 </div>
|
|
Chris@1
|
445 </div>
|
|
Chris@3
|
446 <a class="anchor" id="aad3cfc7a3b432df40bd9db13eee6a481"></a>
|
|
Chris@1
|
447 <div class="memitem">
|
|
Chris@1
|
448 <div class="memproto">
|
|
Chris@1
|
449 <table class="memname">
|
|
Chris@1
|
450 <tr>
|
|
Chris@1
|
451 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#aad3cfc7a3b432df40bd9db13eee6a481">_VampPluginDescriptor::setParameter</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, int, float)</td>
|
|
Chris@1
|
452 </tr>
|
|
Chris@1
|
453 </table>
|
|
Chris@1
|
454 </div>
|
|
Chris@1
|
455 <div class="memdoc">
|
|
Chris@1
|
456
|
|
Chris@1
|
457 <p>Set a parameter value. </p>
|
|
Chris@1
|
458 <p>May only be called before initialise. </p>
|
|
Chris@1
|
459
|
|
Chris@1
|
460 <p>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
|
461
|
|
Chris@1
|
462 </div>
|
|
Chris@1
|
463 </div>
|
|
Chris@3
|
464 <a class="anchor" id="a861a77525a95d424cb846820b018af53"></a>
|
|
Chris@1
|
465 <div class="memitem">
|
|
Chris@1
|
466 <div class="memproto">
|
|
Chris@1
|
467 <table class="memname">
|
|
Chris@1
|
468 <tr>
|
|
Chris@1
|
469 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a861a77525a95d424cb846820b018af53">_VampPluginDescriptor::getCurrentProgram</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
470 </tr>
|
|
Chris@1
|
471 </table>
|
|
Chris@1
|
472 </div>
|
|
Chris@1
|
473 <div class="memdoc">
|
|
Chris@1
|
474
|
|
Chris@1
|
475 <p>Get the current program (if programCount > 0). </p>
|
|
Chris@1
|
476
|
|
Chris@1
|
477 <p>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
|
478
|
|
Chris@1
|
479 </div>
|
|
Chris@1
|
480 </div>
|
|
Chris@3
|
481 <a class="anchor" id="ad9af40cb165ca187e49250964af5f5cf"></a>
|
|
Chris@1
|
482 <div class="memitem">
|
|
Chris@1
|
483 <div class="memproto">
|
|
Chris@1
|
484 <table class="memname">
|
|
Chris@1
|
485 <tr>
|
|
Chris@1
|
486 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ad9af40cb165ca187e49250964af5f5cf">_VampPluginDescriptor::selectProgram</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td>
|
|
Chris@1
|
487 </tr>
|
|
Chris@1
|
488 </table>
|
|
Chris@1
|
489 </div>
|
|
Chris@1
|
490 <div class="memdoc">
|
|
Chris@1
|
491
|
|
Chris@1
|
492 <p>Set the current program. </p>
|
|
Chris@1
|
493 <p>May only be called before initialise. </p>
|
|
Chris@1
|
494
|
|
Chris@1
|
495 <p>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
|
496
|
|
Chris@1
|
497 </div>
|
|
Chris@1
|
498 </div>
|
|
Chris@3
|
499 <a class="anchor" id="a2beddf2ce156c05dd24477ac663adcbb"></a>
|
|
Chris@1
|
500 <div class="memitem">
|
|
Chris@1
|
501 <div class="memproto">
|
|
Chris@1
|
502 <table class="memname">
|
|
Chris@1
|
503 <tr>
|
|
Chris@1
|
504 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#a2beddf2ce156c05dd24477ac663adcbb">_VampPluginDescriptor::getPreferredStepSize</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
505 </tr>
|
|
Chris@1
|
506 </table>
|
|
Chris@1
|
507 </div>
|
|
Chris@1
|
508 <div class="memdoc">
|
|
Chris@1
|
509
|
|
Chris@1
|
510 <p>Get the plugin's preferred processing window increment in samples. </p>
|
|
Chris@1
|
511
|
|
Chris@1
|
512 <p>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
|
513
|
|
Chris@1
|
514 </div>
|
|
Chris@1
|
515 </div>
|
|
Chris@3
|
516 <a class="anchor" id="ac626e42554ab1532c8d8b5132a0faee8"></a>
|
|
Chris@1
|
517 <div class="memitem">
|
|
Chris@1
|
518 <div class="memproto">
|
|
Chris@1
|
519 <table class="memname">
|
|
Chris@1
|
520 <tr>
|
|
Chris@1
|
521 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#ac626e42554ab1532c8d8b5132a0faee8">_VampPluginDescriptor::getPreferredBlockSize</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
522 </tr>
|
|
Chris@1
|
523 </table>
|
|
Chris@1
|
524 </div>
|
|
Chris@1
|
525 <div class="memdoc">
|
|
Chris@1
|
526
|
|
Chris@1
|
527 <p>Get the plugin's preferred processing window size in samples. </p>
|
|
Chris@1
|
528
|
|
Chris@1
|
529 <p>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
|
530
|
|
Chris@1
|
531 </div>
|
|
Chris@1
|
532 </div>
|
|
Chris@3
|
533 <a class="anchor" id="af175ca17716db5a7545b61b01caabd92"></a>
|
|
Chris@1
|
534 <div class="memitem">
|
|
Chris@1
|
535 <div class="memproto">
|
|
Chris@1
|
536 <table class="memname">
|
|
Chris@1
|
537 <tr>
|
|
Chris@1
|
538 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#af175ca17716db5a7545b61b01caabd92">_VampPluginDescriptor::getMinChannelCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
539 </tr>
|
|
Chris@1
|
540 </table>
|
|
Chris@1
|
541 </div>
|
|
Chris@1
|
542 <div class="memdoc">
|
|
Chris@1
|
543
|
|
Chris@1
|
544 <p>Get the minimum number of input channels this plugin can handle. </p>
|
|
Chris@1
|
545
|
|
Chris@1
|
546 <p>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
|
547
|
|
Chris@1
|
548 </div>
|
|
Chris@1
|
549 </div>
|
|
Chris@3
|
550 <a class="anchor" id="ad1600203418d9646332f5b917284261b"></a>
|
|
Chris@1
|
551 <div class="memitem">
|
|
Chris@1
|
552 <div class="memproto">
|
|
Chris@1
|
553 <table class="memname">
|
|
Chris@1
|
554 <tr>
|
|
Chris@1
|
555 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#ad1600203418d9646332f5b917284261b">_VampPluginDescriptor::getMaxChannelCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
556 </tr>
|
|
Chris@1
|
557 </table>
|
|
Chris@1
|
558 </div>
|
|
Chris@1
|
559 <div class="memdoc">
|
|
Chris@1
|
560
|
|
Chris@1
|
561 <p>Get the maximum number of input channels this plugin can handle. </p>
|
|
Chris@1
|
562
|
|
Chris@1
|
563 <p>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
|
564
|
|
Chris@1
|
565 </div>
|
|
Chris@1
|
566 </div>
|
|
Chris@3
|
567 <a class="anchor" id="aa8fc88da704e24b2b5f674821dd380c1"></a>
|
|
Chris@1
|
568 <div class="memitem">
|
|
Chris@1
|
569 <div class="memproto">
|
|
Chris@1
|
570 <table class="memname">
|
|
Chris@1
|
571 <tr>
|
|
Chris@1
|
572 <td class="memname">unsigned int(* <a class="el" href="struct__VampPluginDescriptor.html#aa8fc88da704e24b2b5f674821dd380c1">_VampPluginDescriptor::getOutputCount</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
573 </tr>
|
|
Chris@1
|
574 </table>
|
|
Chris@1
|
575 </div>
|
|
Chris@1
|
576 <div class="memdoc">
|
|
Chris@1
|
577
|
|
Chris@1
|
578 <p>Get the number of feature outputs (distinct sets of results). </p>
|
|
Chris@1
|
579
|
|
Chris@1
|
580 <p>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
|
581
|
|
Chris@1
|
582 </div>
|
|
Chris@1
|
583 </div>
|
|
Chris@3
|
584 <a class="anchor" id="a92c58b8ff99ad0c23a42333aa55c144d"></a>
|
|
Chris@1
|
585 <div class="memitem">
|
|
Chris@1
|
586 <div class="memproto">
|
|
Chris@1
|
587 <table class="memname">
|
|
Chris@1
|
588 <tr>
|
|
Chris@1
|
589 <td class="memname"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#a92c58b8ff99ad0c23a42333aa55c144d">_VampPluginDescriptor::getOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, unsigned int)</td>
|
|
Chris@1
|
590 </tr>
|
|
Chris@1
|
591 </table>
|
|
Chris@1
|
592 </div>
|
|
Chris@1
|
593 <div class="memdoc">
|
|
Chris@1
|
594
|
|
Chris@1
|
595 <p>Get a descriptor for a given feature output. </p>
|
|
Chris@1
|
596 <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
|
597
|
|
Chris@1
|
598 <p>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
|
599
|
|
Chris@1
|
600 </div>
|
|
Chris@1
|
601 </div>
|
|
Chris@3
|
602 <a class="anchor" id="a8cc38edc921616e67e551aa03397ec79"></a>
|
|
Chris@1
|
603 <div class="memitem">
|
|
Chris@1
|
604 <div class="memproto">
|
|
Chris@1
|
605 <table class="memname">
|
|
Chris@1
|
606 <tr>
|
|
Chris@1
|
607 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#a8cc38edc921616e67e551aa03397ec79">_VampPluginDescriptor::releaseOutputDescriptor</a>)(<a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a> *)</td>
|
|
Chris@1
|
608 </tr>
|
|
Chris@1
|
609 </table>
|
|
Chris@1
|
610 </div>
|
|
Chris@1
|
611 <div class="memdoc">
|
|
Chris@1
|
612
|
|
Chris@1
|
613 <p>Destroy a descriptor for a feature output. </p>
|
|
Chris@1
|
614
|
|
Chris@1
|
615 <p>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
|
616
|
|
Chris@1
|
617 </div>
|
|
Chris@1
|
618 </div>
|
|
Chris@3
|
619 <a class="anchor" id="ac5a0a75b6e68b22fed536765d1f2f254"></a>
|
|
Chris@1
|
620 <div class="memitem">
|
|
Chris@1
|
621 <div class="memproto">
|
|
Chris@1
|
622 <table class="memname">
|
|
Chris@1
|
623 <tr>
|
|
Chris@1
|
624 <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#ac5a0a75b6e68b22fed536765d1f2f254">_VampPluginDescriptor::process</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>, const float *const *inputBuffers, int sec, int nsec)</td>
|
|
Chris@1
|
625 </tr>
|
|
Chris@1
|
626 </table>
|
|
Chris@1
|
627 </div>
|
|
Chris@1
|
628 <div class="memdoc">
|
|
Chris@1
|
629
|
|
Chris@1
|
630 <p>Process an input block and return a set of features. </p>
|
|
Chris@1
|
631 <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
|
632
|
|
Chris@1
|
633 <p>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
|
634
|
|
Chris@1
|
635 </div>
|
|
Chris@1
|
636 </div>
|
|
Chris@3
|
637 <a class="anchor" id="ad22c666188aadab83c354a0edb18fcf0"></a>
|
|
Chris@1
|
638 <div class="memitem">
|
|
Chris@1
|
639 <div class="memproto">
|
|
Chris@1
|
640 <table class="memname">
|
|
Chris@1
|
641 <tr>
|
|
Chris@1
|
642 <td class="memname"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a>*(* <a class="el" href="struct__VampPluginDescriptor.html#ad22c666188aadab83c354a0edb18fcf0">_VampPluginDescriptor::getRemainingFeatures</a>)(<a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a>)</td>
|
|
Chris@1
|
643 </tr>
|
|
Chris@1
|
644 </table>
|
|
Chris@1
|
645 </div>
|
|
Chris@1
|
646 <div class="memdoc">
|
|
Chris@1
|
647
|
|
Chris@1
|
648 <p>Return any remaining features at the end of processing. </p>
|
|
Chris@1
|
649
|
|
Chris@1
|
650 <p>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
|
651
|
|
Chris@1
|
652 </div>
|
|
Chris@1
|
653 </div>
|
|
Chris@3
|
654 <a class="anchor" id="ac4bafe8ad2734d21a433d745b18e7d63"></a>
|
|
Chris@1
|
655 <div class="memitem">
|
|
Chris@1
|
656 <div class="memproto">
|
|
Chris@1
|
657 <table class="memname">
|
|
Chris@1
|
658 <tr>
|
|
Chris@1
|
659 <td class="memname">void(* <a class="el" href="struct__VampPluginDescriptor.html#ac4bafe8ad2734d21a433d745b18e7d63">_VampPluginDescriptor::releaseFeatureSet</a>)(<a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a> *)</td>
|
|
Chris@1
|
660 </tr>
|
|
Chris@1
|
661 </table>
|
|
Chris@1
|
662 </div>
|
|
Chris@1
|
663 <div class="memdoc">
|
|
Chris@1
|
664
|
|
Chris@1
|
665 <p>Release a feature set returned from process or getRemainingFeatures. </p>
|
|
Chris@1
|
666
|
|
Chris@1
|
667 <p>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
|
668
|
|
Chris@1
|
669 </div>
|
|
Chris@1
|
670 </div>
|
|
Chris@1
|
671 <hr/>The documentation for this struct was generated from the following file:<ul>
|
|
Chris@1
|
672 <li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
|
|
Chris@1
|
673 </ul>
|
|
Chris@3
|
674 </div><!-- contents -->
|
|
Chris@1
|
675 </div>
|
|
Chris@1
|
676 <div id="nav-path" class="navpath">
|
|
Chris@1
|
677 <ul>
|
|
Chris@1
|
678 <li class="navelem"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> </li>
|
|
Chris@1
|
679
|
|
Chris@3
|
680 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
|
|
Chris@1
|
681 <a href="http://www.doxygen.org/index.html">
|
|
Chris@3
|
682 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
|
|
Chris@1
|
683 </ul>
|
|
Chris@1
|
684 </div>
|
|
Chris@1
|
685
|
|
Chris@1
|
686
|
|
Chris@1
|
687 </body>
|
|
Chris@1
|
688 </html>
|
