/usr/share/doc/slv2/port_8h_source.html is in slv2-doc 0.6.6+dfsg1-3build1.
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 | <!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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>SLV2: port.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_43ce19c2fde330572805b23b6d868e0b.html">slv2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">port.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SLV2</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2007-2009 Dave Robillard <http://drobilla.net></span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This library is free software; you can redistribute it and/or modify it</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * under the terms of the GNU General Public License as published by the Free</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Software Foundation; either version 2 of the License, or (at your option)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This library is distributed in the hope that it will be useful, but WITHOUT</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * for more details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * You should have received a copy of the GNU General Public License along</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef __SLV2_PORT_H__</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define __SLV2_PORT_H__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "slv2/types.h"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "slv2/plugin.h"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "slv2/port.h"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "slv2/collections.h"</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> SLV2Values</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <a class="code" href="group__slv2__data.html#ga7ce418aff549039c0fa253b177a81b74">slv2_port_get_value</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  SLV2Port port,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  SLV2Value predicate);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> SLV2Values</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="group__slv2__data.html#ga3c9b004fe5b56b29f2dd77c100d1e2a1">slv2_port_get_value_by_qname</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  SLV2Port port,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* property_uri);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> SLV2Values</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="group__slv2__data.html#ga3d3df4185cfc3c60bdcb27395d9b44d0">slv2_port_get_value_by_qname_i18n</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  SLV2Port port,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* property_uri);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> SLV2Values</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="group__slv2__data.html#ga67b89db0cca5e2f633a463c723a33f3d">slv2_port_get_properties</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  SLV2Port port);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <a class="code" href="group__slv2__data.html#ga16cbdd22f76d0b1f8beb02287262ec9f">slv2_port_has_property</a>(SLV2Plugin p,</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  SLV2Port port,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  SLV2Value property_uri);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <a class="code" href="group__slv2__data.html#ga54bb3559ac93874ce3a6210789b82f95">slv2_port_supports_event</a>(SLV2Plugin p,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  SLV2Port port,</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  SLV2Value event_uri);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> SLV2Value</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <a class="code" href="group__slv2__data.html#ga2b9a23c54874286e10f614ef4d699f73">slv2_port_get_symbol</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  SLV2Port port);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> SLV2Value</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <a class="code" href="group__slv2__data.html#gad44f389d27c2a3335c3131ce4ab9e6eb">slv2_port_get_name</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  SLV2Port port);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> SLV2Values</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <a class="code" href="group__slv2__data.html#ga51f2169263094d12c025f70a5fb2d1c9">slv2_port_get_classes</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  SLV2Port port);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <a class="code" href="group__slv2__data.html#ga6be0f93a2d1f1df096b96a6f97de3956">slv2_port_is_a</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  SLV2Port port,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  SLV2Value port_class);</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <a class="code" href="group__slv2__data.html#ga883fcd25d26fe72d007688a1b6a5dccb">slv2_port_get_range</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  SLV2Port port,</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  SLV2Value* def,</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  SLV2Value* min,</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  SLV2Value* max);</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> SLV2ScalePoints</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <a class="code" href="group__slv2__data.html#ga2ab76b6b880ae09a9ed2d531addef0bf">slv2_port_get_scale_points</a>(SLV2Plugin plugin,</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  SLV2Port port);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> } <span class="comment">/* extern "C" */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#endif </span><span class="comment">/* __SLV2_PORT_H__ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__slv2__data_html_ga883fcd25d26fe72d007688a1b6a5dccb"><div class="ttname"><a href="group__slv2__data.html#ga883fcd25d26fe72d007688a1b6a5dccb">slv2_port_get_range</a></div><div class="ttdeci">void slv2_port_get_range(SLV2Plugin plugin, SLV2Port port, SLV2Value *def, SLV2Value *min, SLV2Value *max)</div><div class="ttdoc">Get the default, minimum, and maximum values of a port. </div></div>
<div class="ttc" id="group__slv2__data_html_ga16cbdd22f76d0b1f8beb02287262ec9f"><div class="ttname"><a href="group__slv2__data.html#ga16cbdd22f76d0b1f8beb02287262ec9f">slv2_port_has_property</a></div><div class="ttdeci">bool slv2_port_has_property(SLV2Plugin p, SLV2Port port, SLV2Value property_uri)</div><div class="ttdoc">Return whether a port has a certain property. </div></div>
<div class="ttc" id="group__slv2__data_html_gad44f389d27c2a3335c3131ce4ab9e6eb"><div class="ttname"><a href="group__slv2__data.html#gad44f389d27c2a3335c3131ce4ab9e6eb">slv2_port_get_name</a></div><div class="ttdeci">SLV2Value slv2_port_get_name(SLV2Plugin plugin, SLV2Port port)</div><div class="ttdoc">Get the name of a port. </div></div>
<div class="ttc" id="group__slv2__data_html_ga3c9b004fe5b56b29f2dd77c100d1e2a1"><div class="ttname"><a href="group__slv2__data.html#ga3c9b004fe5b56b29f2dd77c100d1e2a1">slv2_port_get_value_by_qname</a></div><div class="ttdeci">SLV2Values slv2_port_get_value_by_qname(SLV2Plugin plugin, SLV2Port port, const char *property_uri)</div><div class="ttdoc">Port analog of slv2_plugin_get_value_by_qname. </div></div>
<div class="ttc" id="group__slv2__data_html_ga3d3df4185cfc3c60bdcb27395d9b44d0"><div class="ttname"><a href="group__slv2__data.html#ga3d3df4185cfc3c60bdcb27395d9b44d0">slv2_port_get_value_by_qname_i18n</a></div><div class="ttdeci">SLV2Values slv2_port_get_value_by_qname_i18n(SLV2Plugin plugin, SLV2Port port, const char *property_uri)</div><div class="ttdoc">Port analog of slv2_plugin_get_value_by_qname_i18n. </div></div>
<div class="ttc" id="group__slv2__data_html_ga7ce418aff549039c0fa253b177a81b74"><div class="ttname"><a href="group__slv2__data.html#ga7ce418aff549039c0fa253b177a81b74">slv2_port_get_value</a></div><div class="ttdeci">SLV2Values slv2_port_get_value(SLV2Plugin plugin, SLV2Port port, SLV2Value predicate)</div><div class="ttdoc">Port analog of slv2_plugin_get_value. </div></div>
<div class="ttc" id="group__slv2__data_html_ga2b9a23c54874286e10f614ef4d699f73"><div class="ttname"><a href="group__slv2__data.html#ga2b9a23c54874286e10f614ef4d699f73">slv2_port_get_symbol</a></div><div class="ttdeci">SLV2Value slv2_port_get_symbol(SLV2Plugin plugin, SLV2Port port)</div><div class="ttdoc">Get the symbol of a port. </div></div>
<div class="ttc" id="group__slv2__data_html_ga6be0f93a2d1f1df096b96a6f97de3956"><div class="ttname"><a href="group__slv2__data.html#ga6be0f93a2d1f1df096b96a6f97de3956">slv2_port_is_a</a></div><div class="ttdeci">bool slv2_port_is_a(SLV2Plugin plugin, SLV2Port port, SLV2Value port_class)</div><div class="ttdoc">Determine if a port is of a given class (input, output, audio, etc). </div></div>
<div class="ttc" id="group__slv2__data_html_ga54bb3559ac93874ce3a6210789b82f95"><div class="ttname"><a href="group__slv2__data.html#ga54bb3559ac93874ce3a6210789b82f95">slv2_port_supports_event</a></div><div class="ttdeci">bool slv2_port_supports_event(SLV2Plugin p, SLV2Port port, SLV2Value event_uri)</div><div class="ttdoc">Return whether a port is an event port and supports a certain event type. </div></div>
<div class="ttc" id="group__slv2__data_html_ga51f2169263094d12c025f70a5fb2d1c9"><div class="ttname"><a href="group__slv2__data.html#ga51f2169263094d12c025f70a5fb2d1c9">slv2_port_get_classes</a></div><div class="ttdeci">SLV2Values slv2_port_get_classes(SLV2Plugin plugin, SLV2Port port)</div><div class="ttdoc">Get all the classes of a port. </div></div>
<div class="ttc" id="group__slv2__data_html_ga2ab76b6b880ae09a9ed2d531addef0bf"><div class="ttname"><a href="group__slv2__data.html#ga2ab76b6b880ae09a9ed2d531addef0bf">slv2_port_get_scale_points</a></div><div class="ttdeci">SLV2ScalePoints slv2_port_get_scale_points(SLV2Plugin plugin, SLV2Port port)</div><div class="ttdoc">Get the scale points (enumeration values) of a port. </div></div>
<div class="ttc" id="group__slv2__data_html_ga67b89db0cca5e2f633a463c723a33f3d"><div class="ttname"><a href="group__slv2__data.html#ga67b89db0cca5e2f633a463c723a33f3d">slv2_port_get_properties</a></div><div class="ttdeci">SLV2Values slv2_port_get_properties(SLV2Plugin plugin, SLV2Port port)</div><div class="ttdoc">Return the LV2 port properties of a port. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|