This file is indexed.

/usr/share/gtk-doc/html/libvips/libvips-video.html is in libvips-doc 7.26.3-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>video</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="VIPS Reference Manual">
<link rel="up" href="ch02.html" title="VIPS operation API by section">
<link rel="prev" href="libvips-resample.html" title="resample">
<link rel="next" href="ch03.html" title="Other API (no gtkdoc comments yet)">
<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="libvips-resample.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">VIPS Reference Manual</th>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libvips-video.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libvips-video.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libvips-video"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libvips-video.top_of_page"></a>video</span></h2>
<p>video — various video grabbers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libvips-video.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libvips-video.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;vips/vips.h&gt;

<span class="returnvalue">int</span>                 <a class="link" href="libvips-video.html#im-video-v4l1" title="im_video_v4l1 ()">im_video_v4l1</a>                       (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *im</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> channel</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> brightness</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> colour</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> contrast</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> hue</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> ngrabs</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="libvips-video.html#im-video-test" title="im_video_test ()">im_video_test</a>                       (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *im</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> brightness</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libvips-video.description"></a><h2>Description</h2>
<p>
Read an image from a video source.
</p>
</div>
<div class="refsect1">
<a name="libvips-video.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="im-video-v4l1"></a><h3>im_video_v4l1 ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 im_video_v4l1                       (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *im</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *device</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> channel</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> brightness</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> colour</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> contrast</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> hue</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> ngrabs</code></em>);</pre>
<p>
Grab an image from a device using the Video4Linux1 interface. It grabs
24-bit RGB at the maximum size your card allows.
</p>
<p>
<em class="parameter"><code>device</code></em> should typically be "/dev/video".
<em class="parameter"><code>channel</code></em> selects the channel to acquire: usually 0 is TV, and 1 is 
composite video. <em class="parameter"><code>brightness</code></em>, <em class="parameter"><code>colour</code></em>, <em class="parameter"><code>contrast</code></em> and <em class="parameter"><code>hue</code></em> 
set grab parameters. Each should be in the range (0 - 32768). 
32768 is usually the value you want. <em class="parameter"><code>ngrabs</code></em>
sets the number of frames the card should average. 
Higher values are slower, but typically less noisy (and slightly softer).
</p>
<p>
This function needs updating to newer video standards.
</p>
<p>
See also: <a class="link" href="libvips-video.html#im-video-test" title="im_video_test ()"><code class="function">im_video_test()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>im</code></em> :</span></p></td>
<td>write image here</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
<td>device to grab from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>channel to grab</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>brightness</code></em> :</span></p></td>
<td>brightness setting</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>colour</code></em> :</span></p></td>
<td>colour setting</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contrast</code></em> :</span></p></td>
<td>contrast setting</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hue</code></em> :</span></p></td>
<td>hue setting</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ngrabs</code></em> :</span></p></td>
<td>average this many frames</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>0 on success, -1 on error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="im-video-test"></a><h3>im_video_test ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 im_video_test                       (<em class="parameter"><code><a class="link" href="VipsImage.html" title="VipsImage"><span class="type">VipsImage</span></a> *im</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> brightness</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> error</code></em>);</pre>
<p>
Make a test video image. Set <em class="parameter"><code>error</code></em> to trigger an error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>im</code></em> :</span></p></td>
<td>write image here</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>brightness</code></em> :</span></p></td>
<td>brightness setting</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>set this to make the function return an error</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>0 on success, -1 on error</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libvips-video.see-also"></a><h2>See Also</h2>
image
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>