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