/usr/share/gtk-doc/html/libunicapgtk/libunicapgtk-unicapgtk.html is in libunicapgtk-docs 0.9.5-1.1build1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>unicapgtk</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="libunicapgtk Reference Manual">
<link rel="up" href="ch01.html" title="libunicapgtk Reference">
<link rel="prev" href="ch01.html" title="libunicapgtk Reference">
<link rel="next" href="UnicapgtkDeviceProperty.html" title="UnicapgtkDeviceProperty">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libunicapgtk Reference Manual</th>
<td><a accesskey="n" href="UnicapgtkDeviceProperty.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libunicapgtk-unicapgtk.synopsis" class="shortcut">Top</a>
|
<a href="#libunicapgtk-unicapgtk.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libunicapgtk-unicapgtk"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libunicapgtk-unicapgtk.top_of_page"></a>unicapgtk</span></h2>
<p>unicapgtk</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libunicapgtk-unicapgtk.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags">UnicapgtkDeviceStateFlags</a>;
<span class="returnvalue">gchar</span> * <a class="link" href="libunicapgtk-unicapgtk.html#unicapgtk-get-user-config-path" title="unicapgtk_get_user_config_path ()">unicapgtk_get_user_config_path</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">GKeyFile</span> * <a class="link" href="libunicapgtk-unicapgtk.html#unicapgtk-save-device-state" title="unicapgtk_save_device_state ()">unicapgtk_save_device_state</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags"><span class="type">UnicapgtkDeviceStateFlags</span></a> flags</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libunicapgtk-unicapgtk.html#unicapgtk-load-device-state" title="unicapgtk_load_device_state ()">unicapgtk_load_device_state</a> (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *keyfile</code></em>,
<em class="parameter"><code><a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags"><span class="type">UnicapgtkDeviceStateFlags</span></a> flags</code></em>);
<span class="returnvalue">unicap_status_t</span> <a class="link" href="libunicapgtk-unicapgtk.html#unicapgtk-check-version" title="unicapgtk_check_version ()">unicapgtk_check_version</a> (<em class="parameter"><code>unsigned <span class="type">int</span> major</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> minor</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> micro</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libunicapgtk-unicapgtk.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libunicapgtk-unicapgtk.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="UnicapgtkDeviceStateFlags"></a><h3>enum UnicapgtkDeviceStateFlags</h3>
<pre class="programlisting">typedef enum
{
UNICAPGTK_DEVICE_STATE_VIDEO_FORMAT = 1 << 0,
UNICAPGTK_DEVICE_STATE_PROPERTIES = 1 << 1,
}UnicapgtkDeviceStateFlags;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="unicapgtk-get-user-config-path"></a><h3>unicapgtk_get_user_config_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * unicapgtk_get_user_config_path (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get path to the directory containing the configuration files
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Path to configuration directory</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicapgtk-save-device-state"></a><h3>unicapgtk_save_device_state ()</h3>
<pre class="programlisting"><span class="returnvalue">GKeyFile</span> * unicapgtk_save_device_state (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags"><span class="type">UnicapgtkDeviceStateFlags</span></a> flags</code></em>);</pre>
<p>
Saves the current device state. If UNICAPGTK_DEVICE_STATE_VIDEO_FORMAT is set in the <em class="parameter"><code>flags</code></em> field, a section containing information about
the current video format is added to the configuration file. If UNICAPGTK_DEVICE_STATE_PROPERTIES is set, a section containing the current
state of the device properties is added to the configuration file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>unicap handle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated GKeyfile. Must be freed with <code class="function">g_key_file_free()</code> by the application.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicapgtk-load-device-state"></a><h3>unicapgtk_load_device_state ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> unicapgtk_load_device_state (<em class="parameter"><code><span class="type">unicap_handle_t</span> handle</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *keyfile</code></em>,
<em class="parameter"><code><a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags"><span class="type">UnicapgtkDeviceStateFlags</span></a> flags</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>handle of the device</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keyfile</code></em> :</span></p></td>
<td>GKeyFile to load the device state information from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>
<a class="link" href="libunicapgtk-unicapgtk.html#UnicapgtkDeviceStateFlags" title="enum UnicapgtkDeviceStateFlags"><span class="type">UnicapgtkDeviceStateFlags</span></a> specifying what parts to
configure
Reads device state information from a key-file and sets the
parameters of a device accordingly.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="unicapgtk-check-version"></a><h3>unicapgtk_check_version ()</h3>
<pre class="programlisting"><span class="returnvalue">unicap_status_t</span> unicapgtk_check_version (<em class="parameter"><code>unsigned <span class="type">int</span> major</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> minor</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> micro</code></em>);</pre>
<p>
Checks whether the installed library version is newer or equal to
the given version
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>Major version to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>Minor version to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>Micro version to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>STATUS_INCOMPATIBLE_MAJOR_VERSION if the given major version is too old
STATUS_INCOMPATIBLE_MINOR_VERSION if the given minor version is too old
STATUS_INCOMPATIBLE_MACRO_VERSION if the given macro version is too old
STATUS_SUCCESS if the version is compatible</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|