Mercurial > hg > vamp-website

annotate code-doc/vamp_8h.html @ 34:4b4db9230e94 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* wiki configuration and pages in svn
author cannam
date Wed, 23 Sep 2009 15:09:53 +0000
parents cc0be37dc9d3
children 0976232e353b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: vamp.h File Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@21 7 <!-- Generated by Doxygen 1.5.6 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li class="current"><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="navpath"><a class="el" href="dir_b086eb10f854304ab96fb3af468374a7.html">vamp</a>
cannam@0 19 </div>
cannam@0 20 </div>
cannam@0 21 <div class="contents">
cannam@0 22 <h1>vamp.h File Reference</h1>
cannam@0 23 <p>
cannam@0 24
cannam@0 25 <p>
cannam@0 26 <a href="vamp_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 27 <tr><td></td></tr>
cannam@0 28 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
cannam@0 29 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a></td></tr>
cannam@0 30
cannam@21 31 <tr><td class="mdescLeft">&nbsp;</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>
cannam@0 32 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a></td></tr>
cannam@0 33
cannam@0 34 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeature.html">_VampFeature</a></td></tr>
cannam@0 35
cannam@21 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a></td></tr>
cannam@21 37
cannam@21 38 <tr><td class="memItemLeft" nowrap align="right" valign="top">union &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a></td></tr>
cannam@21 39
cannam@0 40 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a></td></tr>
cannam@0 41
cannam@0 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a></td></tr>
cannam@0 43
cannam@0 44 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
cannam@21 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#6d6c8c755dbabf161f72712e0e2143c7">VAMP_API_VERSION</a>&nbsp;&nbsp;&nbsp;2</td></tr>
cannam@0 46
cannam@0 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Plugin API version. <a href="#6d6c8c755dbabf161f72712e0e2143c7"></a><br></td></tr>
cannam@0 48 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
cannam@0 49 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
cannam@0 50 <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#e26a9d54a92f1c083a1b209a25a8e44e">VampParameterDescriptor</a></td></tr>
cannam@0 51
cannam@21 52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="#e26a9d54a92f1c083a1b209a25a8e44e"></a><br></td></tr>
cannam@0 53 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
cannam@0 54 <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a8429dd9c60d65800c58574c2b06bf66">VampOutputDescriptor</a></td></tr>
cannam@0 55
cannam@0 56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#8d04355c13e5ff7a146abcb168cb919f">VampFeature</a></td></tr>
cannam@0 57
cannam@21 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#41cb3518127d0971b1d2c8edfbbe2763">VampFeatureV2</a></td></tr>
cannam@21 59
cannam@21 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#2517349f1c97e0c59faab6085e092fcd">VampFeatureUnion</a></td></tr>
cannam@21 61
cannam@0 62 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#5f257e3f8b5ca1ca4c159d486e219078">VampFeatureList</a></td></tr>
cannam@0 63
cannam@0 64 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a></td></tr>
cannam@0 65
cannam@0 66 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
cannam@0 67 <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a></td></tr>
cannam@0 68
cannam@0 69 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef const <br>
cannam@0 70 <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a> )(unsigned int, unsigned int)</td></tr>
cannam@0 71
cannam@0 72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function pointer type for vampGetPluginDescriptor. <a href="#551bb7e0d8c970c2202be5f881817478"></a><br></td></tr>
cannam@0 73 <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
cannam@0 74 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> { <a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821b546deafd57f175fb1e7f9cbea1c5113">vampOneSamplePerStep</a>,
cannam@0 75 <a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821afc8a05f722bc83ecce227e12e838cf8">vampFixedSampleRate</a>,
cannam@0 76 <a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821bae8a21a9e30eb73e16d6abc6c7415e8">vampVariableSampleRate</a>
cannam@0 77 }</td></tr>
cannam@0 78
cannam@0 79 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> { <a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1">vampTimeDomain</a>,
cannam@0 80 <a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d">vampFrequencyDomain</a>
cannam@0 81 }</td></tr>
cannam@0 82
cannam@0 83 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
cannam@0 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="vamp_8h.html#50cf6f17d0718f02093be6c7f63fcf30">vampGetPluginDescriptor</a> (unsigned int hostApiVersion, unsigned int index)</td></tr>
cannam@0 85
cannam@0 86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library. <a href="#50cf6f17d0718f02093be6c7f63fcf30"></a><br></td></tr>
cannam@0 87 </table>
cannam@0 88 <hr><h2>Define Documentation</h2>
cannam@0 89 <a class="anchor" name="6d6c8c755dbabf161f72712e0e2143c7"></a><!-- doxytag: member="vamp.h::VAMP_API_VERSION" ref="6d6c8c755dbabf161f72712e0e2143c7" args="" -->
cannam@0 90 <div class="memitem">
cannam@0 91 <div class="memproto">
cannam@0 92 <table class="memname">
cannam@0 93 <tr>
cannam@21 94 <td class="memname">#define VAMP_API_VERSION&nbsp;&nbsp;&nbsp;2 </td>
cannam@0 95 </tr>
cannam@0 96 </table>
cannam@0 97 </div>
cannam@0 98 <div class="memdoc">
cannam@0 99
cannam@0 100 <p>
cannam@0 101 Plugin API version.
cannam@0 102 <p>
cannam@0 103 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>
cannam@0 104 See also the vampApiVersion field in the plugin descriptor, and the hostApiVersion argument to the vampGetPluginDescriptor function.
cannam@0 105 <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>
cannam@0 106
cannam@21 107 <p>Referenced by <a class="el" href="vamp-simple-host_8cpp-source.html#l00137">main()</a>.</p>
cannam@0 108
cannam@0 109 </div>
cannam@0 110 </div><p>
cannam@0 111 <hr><h2>Typedef Documentation</h2>
cannam@0 112 <a class="anchor" name="e26a9d54a92f1c083a1b209a25a8e44e"></a><!-- doxytag: member="vamp.h::VampParameterDescriptor" ref="e26a9d54a92f1c083a1b209a25a8e44e" args="" -->
cannam@0 113 <div class="memitem">
cannam@0 114 <div class="memproto">
cannam@0 115 <table class="memname">
cannam@0 116 <tr>
cannam@0 117 <td class="memname">typedef struct <a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a> <a class="el" href="struct__VampParameterDescriptor.html">VampParameterDescriptor</a> </td>
cannam@0 118 </tr>
cannam@0 119 </table>
cannam@0 120 </div>
cannam@0 121 <div class="memdoc">
cannam@0 122
cannam@0 123 <p>
cannam@21 124 C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.
cannam@21 125 <p>
cannam@21 126 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>
cannam@21 127 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.
cannam@0 128 </div>
cannam@0 129 </div><p>
cannam@0 130 <a class="anchor" name="a8429dd9c60d65800c58574c2b06bf66"></a><!-- doxytag: member="vamp.h::VampOutputDescriptor" ref="a8429dd9c60d65800c58574c2b06bf66" args="" -->
cannam@0 131 <div class="memitem">
cannam@0 132 <div class="memproto">
cannam@0 133 <table class="memname">
cannam@0 134 <tr>
cannam@0 135 <td class="memname">typedef struct <a class="el" href="struct__VampOutputDescriptor.html">_VampOutputDescriptor</a> <a class="el" href="struct__VampOutputDescriptor.html">VampOutputDescriptor</a> </td>
cannam@0 136 </tr>
cannam@0 137 </table>
cannam@0 138 </div>
cannam@0 139 <div class="memdoc">
cannam@0 140
cannam@0 141 <p>
cannam@0 142
cannam@0 143 </div>
cannam@0 144 </div><p>
cannam@0 145 <a class="anchor" name="8d04355c13e5ff7a146abcb168cb919f"></a><!-- doxytag: member="vamp.h::VampFeature" ref="8d04355c13e5ff7a146abcb168cb919f" args="" -->
cannam@0 146 <div class="memitem">
cannam@0 147 <div class="memproto">
cannam@0 148 <table class="memname">
cannam@0 149 <tr>
cannam@0 150 <td class="memname">typedef struct <a class="el" href="struct__VampFeature.html">_VampFeature</a> <a class="el" href="struct__VampFeature.html">VampFeature</a> </td>
cannam@0 151 </tr>
cannam@0 152 </table>
cannam@0 153 </div>
cannam@0 154 <div class="memdoc">
cannam@0 155
cannam@0 156 <p>
cannam@0 157
cannam@0 158 </div>
cannam@0 159 </div><p>
cannam@21 160 <a class="anchor" name="41cb3518127d0971b1d2c8edfbbe2763"></a><!-- doxytag: member="vamp.h::VampFeatureV2" ref="41cb3518127d0971b1d2c8edfbbe2763" args="" -->
cannam@21 161 <div class="memitem">
cannam@21 162 <div class="memproto">
cannam@21 163 <table class="memname">
cannam@21 164 <tr>
cannam@21 165 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureV2.html">_VampFeatureV2</a> <a class="el" href="struct__VampFeatureV2.html">VampFeatureV2</a> </td>
cannam@21 166 </tr>
cannam@21 167 </table>
cannam@21 168 </div>
cannam@21 169 <div class="memdoc">
cannam@21 170
cannam@21 171 <p>
cannam@21 172
cannam@21 173 </div>
cannam@21 174 </div><p>
cannam@21 175 <a class="anchor" name="2517349f1c97e0c59faab6085e092fcd"></a><!-- doxytag: member="vamp.h::VampFeatureUnion" ref="2517349f1c97e0c59faab6085e092fcd" args="" -->
cannam@21 176 <div class="memitem">
cannam@21 177 <div class="memproto">
cannam@21 178 <table class="memname">
cannam@21 179 <tr>
cannam@21 180 <td class="memname">typedef union <a class="el" href="union__VampFeatureUnion.html">_VampFeatureUnion</a> <a class="el" href="union__VampFeatureUnion.html">VampFeatureUnion</a> </td>
cannam@21 181 </tr>
cannam@21 182 </table>
cannam@21 183 </div>
cannam@21 184 <div class="memdoc">
cannam@21 185
cannam@21 186 <p>
cannam@21 187
cannam@21 188 </div>
cannam@21 189 </div><p>
cannam@0 190 <a class="anchor" name="5f257e3f8b5ca1ca4c159d486e219078"></a><!-- doxytag: member="vamp.h::VampFeatureList" ref="5f257e3f8b5ca1ca4c159d486e219078" args="" -->
cannam@0 191 <div class="memitem">
cannam@0 192 <div class="memproto">
cannam@0 193 <table class="memname">
cannam@0 194 <tr>
cannam@0 195 <td class="memname">typedef struct <a class="el" href="struct__VampFeatureList.html">_VampFeatureList</a> <a class="el" href="struct__VampFeatureList.html">VampFeatureList</a> </td>
cannam@0 196 </tr>
cannam@0 197 </table>
cannam@0 198 </div>
cannam@0 199 <div class="memdoc">
cannam@0 200
cannam@0 201 <p>
cannam@0 202
cannam@0 203 </div>
cannam@0 204 </div><p>
cannam@0 205 <a class="anchor" name="d3be2952b1f4ad7d775940a6db75c79b"></a><!-- doxytag: member="vamp.h::VampPluginHandle" ref="d3be2952b1f4ad7d775940a6db75c79b" args="" -->
cannam@0 206 <div class="memitem">
cannam@0 207 <div class="memproto">
cannam@0 208 <table class="memname">
cannam@0 209 <tr>
cannam@0 210 <td class="memname">typedef void* <a class="el" href="vamp_8h.html#d3be2952b1f4ad7d775940a6db75c79b">VampPluginHandle</a> </td>
cannam@0 211 </tr>
cannam@0 212 </table>
cannam@0 213 </div>
cannam@0 214 <div class="memdoc">
cannam@0 215
cannam@0 216 <p>
cannam@0 217
cannam@21 218 <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>
cannam@0 219
cannam@0 220 </div>
cannam@0 221 </div><p>
cannam@0 222 <a class="anchor" name="a1d6e0792099b9516a89b5fb7ed2ad2b"></a><!-- doxytag: member="vamp.h::VampPluginDescriptor" ref="a1d6e0792099b9516a89b5fb7ed2ad2b" args="" -->
cannam@0 223 <div class="memitem">
cannam@0 224 <div class="memproto">
cannam@0 225 <table class="memname">
cannam@0 226 <tr>
cannam@0 227 <td class="memname">typedef struct <a class="el" href="struct__VampPluginDescriptor.html">_VampPluginDescriptor</a> <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a> </td>
cannam@0 228 </tr>
cannam@0 229 </table>
cannam@0 230 </div>
cannam@0 231 <div class="memdoc">
cannam@0 232
cannam@0 233 <p>
cannam@0 234
cannam@0 235 </div>
cannam@0 236 </div><p>
cannam@0 237 <a class="anchor" name="551bb7e0d8c970c2202be5f881817478"></a><!-- doxytag: member="vamp.h::VampGetPluginDescriptorFunction" ref="551bb7e0d8c970c2202be5f881817478" args=")(unsigned int, unsigned int)" -->
cannam@0 238 <div class="memitem">
cannam@0 239 <div class="memproto">
cannam@0 240 <table class="memname">
cannam@0 241 <tr>
cannam@0 242 <td class="memname">typedef const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>*(* <a class="el" href="vamp_8h.html#551bb7e0d8c970c2202be5f881817478">VampGetPluginDescriptorFunction</a>)(unsigned int, unsigned int) </td>
cannam@0 243 </tr>
cannam@0 244 </table>
cannam@0 245 </div>
cannam@0 246 <div class="memdoc">
cannam@0 247
cannam@0 248 <p>
cannam@0 249 Function pointer type for vampGetPluginDescriptor.
cannam@0 250 <p>
cannam@0 251
cannam@21 252 <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>
cannam@0 253
cannam@0 254 </div>
cannam@0 255 </div><p>
cannam@0 256 <hr><h2>Enumeration Type Documentation</h2>
cannam@0 257 <a class="anchor" name="a24a8cee023d8b7659d25cbe0584b821"></a><!-- doxytag: member="vamp.h::VampSampleType" ref="a24a8cee023d8b7659d25cbe0584b821" args="" -->
cannam@0 258 <div class="memitem">
cannam@0 259 <div class="memproto">
cannam@0 260 <table class="memname">
cannam@0 261 <tr>
cannam@0 262 <td class="memname">enum <a class="el" href="vamp_8h.html#a24a8cee023d8b7659d25cbe0584b821">VampSampleType</a> </td>
cannam@0 263 </tr>
cannam@0 264 </table>
cannam@0 265 </div>
cannam@0 266 <div class="memdoc">
cannam@0 267
cannam@0 268 <p>
cannam@0 269 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 270 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 271 <tr><td valign="top"><em><a class="anchor" name="a24a8cee023d8b7659d25cbe0584b821b546deafd57f175fb1e7f9cbea1c5113"></a><!-- doxytag: member="vampOneSamplePerStep" ref="a24a8cee023d8b7659d25cbe0584b821b546deafd57f175fb1e7f9cbea1c5113" args="" -->vampOneSamplePerStep</em>&nbsp;</td><td>
cannam@0 272 Each process call returns results aligned with call's block start.
cannam@0 273 <p>
cannam@0 274 </td></tr>
cannam@0 275 <tr><td valign="top"><em><a class="anchor" name="a24a8cee023d8b7659d25cbe0584b821afc8a05f722bc83ecce227e12e838cf8"></a><!-- doxytag: member="vampFixedSampleRate" ref="a24a8cee023d8b7659d25cbe0584b821afc8a05f722bc83ecce227e12e838cf8" args="" -->vampFixedSampleRate</em>&nbsp;</td><td>
cannam@0 276 Returned results are evenly spaced at samplerate specified below.
cannam@0 277 <p>
cannam@0 278 </td></tr>
cannam@0 279 <tr><td valign="top"><em><a class="anchor" name="a24a8cee023d8b7659d25cbe0584b821bae8a21a9e30eb73e16d6abc6c7415e8"></a><!-- doxytag: member="vampVariableSampleRate" ref="a24a8cee023d8b7659d25cbe0584b821bae8a21a9e30eb73e16d6abc6c7415e8" args="" -->vampVariableSampleRate</em>&nbsp;</td><td>
cannam@0 280 Returned results have their own individual timestamps.
cannam@0 281 <p>
cannam@0 282 </td></tr>
cannam@0 283 </table>
cannam@0 284 </dl>
cannam@0 285
cannam@0 286 <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>
cannam@0 287
cannam@0 288 </div>
cannam@0 289 </div><p>
cannam@0 290 <a class="anchor" name="b107386a5f042feddf6446bea23bb765"></a><!-- doxytag: member="vamp.h::VampInputDomain" ref="b107386a5f042feddf6446bea23bb765" args="" -->
cannam@0 291 <div class="memitem">
cannam@0 292 <div class="memproto">
cannam@0 293 <table class="memname">
cannam@0 294 <tr>
cannam@0 295 <td class="memname">enum <a class="el" href="vamp_8h.html#b107386a5f042feddf6446bea23bb765">VampInputDomain</a> </td>
cannam@0 296 </tr>
cannam@0 297 </table>
cannam@0 298 </div>
cannam@0 299 <div class="memdoc">
cannam@0 300
cannam@0 301 <p>
cannam@0 302 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 303 <table border="0" cellspacing="2" cellpadding="0">
cannam@0 304 <tr><td valign="top"><em><a class="anchor" name="b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1"></a><!-- doxytag: member="vampTimeDomain" ref="b107386a5f042feddf6446bea23bb765e3dbb77ff3e8f292966fd3748888e1a1" args="" -->vampTimeDomain</em>&nbsp;</td><td>
cannam@0 305 </td></tr>
cannam@0 306 <tr><td valign="top"><em><a class="anchor" name="b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d"></a><!-- doxytag: member="vampFrequencyDomain" ref="b107386a5f042feddf6446bea23bb765ee0c1c0d429276f071b8c0730b7bd87d" args="" -->vampFrequencyDomain</em>&nbsp;</td><td>
cannam@0 307 </td></tr>
cannam@0 308 </table>
cannam@0 309 </dl>
cannam@0 310
cannam@21 311 <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>
cannam@0 312
cannam@0 313 </div>
cannam@0 314 </div><p>
cannam@0 315 <hr><h2>Function Documentation</h2>
cannam@0 316 <a class="anchor" name="50cf6f17d0718f02093be6c7f63fcf30"></a><!-- doxytag: member="vamp.h::vampGetPluginDescriptor" ref="50cf6f17d0718f02093be6c7f63fcf30" args="(unsigned int hostApiVersion, unsigned int index)" -->
cannam@0 317 <div class="memitem">
cannam@0 318 <div class="memproto">
cannam@0 319 <table class="memname">
cannam@0 320 <tr>
cannam@0 321 <td class="memname">const <a class="el" href="struct__VampPluginDescriptor.html">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
cannam@0 322 <td>(</td>
cannam@0 323 <td class="paramtype">unsigned int&nbsp;</td>
cannam@0 324 <td class="paramname"> <em>hostApiVersion</em>, </td>
cannam@0 325 </tr>
cannam@0 326 <tr>
cannam@0 327 <td class="paramkey"></td>
cannam@0 328 <td></td>
cannam@0 329 <td class="paramtype">unsigned int&nbsp;</td>
cannam@0 330 <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
cannam@0 331 </tr>
cannam@0 332 <tr>
cannam@0 333 <td></td>
cannam@0 334 <td>)</td>
cannam@21 335 <td></td><td></td><td></td>
cannam@0 336 </tr>
cannam@0 337 </table>
cannam@0 338 </div>
cannam@0 339 <div class="memdoc">
cannam@0 340
cannam@0 341 <p>
cannam@0 342 Get the descriptor for a given plugin index in this library.
cannam@0 343 <p>
cannam@0 344 Return NULL if the index is outside the range of valid indices for this plugin library.<p>
cannam@21 345 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>
cannam@21 346 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.
cannam@21 347 <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>
cannam@0 348
cannam@21 349 <p>References <a class="el" href="classVamp_1_1PluginAdapterBase.html#d24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>
cannam@0 350
cannam@0 351 </div>
cannam@0 352 </div><p>
cannam@0 353 </div>
cannam@21 354 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 2008 for VampPluginSDK by&nbsp;
cannam@0 355 <a href="http://www.doxygen.org/index.html">
cannam@21 356 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
cannam@0 357 </body>
cannam@0 358 </html>