Mercurial > hg > vamp-docs

comparison code-docs/vamp_8h.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
children
comparison
equal deleted inserted replaced
5:5c95f546f0b4 6:27319718b1f8
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>VampPluginSDK: vamp.h File Reference</title> 8 <title>VampPluginSDK: vamp.h File Reference</title>
7
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="resize.js"></script> 13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
13 <script type="text/javascript" src="navtree.js"></script> 15 <script type="text/javascript" src="navtree.js"></script>
14 <script type="text/javascript"> 16 <script type="text/javascript">
15 $(document).ready(initResizable); 17 $(document).ready(initResizable);
16 </script> 18 </script>
17 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
18
19 </head> 20 </head>
20 <body> 21 <body>
21 <div id="top"><!-- do not remove this div! --> 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
22
23
24 <div id="titlearea"> 23 <div id="titlearea">
25 <table cellspacing="0" cellpadding="0"> 24 <table cellspacing="0" cellpadding="0">
26 <tbody> 25 <tbody>
27 <tr style="height: 56px;"> 26 <tr style="height: 56px;">
28 27 <td id="projectalign" style="padding-left: 0.5em;">
29
30 <td style="padding-left: 0.5em;">
31 <div id="projectname">VampPluginSDK 28 <div id="projectname">VampPluginSDK
32 &#160;<span id="projectnumber">2.4</span> 29 &#160;<span id="projectnumber">2.7</span>
33 </div> 30 </div>
34
35 </td> 31 </td>
36
37
38
39 </tr> 32 </tr>
40 </tbody> 33 </tbody>
41 </table> 34 </table>
42 </div> 35 </div>
43 36 <!-- end header part -->
44 <!-- Generated by Doxygen 1.8.0 --> 37 <!-- Generated by Doxygen 1.8.13 -->
45 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
46 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
47 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 41 $(function() {
49 <li><a href="annotated.html"><span>Classes</span></a></li> 42 initMenu('',false,false,'search.php','Search');
50 <li class="current"><a href="files.html"><span>Files</span></a></li> 43 });
51 <li><a href="dirs.html"><span>Directories</span></a></li> 44 </script>
52 </ul> 45 <div id="main-nav"></div>
53 </div> 46 </div><!-- top -->
54 <div id="navrow2" class="tabs2">
55 <ul class="tablist">
56 <li><a href="files.html"><span>File&#160;List</span></a></li>
57 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
58 </ul>
59 </div>
60 </div>
61 <div id="side-nav" class="ui-resizable side-nav-resizable"> 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree"> 48 <div id="nav-tree">
63 <div id="nav-tree-contents"> 49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
64 </div> 51 </div>
65 </div> 52 </div>
66 <div id="splitbar" style="-moz-user-select:none;" 53 <div id="splitbar" style="-moz-user-select:none;"
67 class="ui-resizable-handle"> 54 class="ui-resizable-handle">
68 </div> 55 </div>
69 </div> 56 </div>
70 <script type="text/javascript"> 57 <script type="text/javascript">
71 initNavTree('vamp_8h.html',''); 58 $(document).ready(function(){initNavTree('vamp_8h.html','');});
72 </script> 59 </script>
73 <div id="doc-content"> 60 <div id="doc-content">
74 <div class="header"> 61 <div class="header">
75 <div class="summary"> 62 <div class="summary">
76 <a href="#nested-classes">Classes</a> &#124; 63 <a href="#nested-classes">Classes</a> &#124;
77 <a href="#define-members">Defines</a> &#124; 64 <a href="#define-members">Macros</a> &#124;
78 <a href="#typedef-members">Typedefs</a> &#124; 65 <a href="#typedef-members">Typedefs</a> &#124;
79 <a href="#enum-members">Enumerations</a> &#124; 66 <a href="#enum-members">Enumerations</a> &#124;
80 <a href="#func-members">Functions</a> </div> 67 <a href="#func-members">Functions</a> </div>
81 <div class="headertitle"> 68 <div class="headertitle">
82 <div class="title">vamp.h File Reference</div> </div> 69 <div class="title">vamp.h File Reference</div> </div>
83 </div><!--header--> 70 </div><!--header-->
84 <div class="contents"> 71 <div class="contents">
85 72 <div class="textblock"><div class="dynheader">
73 This graph shows which files directly or indirectly include this file:</div>
74 <div class="dyncontent">
75 <div class="center"><img src="vamp_8h__dep__incl.png" border="0" usemap="#vamp_8hdep" alt=""/></div>
76 <map name="vamp_8hdep" id="vamp_8hdep">
77 <area shape="rect" id="node2" href="PluginAdapter_8h.html" title="PluginAdapter.h" alt="" coords="5,79,113,104"/>
78 <area shape="rect" id="node3" href="plugins_8cpp.html" title="plugins.cpp" alt="" coords="66,152,151,177"/>
79 <area shape="rect" id="node4" href="host-c_8h.html" title="host&#45;c.h" alt="" coords="189,79,255,104"/>
80 <area shape="rect" id="node5" href="PluginHostAdapter_8h.html" title="PluginHostAdapter.h" alt="" coords="279,79,413,104"/>
81 <area shape="rect" id="node6" href="vamp-hostsdk_8h.html" title="vamp&#45;hostsdk.h" alt="" coords="181,152,292,177"/>
82 <area shape="rect" id="node7" href="vamp-simple-host_8cpp.html" title="vamp&#45;simple&#45;host.cpp" alt="" coords="316,152,461,177"/>
83 </map>
84 </div>
85 </div>
86 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p> 86 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p>
87 <table class="memberdecls"> 87 <table class="memberdecls">
88 <tr><td colspan="2"><h2><a name="nested-classes"></a> 88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
89 Classes</h2></td></tr> 89 Classes</h2></td></tr>
90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td></tr> 90 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td></tr>
91 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="struct__VampParameterDescriptor.html#details">More...</a><br/></td></tr> 91 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="struct__VampParameterDescriptor.html#details">More...</a><br /></td></tr>
92 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td></tr> 93 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td></tr>
94 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td></tr> 95 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td></tr>
96 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td></tr> 97 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td></tr>
98 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td></tr> 99 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td></tr>
100 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td></tr> 101 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td></tr>
102 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td></tr> 103 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td></tr>
98 <tr><td colspan="2"><h2><a name="define-members"></a> 104 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 Defines</h2></td></tr> 105 </table><table class="memberdecls">
106 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
107 Macros</h2></td></tr>
100 <tr class="memitem:a6d6c8c755dbabf161f72712e0e2143c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td></tr> 108 <tr class="memitem:a6d6c8c755dbabf161f72712e0e2143c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td></tr>
101 <tr class="memdesc:a6d6c8c755dbabf161f72712e0e2143c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7"></a><br/></td></tr> 109 <tr class="memdesc:a6d6c8c755dbabf161f72712e0e2143c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7">More...</a><br /></td></tr>
102 <tr><td colspan="2"><h2><a name="typedef-members"></a> 110 <tr class="separator:a6d6c8c755dbabf161f72712e0e2143c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 </table><table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
103 Typedefs</h2></td></tr> 113 Typedefs</h2></td></tr>
104 <tr class="memitem:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 114 <tr class="memitem:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td></tr>
105 <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td></tr> 115 <tr class="memdesc:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="#ae26a9d54a92f1c083a1b209a25a8e44e">More...</a><br /></td></tr>
106 <tr class="memdesc:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="mdescLeft">&#160;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="#ae26a9d54a92f1c083a1b209a25a8e44e"></a><br/></td></tr> 116 <tr class="separator:ae26a9d54a92f1c083a1b209a25a8e44e"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:aa8429dd9c60d65800c58574c2b06bf66"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 117 <tr class="memitem:aa8429dd9c60d65800c58574c2b06bf66"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td></tr>
108 <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td></tr> 118 <tr class="separator:aa8429dd9c60d65800c58574c2b06bf66"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <tr class="memitem:a8d04355c13e5ff7a146abcb168cb919f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td></tr> 119 <tr class="memitem:a8d04355c13e5ff7a146abcb168cb919f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td></tr>
120 <tr class="separator:a8d04355c13e5ff7a146abcb168cb919f"><td class="memSeparator" colspan="2">&#160;</td></tr>
110 <tr class="memitem:a41cb3518127d0971b1d2c8edfbbe2763"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td></tr> 121 <tr class="memitem:a41cb3518127d0971b1d2c8edfbbe2763"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td></tr>
122 <tr class="separator:a41cb3518127d0971b1d2c8edfbbe2763"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a2517349f1c97e0c59faab6085e092fcd"><td class="memItemLeft" align="right" valign="top">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td></tr> 123 <tr class="memitem:a2517349f1c97e0c59faab6085e092fcd"><td class="memItemLeft" align="right" valign="top">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td></tr>
124 <tr class="separator:a2517349f1c97e0c59faab6085e092fcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
112 <tr class="memitem:a5f257e3f8b5ca1ca4c159d486e219078"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td></tr> 125 <tr class="memitem:a5f257e3f8b5ca1ca4c159d486e219078"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td></tr>
126 <tr class="separator:a5f257e3f8b5ca1ca4c159d486e219078"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <tr class="memitem:ad3be2952b1f4ad7d775940a6db75c79b"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td></tr> 127 <tr class="memitem:ad3be2952b1f4ad7d775940a6db75c79b"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td></tr>
114 <tr class="memitem:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> 128 <tr class="separator:ad3be2952b1f4ad7d775940a6db75c79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td></tr> 129 <tr class="memitem:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td></tr>
116 <tr class="memitem:a551bb7e0d8c970c2202be5f881817478"><td class="memItemLeft" align="right" valign="top">typedef const <br class="typebreak"/> 130 <tr class="separator:aa1d6e0792099b9516a89b5fb7ed2ad2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a> )(unsigned int, unsigned int)</td></tr> 131 <tr class="memitem:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="memItemLeft" align="right" valign="top">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#afb59eb6e4ea5b47fc300435e98e8aa1b">VampGetPluginDescriptorFunction</a>) (unsigned int, unsigned int)</td></tr>
118 <tr class="memdesc:a551bb7e0d8c970c2202be5f881817478"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#a551bb7e0d8c970c2202be5f881817478"></a><br/></td></tr> 132 <tr class="memdesc:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#afb59eb6e4ea5b47fc300435e98e8aa1b">More...</a><br /></td></tr>
119 <tr><td colspan="2"><h2><a name="enum-members"></a> 133 <tr class="separator:afb59eb6e4ea5b47fc300435e98e8aa1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
134 </table><table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
120 Enumerations</h2></td></tr> 136 Enumerations</h2></td></tr>
121 <tr class="memitem:aa24a8cee023d8b7659d25cbe0584b821"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> { <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113">vampOneSamplePerStep</a>, 137 <tr class="memitem:aa24a8cee023d8b7659d25cbe0584b821"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> { <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113">vampOneSamplePerStep</a>,
122 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>, 138 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>,
123 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a> 139 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a>
124 }</td></tr> 140 }</td></tr>
141 <tr class="separator:aa24a8cee023d8b7659d25cbe0584b821"><td class="memSeparator" colspan="2">&#160;</td></tr>
125 <tr class="memitem:ab107386a5f042feddf6446bea23bb765"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> { <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>, 142 <tr class="memitem:ab107386a5f042feddf6446bea23bb765"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a> { <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>,
126 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a> 143 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
127 }</td></tr> 144 }</td></tr>
128 <tr><td colspan="2"><h2><a name="func-members"></a> 145 <tr class="separator:ab107386a5f042feddf6446bea23bb765"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 </table><table class="memberdecls">
147 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
129 Functions</h2></td></tr> 148 Functions</h2></td></tr>
130 <tr class="memitem:a50cf6f17d0718f02093be6c7f63fcf30"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a50cf6f17d0718f02093be6c7f63fcf30">vampGetPluginDescriptor</a> (unsigned int hostApiVersion, unsigned int index)</td></tr> 149 <tr class="memitem:a50cf6f17d0718f02093be6c7f63fcf30"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a50cf6f17d0718f02093be6c7f63fcf30">vampGetPluginDescriptor</a> (unsigned int hostApiVersion, unsigned int index)</td></tr>
131 <tr class="memdesc:a50cf6f17d0718f02093be6c7f63fcf30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#a50cf6f17d0718f02093be6c7f63fcf30"></a><br/></td></tr> 150 <tr class="memdesc:a50cf6f17d0718f02093be6c7f63fcf30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#a50cf6f17d0718f02093be6c7f63fcf30">More...</a><br /></td></tr>
151 <tr class="separator:a50cf6f17d0718f02093be6c7f63fcf30"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 </table> 152 </table>
133 <hr/><h2>Define Documentation</h2> 153 <h2 class="groupheader">Macro Definition Documentation</h2>
134 <a class="anchor" id="a6d6c8c755dbabf161f72712e0e2143c7"></a> 154 <a id="a6d6c8c755dbabf161f72712e0e2143c7"></a>
135 <div class="memitem"> 155 <h2 class="memtitle"><span class="permalink"><a href="#a6d6c8c755dbabf161f72712e0e2143c7">&#9670;&nbsp;</a></span>VAMP_API_VERSION</h2>
136 <div class="memproto"> 156
137 <table class="memname"> 157 <div class="memitem">
138 <tr> 158 <div class="memproto">
139 <td class="memname">#define <a class="el" href="vamp_8h.html#a6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&#160;&#160;&#160;2</td> 159 <table class="memname">
140 </tr> 160 <tr>
141 </table> 161 <td class="memname">#define VAMP_API_VERSION&#160;&#160;&#160;2</td>
142 </div> 162 </tr>
143 <div class="memdoc"> 163 </table>
164 </div><div class="memdoc">
144 165
145 <p>Plugin API version. </p> 166 <p>Plugin API version. </p>
146 <p>This is incremented when a change is made that changes the binary layout of the descriptor records. When this happens, there should be a mechanism for retaining compatibility with older hosts and/or plugins.</p> 167 <p>This is incremented when a change is made that changes the binary layout of the descriptor records. When this happens, there should be a mechanism for retaining compatibility with older hosts and/or plugins.</p>
147 <p>See also the vampApiVersion field in the plugin descriptor, and the hostApiVersion argument to the vampGetPluginDescriptor function. </p> 168 <p>See also the vampApiVersion field in the plugin descriptor, and the hostApiVersion argument to the vampGetPluginDescriptor function. </p>
148 169
149 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00053">53</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 170 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00053">53</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
150 171
151 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00137">main()</a>.</p> 172 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00140">main()</a>.</p>
152 173
153 </div> 174 </div>
154 </div> 175 </div>
155 <hr/><h2>Typedef Documentation</h2> 176 <h2 class="groupheader">Typedef Documentation</h2>
156 <a class="anchor" id="ae26a9d54a92f1c083a1b209a25a8e44e"></a> 177 <a id="ae26a9d54a92f1c083a1b209a25a8e44e"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#ae26a9d54a92f1c083a1b209a25a8e44e">&#9670;&nbsp;</a></span>VampParameterDescriptor</h2>
179
157 <div class="memitem"> 180 <div class="memitem">
158 <div class="memproto"> 181 <div class="memproto">
159 <table class="memname"> 182 <table class="memname">
160 <tr> 183 <tr>
161 <td class="memname">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td> 184 <td class="memname">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> <a class="el" href="vamp_8h.html#ae26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td>
162 </tr> 185 </tr>
163 </table> 186 </table>
164 </div> 187 </div><div class="memdoc">
165 <div class="memdoc">
166 188
167 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p> 189 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
168 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p> 190 <p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p>
169 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p> 191 <p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p>
170 192
171 </div> 193 </div>
172 </div> 194 </div>
173 <a class="anchor" id="aa8429dd9c60d65800c58574c2b06bf66"></a> 195 <a id="aa8429dd9c60d65800c58574c2b06bf66"></a>
196 <h2 class="memtitle"><span class="permalink"><a href="#aa8429dd9c60d65800c58574c2b06bf66">&#9670;&nbsp;</a></span>VampOutputDescriptor</h2>
197
174 <div class="memitem"> 198 <div class="memitem">
175 <div class="memproto"> 199 <div class="memproto">
176 <table class="memname"> 200 <table class="memname">
177 <tr> 201 <tr>
178 <td class="memname">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a> <a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td> 202 <td class="memname">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a> <a class="el" href="vamp_8h.html#aa8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td>
179 </tr> 203 </tr>
180 </table> 204 </table>
181 </div> 205 </div><div class="memdoc">
182 <div class="memdoc"> 206
183 207 </div>
184 </div> 208 </div>
185 </div> 209 <a id="a8d04355c13e5ff7a146abcb168cb919f"></a>
186 <a class="anchor" id="a8d04355c13e5ff7a146abcb168cb919f"></a> 210 <h2 class="memtitle"><span class="permalink"><a href="#a8d04355c13e5ff7a146abcb168cb919f">&#9670;&nbsp;</a></span>VampFeature</h2>
211
187 <div class="memitem"> 212 <div class="memitem">
188 <div class="memproto"> 213 <div class="memproto">
189 <table class="memname"> 214 <table class="memname">
190 <tr> 215 <tr>
191 <td class="memname">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a> <a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td> 216 <td class="memname">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a> <a class="el" href="vamp_8h.html#a8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td>
192 </tr> 217 </tr>
193 </table> 218 </table>
194 </div> 219 </div><div class="memdoc">
195 <div class="memdoc"> 220
196 221 </div>
197 </div> 222 </div>
198 </div> 223 <a id="a41cb3518127d0971b1d2c8edfbbe2763"></a>
199 <a class="anchor" id="a41cb3518127d0971b1d2c8edfbbe2763"></a> 224 <h2 class="memtitle"><span class="permalink"><a href="#a41cb3518127d0971b1d2c8edfbbe2763">&#9670;&nbsp;</a></span>VampFeatureV2</h2>
225
200 <div class="memitem"> 226 <div class="memitem">
201 <div class="memproto"> 227 <div class="memproto">
202 <table class="memname"> 228 <table class="memname">
203 <tr> 229 <tr>
204 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a> <a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td> 230 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a> <a class="el" href="vamp_8h.html#a41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td>
205 </tr> 231 </tr>
206 </table> 232 </table>
207 </div> 233 </div><div class="memdoc">
208 <div class="memdoc"> 234
209 235 </div>
210 </div> 236 </div>
211 </div> 237 <a id="a2517349f1c97e0c59faab6085e092fcd"></a>
212 <a class="anchor" id="a2517349f1c97e0c59faab6085e092fcd"></a> 238 <h2 class="memtitle"><span class="permalink"><a href="#a2517349f1c97e0c59faab6085e092fcd">&#9670;&nbsp;</a></span>VampFeatureUnion</h2>
239
213 <div class="memitem"> 240 <div class="memitem">
214 <div class="memproto"> 241 <div class="memproto">
215 <table class="memname"> 242 <table class="memname">
216 <tr> 243 <tr>
217 <td class="memname">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> <a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td> 244 <td class="memname">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> <a class="el" href="vamp_8h.html#a2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td>
218 </tr> 245 </tr>
219 </table> 246 </table>
220 </div> 247 </div><div class="memdoc">
221 <div class="memdoc"> 248
222 249 </div>
223 </div> 250 </div>
224 </div> 251 <a id="a5f257e3f8b5ca1ca4c159d486e219078"></a>
225 <a class="anchor" id="a5f257e3f8b5ca1ca4c159d486e219078"></a> 252 <h2 class="memtitle"><span class="permalink"><a href="#a5f257e3f8b5ca1ca4c159d486e219078">&#9670;&nbsp;</a></span>VampFeatureList</h2>
253
226 <div class="memitem"> 254 <div class="memitem">
227 <div class="memproto"> 255 <div class="memproto">
228 <table class="memname"> 256 <table class="memname">
229 <tr> 257 <tr>
230 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> <a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td> 258 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> <a class="el" href="vamp_8h.html#a5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td>
231 </tr> 259 </tr>
232 </table> 260 </table>
233 </div> 261 </div><div class="memdoc">
234 <div class="memdoc"> 262
235 263 </div>
236 </div> 264 </div>
237 </div> 265 <a id="ad3be2952b1f4ad7d775940a6db75c79b"></a>
238 <a class="anchor" id="ad3be2952b1f4ad7d775940a6db75c79b"></a> 266 <h2 class="memtitle"><span class="permalink"><a href="#ad3be2952b1f4ad7d775940a6db75c79b">&#9670;&nbsp;</a></span>VampPluginHandle</h2>
267
239 <div class="memitem"> 268 <div class="memitem">
240 <div class="memproto"> 269 <div class="memproto">
241 <table class="memname"> 270 <table class="memname">
242 <tr> 271 <tr>
243 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td> 272 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td>
244 </tr> 273 </tr>
245 </table> 274 </table>
246 </div> 275 </div><div class="memdoc">
247 <div class="memdoc"> 276
248 277 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00246">246</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
249 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00246">246</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 278
250 279 </div>
251 </div> 280 </div>
252 </div> 281 <a id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a>
253 <a class="anchor" id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a> 282 <h2 class="memtitle"><span class="permalink"><a href="#aa1d6e0792099b9516a89b5fb7ed2ad2b">&#9670;&nbsp;</a></span>VampPluginDescriptor</h2>
283
254 <div class="memitem"> 284 <div class="memitem">
255 <div class="memproto"> 285 <div class="memproto">
256 <table class="memname"> 286 <table class="memname">
257 <tr> 287 <tr>
258 <td class="memname">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td> 288 <td class="memname">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td>
259 </tr> 289 </tr>
260 </table> 290 </table>
261 </div> 291 </div><div class="memdoc">
262 <div class="memdoc"> 292
263 293 </div>
264 </div> 294 </div>
265 </div> 295 <a id="afb59eb6e4ea5b47fc300435e98e8aa1b"></a>
266 <a class="anchor" id="a551bb7e0d8c970c2202be5f881817478"></a> 296 <h2 class="memtitle"><span class="permalink"><a href="#afb59eb6e4ea5b47fc300435e98e8aa1b">&#9670;&nbsp;</a></span>VampGetPluginDescriptorFunction</h2>
267 <div class="memitem"> 297
268 <div class="memproto"> 298 <div class="memitem">
269 <table class="memname"> 299 <div class="memproto">
270 <tr> 300 <table class="memname">
271 <td class="memname">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>*(* <a class="el" href="vamp_8h.html#a551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a>)(unsigned int, unsigned int)</td> 301 <tr>
272 </tr> 302 <td class="memname">typedef const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>*(* VampGetPluginDescriptorFunction) (unsigned int, unsigned int)</td>
273 </table> 303 </tr>
274 </div> 304 </table>
275 <div class="memdoc"> 305 </div><div class="memdoc">
276 306
277 <p>Function pointer type for vampGetPluginDescriptor. </p> 307 <p>Function pointer type for vampGetPluginDescriptor. </p>
278 308
279 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00382">382</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 309 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00382">382</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
280 310
281 </div> 311 </div>
282 </div> 312 </div>
283 <hr/><h2>Enumeration Type Documentation</h2> 313 <h2 class="groupheader">Enumeration Type Documentation</h2>
284 <a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821"></a> 314 <a id="aa24a8cee023d8b7659d25cbe0584b821"></a>
315 <h2 class="memtitle"><span class="permalink"><a href="#aa24a8cee023d8b7659d25cbe0584b821">&#9670;&nbsp;</a></span>VampSampleType</h2>
316
285 <div class="memitem"> 317 <div class="memitem">
286 <div class="memproto"> 318 <div class="memproto">
287 <table class="memname"> 319 <table class="memname">
288 <tr> 320 <tr>
289 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td> 321 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td>
290 </tr> 322 </tr>
291 </table> 323 </table>
292 </div> 324 </div><div class="memdoc">
293 <div class="memdoc"> 325 <table class="fieldtable">
294 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 326 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a>vampOneSamplePerStep&#160;</td><td class="fielddoc"><p>Each process call returns results aligned with call's block start. </p>
295 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a>vampOneSamplePerStep</em>&nbsp;</td><td>
296 <p>Each process call returns results aligned with call's block start. </p>
297 </td></tr> 327 </td></tr>
298 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a>vampFixedSampleRate</em>&nbsp;</td><td> 328 <tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a>vampFixedSampleRate&#160;</td><td class="fielddoc"><p>Returned results are evenly spaced at samplerate specified below. </p>
299 <p>Returned results are evenly spaced at samplerate specified below. </p>
300 </td></tr> 329 </td></tr>
301 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a>vampVariableSampleRate</em>&nbsp;</td><td> 330 <tr><td class="fieldname"><a id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a>vampVariableSampleRate&#160;</td><td class="fielddoc"><p>Returned results have their own individual timestamps. </p>
302 <p>Returned results have their own individual timestamps. </p>
303 </td></tr> 331 </td></tr>
304 </table> 332 </table>
305 </dd> 333
306 </dl> 334 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00105">105</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
307 335
308 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00105">105</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 336 </div>
309 337 </div>
310 </div> 338 <a id="ab107386a5f042feddf6446bea23bb765"></a>
311 </div> 339 <h2 class="memtitle"><span class="permalink"><a href="#ab107386a5f042feddf6446bea23bb765">&#9670;&nbsp;</a></span>VampInputDomain</h2>
312 <a class="anchor" id="ab107386a5f042feddf6446bea23bb765"></a> 340
313 <div class="memitem"> 341 <div class="memitem">
314 <div class="memproto"> 342 <div class="memproto">
315 <table class="memname"> 343 <table class="memname">
316 <tr> 344 <tr>
317 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td> 345 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td>
318 </tr> 346 </tr>
319 </table> 347 </table>
320 </div> 348 </div><div class="memdoc">
321 <div class="memdoc"> 349 <table class="fieldtable">
322 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 350 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a>vampTimeDomain&#160;</td><td class="fielddoc"></td></tr>
323 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a>vampTimeDomain</em>&nbsp;</td><td> 351 <tr><td class="fieldname"><a id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a>vampFrequencyDomain&#160;</td><td class="fielddoc"></td></tr>
324 </td></tr>
325 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a>vampFrequencyDomain</em>&nbsp;</td><td>
326 </td></tr>
327 </table> 352 </table>
328 </dd> 353
329 </dl> 354 <p class="definition">Definition at line <a class="el" href="vamp_8h_source.html#l00239">239</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
330 355
331 <p>Definition at line <a class="el" href="vamp_8h_source.html#l00239">239</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p> 356 </div>
332 357 </div>
333 </div> 358 <h2 class="groupheader">Function Documentation</h2>
334 </div> 359 <a id="a50cf6f17d0718f02093be6c7f63fcf30"></a>
335 <hr/><h2>Function Documentation</h2> 360 <h2 class="memtitle"><span class="permalink"><a href="#a50cf6f17d0718f02093be6c7f63fcf30">&#9670;&nbsp;</a></span>vampGetPluginDescriptor()</h2>
336 <a class="anchor" id="a50cf6f17d0718f02093be6c7f63fcf30"></a> 361
337 <div class="memitem"> 362 <div class="memitem">
338 <div class="memproto"> 363 <div class="memproto">
339 <table class="memname"> 364 <table class="memname">
340 <tr> 365 <tr>
341 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* <a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> </td> 366 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
342 <td>(</td> 367 <td>(</td>
343 <td class="paramtype">unsigned int&#160;</td> 368 <td class="paramtype">unsigned int&#160;</td>
344 <td class="paramname"><em>hostApiVersion</em>, </td> 369 <td class="paramname"><em>hostApiVersion</em>, </td>
345 </tr> 370 </tr>
346 <tr> 371 <tr>
353 <td></td> 378 <td></td>
354 <td>)</td> 379 <td>)</td>
355 <td></td><td></td> 380 <td></td><td></td>
356 </tr> 381 </tr>
357 </table> 382 </table>
358 </div> 383 </div><div class="memdoc">
359 <div class="memdoc">
360 384
361 <p>Get the descriptor for a given plugin index in this library. </p> 385 <p>Get the descriptor for a given plugin index in this library. </p>
362 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p> 386 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
363 <p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p> 387 <p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
364 <p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p> 388 <p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>
365 389
366 <p>Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p> 390 <p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>
367 391
368 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p> 392 <p class="reference">References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
369 393
370 </div> 394 </div>
371 </div> 395 </div>
372 </div><!-- contents --> 396 </div><!-- contents -->
373 </div> 397 </div><!-- doc-content -->
374 <div id="nav-path" class="navpath"> 398 <!-- start footer part -->
375 <ul> 399 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
376 <li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a> </li> 400 <ul>
377 401 <li class="navelem"><a class="el" href="dir_9c751ccb9387a8f0ae6ae8f777da02a0.html">vamp</a></li><li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a></li>
378 <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by 402 <li class="footer">Generated by
379 <a href="http://www.doxygen.org/index.html"> 403 <a href="http://www.doxygen.org/index.html">
380 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> 404 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
381 </ul> 405 </ul>
382 </div> 406 </div>
383
384
385 </body> 407 </body>
386 </html> 408 </html>