Mercurial > hg > vamp-docs

annotate code-docs/vamp_8h.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: vamp.h File Reference</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li class="current"><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="files.html"><span>File&#160;List</span></a></li>
Chris@1 56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
Chris@1 57 </ul>
Chris@1 58 </div>
Chris@1 59 </div>
Chris@1 60 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 61 <div id="nav-tree">
Chris@1 62 <div id="nav-tree-contents">
Chris@1 63 </div>
Chris@1 64 </div>
Chris@1 65 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 66 class="ui-resizable-handle">
Chris@1 67 </div>
Chris@1 68 </div>
Chris@1 69 <script type="text/javascript">
Chris@1 70 initNavTree('vamp_8h.html','');
Chris@1 71 </script>
Chris@1 72 <div id="doc-content">
Chris@1 73 <div class="header">
Chris@1 74 <div class="summary">
Chris@1 75 <a href="#nested-classes">Classes</a> &#124;
Chris@1 76 <a href="#define-members">Defines</a> &#124;
Chris@1 77 <a href="#typedef-members">Typedefs</a> &#124;
Chris@1 78 <a href="#enum-members">Enumerations</a> &#124;
Chris@1 79 <a href="#func-members">Functions</a> </div>
Chris@1 80 <div class="headertitle">
Chris@1 81 <div class="title">vamp.h File Reference</div> </div>
Chris@1 82 </div>
Chris@1 83 <div class="contents">
Chris@1 84
Chris@1 85 <p><a href="vamp_8h_source.html">Go to the source code of this file.</a></p>
Chris@1 86 <table class="memberdecls">
Chris@1 87 <tr><td colspan="2"><h2><a name="nested-classes"></a>
Chris@1 88 Classes</h2></td></tr>
Chris@1 89 <tr><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>
Chris@1 90 <tr><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>
Chris@1 91 <tr><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>
Chris@1 92 <tr><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>
Chris@1 93 <tr><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>
Chris@1 94 <tr><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>
Chris@1 95 <tr><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>
Chris@1 96 <tr><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>
Chris@1 97 <tr><td colspan="2"><h2><a name="define-members"></a>
Chris@1 98 Defines</h2></td></tr>
Chris@1 99 <tr><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>
Chris@1 100 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin API version. <a href="#a6d6c8c755dbabf161f72712e0e2143c7"></a><br/></td></tr>
Chris@1 101 <tr><td colspan="2"><h2><a name="typedef-members"></a>
Chris@1 102 Typedefs</h2></td></tr>
Chris@1 103 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
Chris@1 104 <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>
Chris@1 105 <tr><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>
Chris@1 106 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
Chris@1 107 <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>
Chris@1 108 <tr><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>
Chris@1 109 <tr><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>
Chris@1 110 <tr><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>
Chris@1 111 <tr><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>
Chris@1 112 <tr><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>
Chris@1 113 <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
Chris@1 114 <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>
Chris@1 115 <tr><td class="memItemLeft" align="right" valign="top">typedef const <br class="typebreak"/>
Chris@1 116 <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>
Chris@1 117 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#a551bb7e0d8c970c2202be5f881817478"></a><br/></td></tr>
Chris@1 118 <tr><td colspan="2"><h2><a name="enum-members"></a>
Chris@1 119 Enumerations</h2></td></tr>
Chris@1 120 <tr><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>,
Chris@1 121 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>,
Chris@1 122 <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a>
Chris@1 123 }</td></tr>
Chris@1 124 <tr><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>,
Chris@1 125 <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
Chris@1 126 }</td></tr>
Chris@1 127 <tr><td colspan="2"><h2><a name="func-members"></a>
Chris@1 128 Functions</h2></td></tr>
Chris@1 129 <tr><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>
Chris@1 130 <tr><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>
Chris@1 131 </table>
Chris@1 132 <hr/><h2>Define Documentation</h2>
Chris@1 133 <a class="anchor" id="a6d6c8c755dbabf161f72712e0e2143c7"></a><!-- doxytag: member="vamp.h::VAMP_API_VERSION" ref="a6d6c8c755dbabf161f72712e0e2143c7" args="" -->
Chris@1 134 <div class="memitem">
Chris@1 135 <div class="memproto">
Chris@1 136 <table class="memname">
Chris@1 137 <tr>
Chris@1 138 <td class="memname">#define VAMP_API_VERSION&#160;&#160;&#160;2</td>
Chris@1 139 </tr>
Chris@1 140 </table>
Chris@1 141 </div>
Chris@1 142 <div class="memdoc">
Chris@1 143
Chris@1 144 <p>Plugin API version. </p>
Chris@1 145 <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>
Chris@1 146 <p>See also the vampApiVersion field in the plugin descriptor, and the hostApiVersion argument to the vampGetPluginDescriptor function. </p>
Chris@1 147
Chris@1 148 <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>
Chris@1 149
Chris@1 150 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00137">main()</a>.</p>
Chris@1 151
Chris@1 152 </div>
Chris@1 153 </div>
Chris@1 154 <hr/><h2>Typedef Documentation</h2>
Chris@1 155 <a class="anchor" id="ae26a9d54a92f1c083a1b209a25a8e44e"></a><!-- doxytag: member="vamp.h::VampParameterDescriptor" ref="ae26a9d54a92f1c083a1b209a25a8e44e" args="" -->
Chris@1 156 <div class="memitem">
Chris@1 157 <div class="memproto">
Chris@1 158 <table class="memname">
Chris@1 159 <tr>
Chris@1 160 <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>
Chris@1 161 </tr>
Chris@1 162 </table>
Chris@1 163 </div>
Chris@1 164 <div class="memdoc">
Chris@1 165
Chris@1 166 <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
Chris@1 167 <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>
Chris@1 168 <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>
Chris@1 169
Chris@1 170 </div>
Chris@1 171 </div>
Chris@1 172 <a class="anchor" id="aa8429dd9c60d65800c58574c2b06bf66"></a><!-- doxytag: member="vamp.h::VampOutputDescriptor" ref="aa8429dd9c60d65800c58574c2b06bf66" args="" -->
Chris@1 173 <div class="memitem">
Chris@1 174 <div class="memproto">
Chris@1 175 <table class="memname">
Chris@1 176 <tr>
Chris@1 177 <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>
Chris@1 178 </tr>
Chris@1 179 </table>
Chris@1 180 </div>
Chris@1 181 <div class="memdoc">
Chris@1 182
Chris@1 183 </div>
Chris@1 184 </div>
Chris@1 185 <a class="anchor" id="a8d04355c13e5ff7a146abcb168cb919f"></a><!-- doxytag: member="vamp.h::VampFeature" ref="a8d04355c13e5ff7a146abcb168cb919f" args="" -->
Chris@1 186 <div class="memitem">
Chris@1 187 <div class="memproto">
Chris@1 188 <table class="memname">
Chris@1 189 <tr>
Chris@1 190 <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>
Chris@1 191 </tr>
Chris@1 192 </table>
Chris@1 193 </div>
Chris@1 194 <div class="memdoc">
Chris@1 195
Chris@1 196 </div>
Chris@1 197 </div>
Chris@1 198 <a class="anchor" id="a41cb3518127d0971b1d2c8edfbbe2763"></a><!-- doxytag: member="vamp.h::VampFeatureV2" ref="a41cb3518127d0971b1d2c8edfbbe2763" args="" -->
Chris@1 199 <div class="memitem">
Chris@1 200 <div class="memproto">
Chris@1 201 <table class="memname">
Chris@1 202 <tr>
Chris@1 203 <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>
Chris@1 204 </tr>
Chris@1 205 </table>
Chris@1 206 </div>
Chris@1 207 <div class="memdoc">
Chris@1 208
Chris@1 209 </div>
Chris@1 210 </div>
Chris@1 211 <a class="anchor" id="a2517349f1c97e0c59faab6085e092fcd"></a><!-- doxytag: member="vamp.h::VampFeatureUnion" ref="a2517349f1c97e0c59faab6085e092fcd" args="" -->
Chris@1 212 <div class="memitem">
Chris@1 213 <div class="memproto">
Chris@1 214 <table class="memname">
Chris@1 215 <tr>
Chris@1 216 <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>
Chris@1 217 </tr>
Chris@1 218 </table>
Chris@1 219 </div>
Chris@1 220 <div class="memdoc">
Chris@1 221
Chris@1 222 </div>
Chris@1 223 </div>
Chris@1 224 <a class="anchor" id="a5f257e3f8b5ca1ca4c159d486e219078"></a><!-- doxytag: member="vamp.h::VampFeatureList" ref="a5f257e3f8b5ca1ca4c159d486e219078" args="" -->
Chris@1 225 <div class="memitem">
Chris@1 226 <div class="memproto">
Chris@1 227 <table class="memname">
Chris@1 228 <tr>
Chris@1 229 <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>
Chris@1 230 </tr>
Chris@1 231 </table>
Chris@1 232 </div>
Chris@1 233 <div class="memdoc">
Chris@1 234
Chris@1 235 </div>
Chris@1 236 </div>
Chris@1 237 <a class="anchor" id="ad3be2952b1f4ad7d775940a6db75c79b"></a><!-- doxytag: member="vamp.h::VampPluginHandle" ref="ad3be2952b1f4ad7d775940a6db75c79b" args="" -->
Chris@1 238 <div class="memitem">
Chris@1 239 <div class="memproto">
Chris@1 240 <table class="memname">
Chris@1 241 <tr>
Chris@1 242 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#ad3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td>
Chris@1 243 </tr>
Chris@1 244 </table>
Chris@1 245 </div>
Chris@1 246 <div class="memdoc">
Chris@1 247
Chris@1 248 <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>
Chris@1 249
Chris@1 250 </div>
Chris@1 251 </div>
Chris@1 252 <a class="anchor" id="aa1d6e0792099b9516a89b5fb7ed2ad2b"></a><!-- doxytag: member="vamp.h::VampPluginDescriptor" ref="aa1d6e0792099b9516a89b5fb7ed2ad2b" args="" -->
Chris@1 253 <div class="memitem">
Chris@1 254 <div class="memproto">
Chris@1 255 <table class="memname">
Chris@1 256 <tr>
Chris@1 257 <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>
Chris@1 258 </tr>
Chris@1 259 </table>
Chris@1 260 </div>
Chris@1 261 <div class="memdoc">
Chris@1 262
Chris@1 263 </div>
Chris@1 264 </div>
Chris@1 265 <a class="anchor" id="a551bb7e0d8c970c2202be5f881817478"></a><!-- doxytag: member="vamp.h::VampGetPluginDescriptorFunction" ref="a551bb7e0d8c970c2202be5f881817478" args=")(unsigned int, unsigned int)" -->
Chris@1 266 <div class="memitem">
Chris@1 267 <div class="memproto">
Chris@1 268 <table class="memname">
Chris@1 269 <tr>
Chris@1 270 <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>
Chris@1 271 </tr>
Chris@1 272 </table>
Chris@1 273 </div>
Chris@1 274 <div class="memdoc">
Chris@1 275
Chris@1 276 <p>Function pointer type for vampGetPluginDescriptor. </p>
Chris@1 277
Chris@1 278 <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>
Chris@1 279
Chris@1 280 </div>
Chris@1 281 </div>
Chris@1 282 <hr/><h2>Enumeration Type Documentation</h2>
Chris@1 283 <a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821"></a><!-- doxytag: member="vamp.h::VampSampleType" ref="aa24a8cee023d8b7659d25cbe0584b821" args="" -->
Chris@1 284 <div class="memitem">
Chris@1 285 <div class="memproto">
Chris@1 286 <table class="memname">
Chris@1 287 <tr>
Chris@1 288 <td class="memname">enum <a class="el" href="vamp_8h.html#aa24a8cee023d8b7659d25cbe0584b821">VampSampleType</a></td>
Chris@1 289 </tr>
Chris@1 290 </table>
Chris@1 291 </div>
Chris@1 292 <div class="memdoc">
Chris@1 293 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@1 294 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113"></a><!-- doxytag: member="vampOneSamplePerStep" ref="aa24a8cee023d8b7659d25cbe0584b821ab546deafd57f175fb1e7f9cbea1c5113" args="" -->vampOneSamplePerStep</em>&nbsp;</td><td>
Chris@1 295 <p>Each process call returns results aligned with call's block start. </p>
Chris@1 296 </td></tr>
Chris@1 297 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8"></a><!-- doxytag: member="vampFixedSampleRate" ref="aa24a8cee023d8b7659d25cbe0584b821aafc8a05f722bc83ecce227e12e838cf8" args="" -->vampFixedSampleRate</em>&nbsp;</td><td>
Chris@1 298 <p>Returned results are evenly spaced at samplerate specified below. </p>
Chris@1 299 </td></tr>
Chris@1 300 <tr><td valign="top"><em><a class="anchor" id="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8"></a><!-- doxytag: member="vampVariableSampleRate" ref="aa24a8cee023d8b7659d25cbe0584b821abae8a21a9e30eb73e16d6abc6c7415e8" args="" -->vampVariableSampleRate</em>&nbsp;</td><td>
Chris@1 301 <p>Returned results have their own individual timestamps. </p>
Chris@1 302 </td></tr>
Chris@1 303 </table>
Chris@1 304 </dd>
Chris@1 305 </dl>
Chris@1 306
Chris@1 307 <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>
Chris@1 308
Chris@1 309 </div>
Chris@1 310 </div>
Chris@1 311 <a class="anchor" id="ab107386a5f042feddf6446bea23bb765"></a><!-- doxytag: member="vamp.h::VampInputDomain" ref="ab107386a5f042feddf6446bea23bb765" args="" -->
Chris@1 312 <div class="memitem">
Chris@1 313 <div class="memproto">
Chris@1 314 <table class="memname">
Chris@1 315 <tr>
Chris@1 316 <td class="memname">enum <a class="el" href="vamp_8h.html#ab107386a5f042feddf6446bea23bb765">VampInputDomain</a></td>
Chris@1 317 </tr>
Chris@1 318 </table>
Chris@1 319 </div>
Chris@1 320 <div class="memdoc">
Chris@1 321 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
Chris@1 322 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1"></a><!-- doxytag: member="vampTimeDomain" ref="ab107386a5f042feddf6446bea23bb765ae3dbb77ff3e8f292966fd3748888e1a1" args="" -->vampTimeDomain</em>&nbsp;</td><td>
Chris@1 323 </td></tr>
Chris@1 324 <tr><td valign="top"><em><a class="anchor" id="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d"></a><!-- doxytag: member="vampFrequencyDomain" ref="ab107386a5f042feddf6446bea23bb765aee0c1c0d429276f071b8c0730b7bd87d" args="" -->vampFrequencyDomain</em>&nbsp;</td><td>
Chris@1 325 </td></tr>
Chris@1 326 </table>
Chris@1 327 </dd>
Chris@1 328 </dl>
Chris@1 329
Chris@1 330 <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>
Chris@1 331
Chris@1 332 </div>
Chris@1 333 </div>
Chris@1 334 <hr/><h2>Function Documentation</h2>
Chris@1 335 <a class="anchor" id="a50cf6f17d0718f02093be6c7f63fcf30"></a><!-- doxytag: member="vamp.h::vampGetPluginDescriptor" ref="a50cf6f17d0718f02093be6c7f63fcf30" args="(unsigned int hostApiVersion, unsigned int index)" -->
Chris@1 336 <div class="memitem">
Chris@1 337 <div class="memproto">
Chris@1 338 <table class="memname">
Chris@1 339 <tr>
Chris@1 340 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
Chris@1 341 <td>(</td>
Chris@1 342 <td class="paramtype">unsigned int&#160;</td>
Chris@1 343 <td class="paramname"><em>hostApiVersion</em>, </td>
Chris@1 344 </tr>
Chris@1 345 <tr>
Chris@1 346 <td class="paramkey"></td>
Chris@1 347 <td></td>
Chris@1 348 <td class="paramtype">unsigned int&#160;</td>
Chris@1 349 <td class="paramname"><em>index</em>&#160;</td>
Chris@1 350 </tr>
Chris@1 351 <tr>
Chris@1 352 <td></td>
Chris@1 353 <td>)</td>
Chris@1 354 <td></td><td></td>
Chris@1 355 </tr>
Chris@1 356 </table>
Chris@1 357 </div>
Chris@1 358 <div class="memdoc">
Chris@1 359
Chris@1 360 <p>Get the descriptor for a given plugin index in this library. </p>
Chris@1 361 <p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
Chris@1 362 <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>
Chris@1 363 <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>
Chris@1 364
Chris@1 365 <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>
Chris@1 366
Chris@1 367 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
Chris@1 368
Chris@1 369 </div>
Chris@1 370 </div>
Chris@1 371 </div>
Chris@1 372 </div>
Chris@1 373 <div id="nav-path" class="navpath">
Chris@1 374 <ul>
Chris@1 375 <li class="navelem"><a class="el" href="vamp_8h.html">vamp.h</a> </li>
Chris@1 376
Chris@1 377 <li class="footer">Generated on Tue Oct 4 2011 14:38:50 for VampPluginSDK by
Chris@1 378 <a href="http://www.doxygen.org/index.html">
Chris@1 379 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 380 </ul>
Chris@1 381 </div>
Chris@1 382
Chris@1 383
Chris@1 384 </body>
Chris@1 385 </html>