docs/plugins/html/gst-plugins-good-plugins-v4l2sink.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>v4l2sink</title>
   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-v4l2src.html" title="v4l2src">
  10 <link rel="next" href="gst-plugins-good-plugins-v4l2radio.html" title="v4l2radio">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-good-plugins-v4l2src.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-v4l2radio.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-v4l2sink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-v4l2sink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-v4l2sink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-v4l2sink.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-v4l2sink"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-v4l2sink.top_of_page"></a>v4l2sink</span></h2>
  38 <p>v4l2sink</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-v4l2sink.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink" title="struct GstV4l2Sink">GstV4l2Sink</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-v4l2sink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  49 <p>
  50 GstV4l2Sink implements
  51  <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-gstxoverlay.html#GstXOverlay">GstXOverlay</a>,  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstnavigation.html#GstNavigation">GstNavigation</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>
  52 </div>
  53 <div class="refsect1">
  54 <a name="gst-plugins-good-plugins-v4l2sink.properties"></a><h2>Properties</h2>
  55 <pre class="synopsis">
  56   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  57   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  58   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  59   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--flags" title='The "flags" property'>flags</a>"                    <span class="type">GstV4l2DeviceTypeFlags</span>  : Read
  60   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--overlay-height" title='The "overlay-height" property'>overlay-height</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  61   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--overlay-left" title='The "overlay-left" property'>overlay-left</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  62   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--overlay-top" title='The "overlay-top" property'>overlay-top</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--overlay-width" title='The "overlay-width" property'>overlay-width</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  65   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  66   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  67   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  68   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--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
  69   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--crop-height" title='The "crop-height" property'>crop-height</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--crop-left" title='The "crop-left" property'>crop-left</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--crop-top" title='The "crop-top" property'>crop-top</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  72   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--crop-width" title='The "crop-width" property'>crop-width</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-v4l2sink.html#GstV4l2Sink--min-queued-bufs" title='The "min-queued-bufs" property'>min-queued-bufs</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  74 </pre>
  75 </div>
  76 <div class="refsect1">
  77 <a name="gst-plugins-good-plugins-v4l2sink.description"></a><h2>Description</h2>
  78 <p>
  79 </p>
  80 </div>
  81 <div class="refsect1">
  82 <a name="gst-plugins-good-plugins-v4l2sink.details"></a><h2>Details</h2>
  83 <div class="refsect2">
  84 <a name="GstV4l2Sink"></a><h3>struct GstV4l2Sink</h3>
  85 <pre class="programlisting">struct GstV4l2Sink {
  86   GstVideoSink videosink;
  87 };
  88 </pre>
  89 <p>
  90 </p>
  91 </div>
  92 </div>
  93 <div class="refsect1">
  94 <a name="gst-plugins-good-plugins-v4l2sink.property-details"></a><h2>Property Details</h2>
  95 <div class="refsect2">
  96 <a name="GstV4l2Sink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
  97 <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>
  98 <p>Device location.</p>
  99 <p>Default value: "/dev/video1"</p>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="GstV4l2Sink--device-fd"></a><h3>The <code class="literal">"device-fd"</code> property</h3>
 104 <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>
 105 <p>File descriptor of the device.</p>
 106 <p>Allowed values: &gt;= -1</p>
 107 <p>Default value: -1</p>
 108 </div>
 109 <hr>
 110 <div class="refsect2">
 111 <a name="GstV4l2Sink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 112 <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>
 113 <p>Name of the device.</p>
 114 <p>Default value: NULL</p>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="GstV4l2Sink--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
 119 <pre class="programlisting">  "flags"                    <span class="type">GstV4l2DeviceTypeFlags</span>  : Read</pre>
 120 <p>Device type flags.</p>
 121 </div>
 122 <hr>
 123 <div class="refsect2">
 124 <a name="GstV4l2Sink--overlay-height"></a><h3>The <code class="literal">"overlay-height"</code> property</h3>
 125 <pre class="programlisting">  "overlay-height"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 126 <p>The height of the video overlay; default is equal to negotiated image height.</p>
 127 <p>Default value: 0</p>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="GstV4l2Sink--overlay-left"></a><h3>The <code class="literal">"overlay-left"</code> property</h3>
 132 <pre class="programlisting">  "overlay-left"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 133 <p>The leftmost (x) coordinate of the video overlay; top left corner of screen is 0,0.</p>
 134 <p>Default value: 0</p>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="GstV4l2Sink--overlay-top"></a><h3>The <code class="literal">"overlay-top"</code> property</h3>
 139 <pre class="programlisting">  "overlay-top"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 140 <p>The topmost (y) coordinate of the video overlay; top left corner of screen is 0,0.</p>
 141 <p>Default value: 0</p>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="GstV4l2Sink--overlay-width"></a><h3>The <code class="literal">"overlay-width"</code> property</h3>
 146 <pre class="programlisting">  "overlay-width"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 147 <p>The width of the video overlay; default is equal to negotiated image width.</p>
 148 <p>Default value: 0</p>
 149 </div>
 150 <hr>
 151 <div class="refsect2">
 152 <a name="GstV4l2Sink--queue-size"></a><h3>The <code class="literal">"queue-size"</code> property</h3>
 153 <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>
 154 <p>Number of buffers to be enqueud in the driver in streaming mode.</p>
 155 <p>Allowed values: [1,16]</p>
 156 <p>Default value: 12</p>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="GstV4l2Sink--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
 161 <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>
 162 <p>Picture brightness, or more precisely, the black level.</p>
 163 <p>Default value: 0</p>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="GstV4l2Sink--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
 168 <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>
 169 <p>Picture contrast or luma gain.</p>
 170 <p>Default value: 0</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GstV4l2Sink--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
 175 <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>
 176 <p>Hue or color balance.</p>
 177 <p>Default value: 0</p>
 178 </div>
 179 <hr>
 180 <div class="refsect2">
 181 <a name="GstV4l2Sink--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
 182 <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>
 183 <p>Picture color saturation or chroma gain.</p>
 184 <p>Default value: 0</p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="GstV4l2Sink--crop-height"></a><h3>The <code class="literal">"crop-height"</code> property</h3>
 189 <pre class="programlisting">  "crop-height"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 190 <p>The height of the video crop; default is equal to negotiated image height.</p>
 191 <p>Default value: 0</p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="GstV4l2Sink--crop-left"></a><h3>The <code class="literal">"crop-left"</code> property</h3>
 196 <pre class="programlisting">  "crop-left"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 197 <p>The leftmost (x) coordinate of the video crop; top left corner of image is 0,0.</p>
 198 <p>Default value: 0</p>
 199 </div>
 200 <hr>
 201 <div class="refsect2">
 202 <a name="GstV4l2Sink--crop-top"></a><h3>The <code class="literal">"crop-top"</code> property</h3>
 203 <pre class="programlisting">  "crop-top"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 204 <p>The topmost (y) coordinate of the video crop; top left corner of image is 0,0.</p>
 205 <p>Default value: 0</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="GstV4l2Sink--crop-width"></a><h3>The <code class="literal">"crop-width"</code> property</h3>
 210 <pre class="programlisting">  "crop-width"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 211 <p>The width of the video crop; default is equal to negotiated image width.</p>
 212 <p>Default value: 0</p>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="GstV4l2Sink--min-queued-bufs"></a><h3>The <code class="literal">"min-queued-bufs"</code> property</h3>
 217 <pre class="programlisting">  "min-queued-bufs"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 218 <p>Minimum number of queued bufs; v4l2sink won't dqbuf if the driver doesn't have more than this number (which normally you shouldn't change).</p>
 219 <p>Allowed values: &lt;= 16</p>
 220 <p>Default value: 1</p>
 221 </div>
 222 </div>
 223 </div>
 224 <div class="footer">
 225 <hr>
 226           Generated by GTK-Doc V1.18</div>
 227 </body>
 228 </html>