/usr/share/doc/slv2/plugin_8h_source.html is in slv2-doc 0.6.6+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SLV2: plugin.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SLV2
 <span id="projectnumber">0.6.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">plugin.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* SLV2</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 Dave Robillard <http://drobilla.net></span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or modify it</span>
<a name="l00005"></a>00005 <span class="comment"> * under the terms of the GNU General Public License as published by the Free</span>
<a name="l00006"></a>00006 <span class="comment"> * Software Foundation; either version 2 of the License, or (at your option)</span>
<a name="l00007"></a>00007 <span class="comment"> * any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This library is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00010"></a>00010 <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00011"></a>00011 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License</span>
<a name="l00012"></a>00012 <span class="comment"> * for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00015"></a>00015 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00016"></a>00016 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __SLV2_PLUGIN_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __SLV2_PLUGIN_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00024"></a>00024 <span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdint.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdbool.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "slv2/types.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "slv2/port.h"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "slv2/collections.h"</span>
<a name="l00031"></a>00031
<a name="l00059"></a>00059 <span class="keywordtype">bool</span>
<a name="l00060"></a>00060 <a class="code" href="group__slv2__data.html#gafb639d5c3f2fdf84e5d755483f90d421" title="Check if this plugin is valid.">slv2_plugin_verify</a>(SLV2Plugin plugin);
<a name="l00061"></a>00061
<a name="l00062"></a>00062
<a name="l00079"></a>00079 SLV2Value
<a name="l00080"></a>00080 <a class="code" href="group__slv2__data.html#ga0ce041d33af29b39b96d00019e8adb20" title="Get the URI of plugin.">slv2_plugin_get_uri</a>(SLV2Plugin plugin);
<a name="l00081"></a>00081
<a name="l00082"></a>00082
<a name="l00098"></a>00098 SLV2Value
<a name="l00099"></a>00099 <a class="code" href="group__slv2__data.html#ga281f2ae08094511a2e03b89f978e6596" title="Get the (resolvable) URI of the plugins "main" bundle.">slv2_plugin_get_bundle_uri</a>(SLV2Plugin plugin);
<a name="l00100"></a>00100
<a name="l00101"></a>00101
<a name="l00114"></a>00114 SLV2Values
<a name="l00115"></a>00115 <a class="code" href="group__slv2__data.html#ga945146e4d31f8404c4c7bbbfd4257ce7" title="Get the (resolvable) URIs of the RDF data files that define a plugin.">slv2_plugin_get_data_uris</a>(SLV2Plugin plugin);
<a name="l00116"></a>00116
<a name="l00117"></a>00117
<a name="l00127"></a>00127 SLV2Value
<a name="l00128"></a>00128 <a class="code" href="group__slv2__data.html#gac4f9bf1812f0d7301eb64b8bd56c0f93" title="Get the (resolvable) URI of the shared library for plugin.">slv2_plugin_get_library_uri</a>(SLV2Plugin plugin);
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00139"></a>00139 SLV2Value
<a name="l00140"></a>00140 <a class="code" href="group__slv2__data.html#ga617eaca2d2a12c01693a389afcd2c9d3" title="Get the name of plugin.">slv2_plugin_get_name</a>(SLV2Plugin plugin);
<a name="l00141"></a>00141
<a name="l00142"></a>00142
<a name="l00145"></a>00145 SLV2PluginClass
<a name="l00146"></a>00146 <a class="code" href="group__slv2__data.html#ga8a2f3e33d323725e5703854b753fee3a" title="Get the class this plugin belongs to (ie Filters).">slv2_plugin_get_class</a>(SLV2Plugin plugin);
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00165"></a>00165 SLV2Values
<a name="l00166"></a>00166 <a class="code" href="group__slv2__data.html#ga8d5a582b1e9ef10baa68514fb0196d9e" title="Get a value associated with the plugin in a plugin's data files.">slv2_plugin_get_value</a>(SLV2Plugin p,
<a name="l00167"></a>00167 SLV2Value predicate);
<a name="l00168"></a>00168
<a name="l00169"></a>00169
<a name="l00176"></a>00176 SLV2Values
<a name="l00177"></a>00177 <a class="code" href="group__slv2__data.html#gafb8b19d0728d02aa38021169a3bfbf52" title="Get a value associated with the plugin in a plugin's data files.">slv2_plugin_get_value_by_qname</a>(SLV2Plugin p,
<a name="l00178"></a>00178 <span class="keyword">const</span> <span class="keywordtype">char</span>* predicate);
<a name="l00179"></a>00179
<a name="l00180"></a>00180
<a name="l00188"></a>00188 SLV2Values
<a name="l00189"></a>00189 <a class="code" href="group__slv2__data.html#gad3e5880afc40f9b22c3e89e2540a44f8" title="Get a translated value associated with the plugin in a plugin's data files.">slv2_plugin_get_value_by_qname_i18n</a>(SLV2Plugin p,
<a name="l00190"></a>00190 <span class="keyword">const</span> <span class="keywordtype">char</span>* predicate);
<a name="l00191"></a>00191
<a name="l00192"></a>00192
<a name="l00212"></a>00212 SLV2Values
<a name="l00213"></a>00213 <a class="code" href="group__slv2__data.html#gad73680dec8585af598fe3bb72d85b594" title="Get a value associated with some subject in a plugin's data files.">slv2_plugin_get_value_for_subject</a>(SLV2Plugin p,
<a name="l00214"></a>00214 SLV2Value subject_uri,
<a name="l00215"></a>00215 SLV2Value predicate_uri);
<a name="l00216"></a>00216
<a name="l00217"></a>00217
<a name="l00225"></a>00225 <span class="keywordtype">bool</span>
<a name="l00226"></a>00226 <a class="code" href="group__slv2__data.html#ga28612a276af77d5010a20e7a7c4c25fe" title="Return whether a feature is supported by a plugin.">slv2_plugin_has_feature</a>(SLV2Plugin p,
<a name="l00227"></a>00227 SLV2Value feature_uri);
<a name="l00228"></a>00228
<a name="l00229"></a>00229
<a name="l00242"></a>00242 SLV2Values
<a name="l00243"></a>00243 <a class="code" href="group__slv2__data.html#gad4b449a1f5be8d85ea2be490abb06c02" title="Get the LV2 Features supported (required or optionally) by a plugin.">slv2_plugin_get_supported_features</a>(SLV2Plugin p);
<a name="l00244"></a>00244
<a name="l00245"></a>00245
<a name="l00259"></a>00259 SLV2Values
<a name="l00260"></a>00260 <a class="code" href="group__slv2__data.html#gaa27643ca2e365702a5f9017c2eb64d07" title="Get the LV2 Features required by a plugin.">slv2_plugin_get_required_features</a>(SLV2Plugin p);
<a name="l00261"></a>00261
<a name="l00262"></a>00262
<a name="l00273"></a>00273 SLV2Values
<a name="l00274"></a>00274 <a class="code" href="group__slv2__data.html#gae6bd87a1081eb83d6df4aac0f66c6fc4" title="Get the LV2 Features optionally supported by a plugin.">slv2_plugin_get_optional_features</a>(SLV2Plugin p);
<a name="l00275"></a>00275
<a name="l00276"></a>00276
<a name="l00281"></a>00281 uint32_t
<a name="l00282"></a>00282 <a class="code" href="group__slv2__data.html#gaf5936ec6869b15229e8340364418733d" title="Get the number of ports on this plugin.">slv2_plugin_get_num_ports</a>(SLV2Plugin p);
<a name="l00283"></a>00283
<a name="l00284"></a>00284
<a name="l00299"></a>00299 <span class="keywordtype">void</span>
<a name="l00300"></a>00300 <a class="code" href="group__slv2__data.html#gaf656971898cfa50a690089d2e4bc2341" title="Get the port ranges (minimum, maximum and default values) for all ports.">slv2_plugin_get_port_ranges_float</a>(SLV2Plugin p,
<a name="l00301"></a>00301 <span class="keywordtype">float</span>* min_values,
<a name="l00302"></a>00302 <span class="keywordtype">float</span>* max_values,
<a name="l00303"></a>00303 <span class="keywordtype">float</span>* def_values);
<a name="l00304"></a>00304
<a name="l00313"></a>00313 uint32_t
<a name="l00314"></a>00314 <a class="code" href="group__slv2__data.html#gaa21d101da6df0bfac6099c78ec793df7" title="Get the number of ports on this plugin that are members of some class(es).">slv2_plugin_get_num_ports_of_class</a>(SLV2Plugin p,
<a name="l00315"></a>00315 SLV2Value class_1, ...);
<a name="l00316"></a>00316
<a name="l00324"></a>00324 <span class="keywordtype">bool</span>
<a name="l00325"></a>00325 <a class="code" href="group__slv2__data.html#ga3cc05426dacc5f3bf2bb92175531b8fe" title="Return whether or not the plugin introduces (and reports) latency.">slv2_plugin_has_latency</a>(SLV2Plugin p);
<a name="l00326"></a>00326
<a name="l00327"></a>00327
<a name="l00339"></a>00339 uint32_t
<a name="l00340"></a>00340 <a class="code" href="group__slv2__data.html#ga9edc49e39197b624e0bec1412d8f2204" title="Return the index of the plugin's latency port.">slv2_plugin_get_latency_port_index</a>(SLV2Plugin p);
<a name="l00341"></a>00341
<a name="l00342"></a>00342
<a name="l00353"></a>00353 SLV2Values
<a name="l00354"></a>00354 <a class="code" href="group__slv2__data.html#ga6313599e3d0963f511ab5fff25a22354" title="Query a plugin for a single variable (i.e.">slv2_plugin_query_variable</a>(SLV2Plugin plugin,
<a name="l00355"></a>00355 <span class="keyword">const</span> <span class="keywordtype">char</span>* sparql_str,
<a name="l00356"></a>00356 <span class="keywordtype">unsigned</span> variable);
<a name="l00357"></a>00357
<a name="l00358"></a>00358
<a name="l00369"></a>00369 <span class="keywordtype">unsigned</span>
<a name="l00370"></a>00370 <a class="code" href="group__slv2__data.html#ga42ae215b361d4538921cac004e023607" title="Query a plugin and return the number of results found.">slv2_plugin_query_count</a>(SLV2Plugin plugin,
<a name="l00371"></a>00371 <span class="keyword">const</span> <span class="keywordtype">char</span>* sparql_str);
<a name="l00372"></a>00372
<a name="l00373"></a>00373
<a name="l00381"></a>00381 SLV2Port
<a name="l00382"></a>00382 <a class="code" href="group__slv2__data.html#gaeb4878b7566e0786884fd6d2c2916ef7" title="Get a port on this plugin by index.">slv2_plugin_get_port_by_index</a>(SLV2Plugin plugin,
<a name="l00383"></a>00383 uint32_t index);
<a name="l00384"></a>00384
<a name="l00385"></a>00385
<a name="l00395"></a>00395 SLV2Port
<a name="l00396"></a>00396 <a class="code" href="group__slv2__data.html#ga247cc5f9f1317d69d55bc83ffe1488b2" title="Get a port on this plugin by symbol.">slv2_plugin_get_port_by_symbol</a>(SLV2Plugin plugin,
<a name="l00397"></a>00397 SLV2Value symbol);
<a name="l00398"></a>00398
<a name="l00399"></a>00399
<a name="l00412"></a>00412 SLV2UIs
<a name="l00413"></a>00413 <a class="code" href="group__slv2__data.html#gaa0b4d81838eae7217adefe9386edda6f" title="Get a list of all UIs available for this plugin.">slv2_plugin_get_uis</a>(SLV2Plugin plugin);
<a name="l00414"></a>00414
<a name="l00415"></a>00415
<a name="l00423"></a>00423 SLV2Value
<a name="l00424"></a>00424 <a class="code" href="group__slv2__data.html#gaca8caf5b090f177c84e2d2fc8fb0e796" title="Get the full name of the plugin's author.">slv2_plugin_get_author_name</a>(SLV2Plugin plugin);
<a name="l00425"></a>00425
<a name="l00426"></a>00426
<a name="l00434"></a>00434 SLV2Value
<a name="l00435"></a>00435 <a class="code" href="group__slv2__data.html#ga5d9e1c974228723abeb0b70cab82e3bf" title="Get the email address of the plugin's author.">slv2_plugin_get_author_email</a>(SLV2Plugin plugin);
<a name="l00436"></a>00436
<a name="l00437"></a>00437
<a name="l00445"></a>00445 SLV2Value
<a name="l00446"></a>00446 <a class="code" href="group__slv2__data.html#ga43ecec47aeefc0a28a632536d4046a42" title="Get the email address of the plugin's author.">slv2_plugin_get_author_homepage</a>(SLV2Plugin plugin);
<a name="l00447"></a>00447
<a name="l00448"></a>00448
<a name="l00451"></a>00451 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00452"></a>00452 <span class="preprocessor"></span>} <span class="comment">/* extern "C" */</span>
<a name="l00453"></a>00453 <span class="preprocessor">#endif</span>
<a name="l00454"></a>00454 <span class="preprocessor"></span>
<a name="l00455"></a>00455 <span class="preprocessor">#endif </span><span class="comment">/* __SLV2_PLUGIN_H__ */</span>
<a name="l00456"></a>00456
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 24 2012 19:32:20 for SLV2 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
|