1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-udpsink.html" title="udpsink">
10 <link rel="next" href="gst-plugins-good-plugins-v4l2sink.html" title="v4l2sink">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-udpsink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-v4l2sink.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-v4l2src.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-good-plugins-v4l2src.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-good-plugins-v4l2src.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-good-plugins-v4l2src.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#gst-plugins-good-plugins-v4l2src.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-v4l2src"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-v4l2src.top_of_page"></a>v4l2src</span></h2>
40 <p>v4l2src — Reads frames from a Video4Linux2 device</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-good-plugins-v4l2src.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstV4l2Src"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src-struct" title="struct GstV4l2Src">GstV4l2Src</a>;
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-v4l2src.object-hierarchy"></a><h2>Object Hierarchy</h2>
51 <pre class="synopsis">
52 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
53 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
54 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
55 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseSrc.html">GstBaseSrc</a>
56 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstPushSrc.html">GstPushSrc</a>
60 <div class="refsect1">
61 <a name="gst-plugins-good-plugins-v4l2src.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
64 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstUriHandler.html#GstURIHandler">GstURIHandler</a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstImplementsInterface.html">GstImplementsInterface</a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gsttuner.html#GstTuner">GstTuner</a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance">GstColorBalance</a>, <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideoorientation.html#GstVideoOrientation">GstVideoOrientation</a> and <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstpropertyprobe.html#GstPropertyProbe">GstPropertyProbe</a>.</p>
66 <div class="refsect1">
67 <a name="gst-plugins-good-plugins-v4l2src.properties"></a><h2>Properties</h2>
68 <pre class="synopsis">
69 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--device" title='The "device" property'>device</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
70 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--device-name" title='The "device-name" property'>device-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
71 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--flags" title='The "flags" property'>flags</a>" <span class="type">GstV4l2DeviceTypeFlags</span> : Read
72 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--queue-size" title='The "queue-size" property'>queue-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
73 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--always-copy" title='The "always-copy" property'>always-copy</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
74 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--device-fd" title='The "device-fd" property'>device-fd</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
75 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--brightness" title='The "brightness" property'>brightness</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
76 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--contrast" title='The "contrast" property'>contrast</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
77 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--decimate" title='The "decimate" property'>decimate</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
78 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--hue" title='The "hue" property'>hue</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
79 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--saturation" title='The "saturation" property'>saturation</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
80 "<a class="link" href="gst-plugins-good-plugins-v4l2src.html#GstV4l2Src--norm" title='The "norm" property'>norm</a>" <span class="type">V4L2_TV_norms</span> : Read / Write
83 <div class="refsect1">
84 <a name="gst-plugins-good-plugins-v4l2src.description"></a><h2>Description</h2>
85 <div class="refsynopsisdiv">
87 <div class="refsect2">
88 <a name="idp22038080"></a><h3>Element Information</h3>
89 <div class="variablelist"><table border="0">
90 <col align="left" valign="top">
93 <td><p><span class="term">plugin</span></p></td>
95 <a class="link" href="gst-plugins-good-plugins-plugin-video4linux2.html#plugin-video4linux2">video4linux2</a>
99 <td><p><span class="term">author</span></p></td>
100 <td>Edgard Lima <edgard.lima@indt.org.br>, Stefan Kost <ensonic@users.sf.net></td>
103 <td><p><span class="term">class</span></p></td>
104 <td>Source/Video</td>
110 <div class="refsect2">
111 <a name="idp21731728"></a><h3>Element Pads</h3>
112 <div class="variablelist"><table border="0">
113 <col align="left" valign="top">
116 <td><p><span class="term">name</span></p></td>
120 <td><p><span class="term">direction</span></p></td>
124 <td><p><span class="term">presence</span></p></td>
128 <td><p><span class="term">details</span></p></td>
129 <td>video/x-raw-rgb, bpp=(int)8, depth=(int)8, red_mask=(int)224, green_mask=(int)28, blue_mask=(int)3, endianness=(int)1234, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
132 <td><p><span class="term"></span></p></td>
133 <td> video/x-raw-rgb, bpp=(int)16, depth=(int)15, red_mask=(int)31744, green_mask=(int)992, blue_mask=(int)31, endianness=(int)1234, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
136 <td><p><span class="term"></span></p></td>
137 <td> video/x-raw-rgb, bpp=(int)16, depth=(int)16, red_mask=(int)63488, green_mask=(int)2016, blue_mask=(int)31, endianness=(int)1234, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
140 <td><p><span class="term"></span></p></td>
141 <td> video/x-raw-rgb, bpp=(int)16, depth=(int)15, red_mask=(int)31744, green_mask=(int)992, blue_mask=(int)31, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
144 <td><p><span class="term"></span></p></td>
145 <td> video/x-raw-rgb, bpp=(int)16, depth=(int)16, red_mask=(int)63488, green_mask=(int)2016, blue_mask=(int)31, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
148 <td><p><span class="term"></span></p></td>
149 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
152 <td><p><span class="term"></span></p></td>
153 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
156 <td><p><span class="term"></span></p></td>
157 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
160 <td><p><span class="term"></span></p></td>
161 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, endianness=(int)4321, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
164 <td><p><span class="term"></span></p></td>
165 <td> video/x-raw-gray, bpp=(int)8, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
168 <td><p><span class="term"></span></p></td>
169 <td> video/x-raw-yuv, format=(fourcc)YVU9, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
172 <td><p><span class="term"></span></p></td>
173 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
176 <td><p><span class="term"></span></p></td>
177 <td> video/x-raw-yuv, format=(fourcc)YUY2, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
180 <td><p><span class="term"></span></p></td>
181 <td> video/x-raw-yuv, format=(fourcc)UYVY, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
184 <td><p><span class="term"></span></p></td>
185 <td> video/x-raw-yuv, format=(fourcc)Y42B, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
188 <td><p><span class="term"></span></p></td>
189 <td> video/x-raw-yuv, format=(fourcc)Y41B, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
192 <td><p><span class="term"></span></p></td>
193 <td> video/x-raw-yuv, format=(fourcc)Y41P, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
196 <td><p><span class="term"></span></p></td>
197 <td> video/x-raw-yuv, format=(fourcc)NV12, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
200 <td><p><span class="term"></span></p></td>
201 <td> video/x-raw-yuv, format=(fourcc)NV21, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
204 <td><p><span class="term"></span></p></td>
205 <td> video/x-raw-yuv, format=(fourcc)YUV9, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
208 <td><p><span class="term"></span></p></td>
209 <td> video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
212 <td><p><span class="term"></span></p></td>
213 <td> video/x-raw-bayer, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
216 <td><p><span class="term"></span></p></td>
217 <td> image/jpeg, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
220 <td><p><span class="term"></span></p></td>
221 <td> image/jpeg, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
224 <td><p><span class="term"></span></p></td>
225 <td> image/jpeg, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
228 <td><p><span class="term"></span></p></td>
229 <td> video/x-dv, systemstream=(boolean)true, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
232 <td><p><span class="term"></span></p></td>
233 <td> video/mpegts</td>
236 <td><p><span class="term"></span></p></td>
237 <td> video/x-sonix, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
240 <td><p><span class="term"></span></p></td>
241 <td> video/x-pwc1, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
244 <td><p><span class="term"></span></p></td>
245 <td> video/x-pwc2, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
248 <td><p><span class="term"></span></p></td>
249 <td> video/x-raw-yuv, format=(fourcc)YVYU, width=(int)[ 1, 32768 ], height=(int)[ 1, 32768 ], framerate=(fraction)[ 0/1, 100/1 ]</td>
258 <div class="refsect1">
259 <a name="gst-plugins-good-plugins-v4l2src.details"></a><h2>Details</h2>
260 <div class="refsect2">
261 <a name="GstV4l2Src-struct"></a><h3>struct GstV4l2Src</h3>
262 <pre class="programlisting">struct GstV4l2Src;</pre>
267 <div class="refsect1">
268 <a name="gst-plugins-good-plugins-v4l2src.property-details"></a><h2>Property Details</h2>
269 <div class="refsect2">
270 <a name="GstV4l2Src--device"></a><h3>The <code class="literal">"device"</code> property</h3>
271 <pre class="programlisting"> "device" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
272 <p>Device location.</p>
273 <p>Default value: "/dev/video0"</p>
276 <div class="refsect2">
277 <a name="GstV4l2Src--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
278 <pre class="programlisting"> "device-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
279 <p>Name of the device.</p>
280 <p>Default value: NULL</p>
283 <div class="refsect2">
284 <a name="GstV4l2Src--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
285 <pre class="programlisting"> "flags" <span class="type">GstV4l2DeviceTypeFlags</span> : Read</pre>
286 <p>Device type flags.</p>
289 <div class="refsect2">
290 <a name="GstV4l2Src--queue-size"></a><h3>The <code class="literal">"queue-size"</code> property</h3>
291 <pre class="programlisting"> "queue-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
292 <p>Number of buffers to be enqueud in the driver in streaming mode.</p>
293 <p>Allowed values: [1,16]</p>
294 <p>Default value: 2</p>
297 <div class="refsect2">
298 <a name="GstV4l2Src--always-copy"></a><h3>The <code class="literal">"always-copy"</code> property</h3>
299 <pre class="programlisting"> "always-copy" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
300 <p>If the buffer will or not be used directly from mmap.</p>
301 <p>Default value: TRUE</p>
304 <div class="refsect2">
305 <a name="GstV4l2Src--device-fd"></a><h3>The <code class="literal">"device-fd"</code> property</h3>
306 <pre class="programlisting"> "device-fd" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre>
307 <p>File descriptor of the device.</p>
308 <p>Allowed values: >= G_MAXULONG</p>
309 <p>Default value: -1</p>
312 <div class="refsect2">
313 <a name="GstV4l2Src--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
314 <pre class="programlisting"> "brightness" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
315 <p>Picture brightness, or more precisely, the black level.</p>
316 <p>Default value: 0</p>
319 <div class="refsect2">
320 <a name="GstV4l2Src--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
321 <pre class="programlisting"> "contrast" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
322 <p>Picture contrast or luma gain.</p>
323 <p>Default value: 0</p>
326 <div class="refsect2">
327 <a name="GstV4l2Src--decimate"></a><h3>The <code class="literal">"decimate"</code> property</h3>
328 <pre class="programlisting"> "decimate" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
329 <p>Only use every nth frame.</p>
330 <p>Allowed values: >= 1</p>
331 <p>Default value: 1</p>
334 <div class="refsect2">
335 <a name="GstV4l2Src--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
336 <pre class="programlisting"> "hue" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
337 <p>Hue or color balance.</p>
338 <p>Default value: 0</p>
341 <div class="refsect2">
342 <a name="GstV4l2Src--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
343 <pre class="programlisting"> "saturation" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
344 <p>Picture color saturation or chroma gain.</p>
345 <p>Default value: 0</p>
348 <div class="refsect2">
349 <a name="GstV4l2Src--norm"></a><h3>The <code class="literal">"norm"</code> property</h3>
350 <pre class="programlisting"> "norm" <span class="type">V4L2_TV_norms</span> : Read / Write</pre>
351 <p>video standard.</p>
352 <p>Default value: none</p>
358 Generated by GTK-Doc V1.18</div>