Mercurial > hg > vamp-docs

comparison code-docs/host-c_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
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">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
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"/>
8 <title>VampPluginSDK: host-c.h File Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="resize.js"></script>
14 <script type="text/javascript" src="navtreedata.js"></script>
15 <script type="text/javascript" src="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
18 </script>
19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
20 </head>
21 <body>
22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27 <td id="projectalign" style="padding-left: 0.5em;">
28 <div id="projectname">VampPluginSDK
29 &#160;<span id="projectnumber">2.7</span>
30 </div>
31 </td>
32 </tr>
33 </tbody>
34 </table>
35 </div>
36 <!-- end header part -->
37 <!-- Generated by Doxygen 1.8.13 -->
38 <script type="text/javascript" src="menudata.js"></script>
39 <script type="text/javascript" src="menu.js"></script>
40 <script type="text/javascript">
41 $(function() {
42 initMenu('',false,false,'search.php','Search');
43 });
44 </script>
45 <div id="main-nav"></div>
46 </div><!-- top -->
47 <div id="side-nav" class="ui-resizable side-nav-resizable">
48 <div id="nav-tree">
49 <div id="nav-tree-contents">
50 <div id="nav-sync" class="sync"></div>
51 </div>
52 </div>
53 <div id="splitbar" style="-moz-user-select:none;"
54 class="ui-resizable-handle">
55 </div>
56 </div>
57 <script type="text/javascript">
58 $(document).ready(function(){initNavTree('host-c_8h.html','');});
59 </script>
60 <div id="doc-content">
61 <div class="header">
62 <div class="summary">
63 <a href="#typedef-members">Typedefs</a> &#124;
64 <a href="#func-members">Functions</a> </div>
65 <div class="headertitle">
66 <div class="title">host-c.h File Reference</div> </div>
67 </div><!--header-->
68 <div class="contents">
69 <div class="textblock"><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp/vamp.h</a>&gt;</code><br />
70 </div><div class="textblock"><div class="dynheader">
71 Include dependency graph for host-c.h:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="host-c_8h__incl.png" border="0" usemap="#host-c_8h" alt=""/></div>
74 <map name="host-c_8h" id="host-c_8h">
75 <area shape="rect" id="node2" href="vamp_8h.html" title="vamp/vamp.h" alt="" coords="5,79,104,104"/>
76 </map>
77 </div>
78 </div>
79 <p><a href="host-c_8h_source.html">Go to the source code of this file.</a></p>
80 <table class="memberdecls">
81 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
82 Typedefs</h2></td></tr>
83 <tr class="memitem:a0d6585882923f575e76bd0a6835e9748"><td class="memItemLeft" align="right" valign="top">typedef struct vhLibrary_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a></td></tr>
84 <tr class="separator:a0d6585882923f575e76bd0a6835e9748"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 </table><table class="memberdecls">
86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
87 Functions</h2></td></tr>
88 <tr class="memitem:a63420c2f047538e88f88f76cf8f22a43"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43">vhGetLibraryCount</a> ()</td></tr>
89 <tr class="memdesc:a63420c2f047538e88f88f76cf8f22a43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries discovered in the installation path. <a href="#a63420c2f047538e88f88f76cf8f22a43">More...</a><br /></td></tr>
90 <tr class="separator:a63420c2f047538e88f88f76cf8f22a43"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:afdaa93128f4c785fc4c022bc8ecd840a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#afdaa93128f4c785fc4c022bc8ecd840a">vhGetLibraryName</a> (int library)</td></tr>
92 <tr class="memdesc:afdaa93128f4c785fc4c022bc8ecd840a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the library name (base soname) of the library with the given index, in the range 0..(<a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43" title="Return the number of Vamp plugin libraries discovered in the installation path. ">vhGetLibraryCount()</a>-1). <a href="#afdaa93128f4c785fc4c022bc8ecd840a">More...</a><br /></td></tr>
93 <tr class="separator:afdaa93128f4c785fc4c022bc8ecd840a"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#ac1e2a1b3c3f1c3019bee99140b4a1551">vhGetLibraryIndex</a> (const char *name)</td></tr>
95 <tr class="memdesc:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the library index for the given library name, or -1 if the name is not known. <a href="#ac1e2a1b3c3f1c3019bee99140b4a1551">More...</a><br /></td></tr>
96 <tr class="separator:ac1e2a1b3c3f1c3019bee99140b4a1551"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:ae93710ce0c0d9d99ca798fffa7517929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#ae93710ce0c0d9d99ca798fffa7517929">vhLoadLibrary</a> (int library)</td></tr>
98 <tr class="memdesc:ae93710ce0c0d9d99ca798fffa7517929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load the library with the given index. <a href="#ae93710ce0c0d9d99ca798fffa7517929">More...</a><br /></td></tr>
99 <tr class="separator:ae93710ce0c0d9d99ca798fffa7517929"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:af23b8bddcbf13f9d15f87a15d698de0b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#af23b8bddcbf13f9d15f87a15d698de0b">vhGetPluginCount</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> library)</td></tr>
101 <tr class="memdesc:af23b8bddcbf13f9d15f87a15d698de0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugins in the given library. <a href="#af23b8bddcbf13f9d15f87a15d698de0b">More...</a><br /></td></tr>
102 <tr class="separator:af23b8bddcbf13f9d15f87a15d698de0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <tr class="memitem:a7d85254dce15986f87829d1c6e7b8d00"><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="host-c_8h.html#a7d85254dce15986f87829d1c6e7b8d00">vhGetPluginDescriptor</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> library, int plugin)</td></tr>
104 <tr class="memdesc:a7d85254dce15986f87829d1c6e7b8d00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <a class="el" href="namespaceVamp.html">Vamp</a> plugin descriptor for a plugin in a given library. <a href="#a7d85254dce15986f87829d1c6e7b8d00">More...</a><br /></td></tr>
105 <tr class="separator:a7d85254dce15986f87829d1c6e7b8d00"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a4ec9d6f7408267d7567d9b2435807840"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="host-c_8h.html#a4ec9d6f7408267d7567d9b2435807840">vhUnloadLibrary</a> (<a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>)</td></tr>
107 <tr class="memdesc:a4ec9d6f7408267d7567d9b2435807840"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unload a plugin library. <a href="#a4ec9d6f7408267d7567d9b2435807840">More...</a><br /></td></tr>
108 <tr class="separator:a4ec9d6f7408267d7567d9b2435807840"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 </table>
110 <h2 class="groupheader">Typedef Documentation</h2>
111 <a id="a0d6585882923f575e76bd0a6835e9748"></a>
112 <h2 class="memtitle"><span class="permalink"><a href="#a0d6585882923f575e76bd0a6835e9748">&#9670;&nbsp;</a></span>vhLibrary</h2>
113
114 <div class="memitem">
115 <div class="memproto">
116 <table class="memname">
117 <tr>
118 <td class="memname">typedef struct vhLibrary_t* <a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a></td>
119 </tr>
120 </table>
121 </div><div class="memdoc">
122
123 <p class="definition">Definition at line <a class="el" href="host-c_8h_source.html#l00094">94</a> of file <a class="el" href="host-c_8h_source.html">host-c.h</a>.</p>
124
125 </div>
126 </div>
127 <h2 class="groupheader">Function Documentation</h2>
128 <a id="a63420c2f047538e88f88f76cf8f22a43"></a>
129 <h2 class="memtitle"><span class="permalink"><a href="#a63420c2f047538e88f88f76cf8f22a43">&#9670;&nbsp;</a></span>vhGetLibraryCount()</h2>
130
131 <div class="memitem">
132 <div class="memproto">
133 <table class="memname">
134 <tr>
135 <td class="memname">int vhGetLibraryCount </td>
136 <td>(</td>
137 <td class="paramname"></td><td>)</td>
138 <td></td>
139 </tr>
140 </table>
141 </div><div class="memdoc">
142
143 <p>Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugin libraries discovered in the installation path. </p>
144 <p>This number will remain fixed after the first call &ndash; plugins are only discovered once, the first time this function is called. </p>
145
146 </div>
147 </div>
148 <a id="afdaa93128f4c785fc4c022bc8ecd840a"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#afdaa93128f4c785fc4c022bc8ecd840a">&#9670;&nbsp;</a></span>vhGetLibraryName()</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">const char* vhGetLibraryName </td>
156 <td>(</td>
157 <td class="paramtype">int&#160;</td>
158 <td class="paramname"><em>library</em></td><td>)</td>
159 <td></td>
160 </tr>
161 </table>
162 </div><div class="memdoc">
163
164 <p>Return the library name (base soname) of the library with the given index, in the range 0..(<a class="el" href="host-c_8h.html#a63420c2f047538e88f88f76cf8f22a43" title="Return the number of Vamp plugin libraries discovered in the installation path. ">vhGetLibraryCount()</a>-1). </p>
165
166 </div>
167 </div>
168 <a id="ac1e2a1b3c3f1c3019bee99140b4a1551"></a>
169 <h2 class="memtitle"><span class="permalink"><a href="#ac1e2a1b3c3f1c3019bee99140b4a1551">&#9670;&nbsp;</a></span>vhGetLibraryIndex()</h2>
170
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">int vhGetLibraryIndex </td>
176 <td>(</td>
177 <td class="paramtype">const char *&#160;</td>
178 <td class="paramname"><em>name</em></td><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182 </div><div class="memdoc">
183
184 <p>Return the library index for the given library name, or -1 if the name is not known. </p>
185
186 </div>
187 </div>
188 <a id="ae93710ce0c0d9d99ca798fffa7517929"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#ae93710ce0c0d9d99ca798fffa7517929">&#9670;&nbsp;</a></span>vhLoadLibrary()</h2>
190
191 <div class="memitem">
192 <div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a> vhLoadLibrary </td>
196 <td>(</td>
197 <td class="paramtype">int&#160;</td>
198 <td class="paramname"><em>library</em></td><td>)</td>
199 <td></td>
200 </tr>
201 </table>
202 </div><div class="memdoc">
203
204 <p>Load the library with the given index. </p>
205 <p>If the library cannot be loaded for any reason, the return value is 0; otherwise it is an opaque pointer suitable for passing to other functions in this API. </p>
206
207 </div>
208 </div>
209 <a id="af23b8bddcbf13f9d15f87a15d698de0b"></a>
210 <h2 class="memtitle"><span class="permalink"><a href="#af23b8bddcbf13f9d15f87a15d698de0b">&#9670;&nbsp;</a></span>vhGetPluginCount()</h2>
211
212 <div class="memitem">
213 <div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">int vhGetPluginCount </td>
217 <td>(</td>
218 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
219 <td class="paramname"><em>library</em></td><td>)</td>
220 <td></td>
221 </tr>
222 </table>
223 </div><div class="memdoc">
224
225 <p>Return the number of <a class="el" href="namespaceVamp.html">Vamp</a> plugins in the given library. </p>
226
227 </div>
228 </div>
229 <a id="a7d85254dce15986f87829d1c6e7b8d00"></a>
230 <h2 class="memtitle"><span class="permalink"><a href="#a7d85254dce15986f87829d1c6e7b8d00">&#9670;&nbsp;</a></span>vhGetPluginDescriptor()</h2>
231
232 <div class="memitem">
233 <div class="memproto">
234 <table class="memname">
235 <tr>
236 <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vhGetPluginDescriptor </td>
237 <td>(</td>
238 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
239 <td class="paramname"><em>library</em>, </td>
240 </tr>
241 <tr>
242 <td class="paramkey"></td>
243 <td></td>
244 <td class="paramtype">int&#160;</td>
245 <td class="paramname"><em>plugin</em>&#160;</td>
246 </tr>
247 <tr>
248 <td></td>
249 <td>)</td>
250 <td></td><td></td>
251 </tr>
252 </table>
253 </div><div class="memdoc">
254
255 <p>Return a <a class="el" href="namespaceVamp.html">Vamp</a> plugin descriptor for a plugin in a given library. </p>
256 <p>This simply calls the vampGetPluginDescriptor function in that library with the given plugin index and returns the result. See <a class="el" href="vamp_8h.html">vamp/vamp.h</a> for details about the plugin descriptor. </p>
257
258 </div>
259 </div>
260 <a id="a4ec9d6f7408267d7567d9b2435807840"></a>
261 <h2 class="memtitle"><span class="permalink"><a href="#a4ec9d6f7408267d7567d9b2435807840">&#9670;&nbsp;</a></span>vhUnloadLibrary()</h2>
262
263 <div class="memitem">
264 <div class="memproto">
265 <table class="memname">
266 <tr>
267 <td class="memname">void vhUnloadLibrary </td>
268 <td>(</td>
269 <td class="paramtype"><a class="el" href="host-c_8h.html#a0d6585882923f575e76bd0a6835e9748">vhLibrary</a>&#160;</td>
270 <td class="paramname"></td><td>)</td>
271 <td></td>
272 </tr>
273 </table>
274 </div><div class="memdoc">
275
276 <p>Unload a plugin library. </p>
277 <p>Do not do this while any of its plugins are still in use. </p>
278
279 </div>
280 </div>
281 </div><!-- contents -->
282 </div><!-- doc-content -->
283 <!-- start footer part -->
284 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
285 <ul>
286 <li class="navelem"><a class="el" href="dir_fb90db1f62862cb68177e0e13786fda0.html">vamp-hostsdk</a></li><li class="navelem"><a class="el" href="host-c_8h.html">host-c.h</a></li>
287 <li class="footer">Generated by
288 <a href="http://www.doxygen.org/index.html">
289 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
290 </ul>
291 </div>
292 </body>
293 </html>