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.75.2">
   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.17 (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.properties" class="shortcut">Properties</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gst-plugins-good-plugins-v4l2sink"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-v4l2sink.top_of_page"></a>v4l2sink</span></h2>
  36 <p>v4l2sink</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gst-plugins-good-plugins-v4l2sink.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink" title="struct GstV4l2Sink">GstV4l2Sink</a>;
  43 </pre>
  44 </div>
  45 <div class="refsect1">
  46 <a name="gst-plugins-good-plugins-v4l2sink.properties"></a><h2>Properties</h2>
  47 <pre class="synopsis">
  48   "<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
  49   "<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
  50   "<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
  51   "<a class="link" href="gst-plugins-good-plugins-v4l2sink.html#GstV4l2Sink--flags" title='The "flags" property'>flags</a>"                    <span class="type">GstV4l2DeviceTypeFlags</span>  : Read
  52   "<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
  53   "<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
  54   "<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
  55   "<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
  56   "<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
  57   "<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
  58   "<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
  59   "<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
  60   "<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
  61   "<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
  62   "<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
  63   "<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
  64   "<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
  65   "<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
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="gst-plugins-good-plugins-v4l2sink.description"></a><h2>Description</h2>
  70 <p>
  71 v4l2sink can be used to display video to v4l2 devices (screen overlays
  72 provided by the graphics hardware, tv-out, etc)
  73 </p>
  74 <p>
  75 </p>
  76 <div class="refsect2">
  77 <a name="idp21431792"></a><h3>Example launch lines</h3>
  78 <div class="informalexample">
  79   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  80     <tbody>
  81       <tr>
  82         <td class="listing_lines" align="right"><pre>1</pre></td>
  83         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> v4l2sink device<span class="gtkdoc opt">=/</span>dev<span class="gtkdoc opt">/</span>video1</pre></td>
  84       </tr>
  85     </tbody>
  86   </table>
  87 </div>
  88  This pipeline displays a test pattern on /dev/video1
  89 <div class="informalexample">
  90   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  91     <tbody>
  92       <tr>
  93         <td class="listing_lines" align="right"><pre>1</pre></td>
  94         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> navigationtest <span class="gtkdoc opt">!</span> v4l2sink</pre></td>
  95       </tr>
  96     </tbody>
  97   </table>
  98 </div>
  99  A pipeline to test navigation events.
 100 While moving the mouse pointer over the test signal you will see a black box
 101 following the mouse pointer. If you press the mouse button somewhere on the
 102 video and release it somewhere else a green box will appear where you pressed
 103 the button and a red one where you released it. (The navigationtest element
 104 is part of gst-plugins-good.) You can observe here that even if the images
 105 are scaled through hardware the pointer coordinates are converted back to the
 106 original video frame geometry so that the box can be drawn to the correct
 107 position. This also handles borders correctly, limiting coordinates to the
 108 image area
 109 </div>
 110 <p>
 111 </p>
 112 <p>
 113 </p>
 114 </div>
 115 <div class="refsect1">
 116 <a name="gst-plugins-good-plugins-v4l2sink.details"></a><h2>Details</h2>
 117 <div class="refsect2">
 118 <a name="GstV4l2Sink"></a><h3>struct GstV4l2Sink</h3>
 119 <pre class="programlisting">struct GstV4l2Sink {
 120   GstVideoSink videosink;
 121 };
 122 </pre>
 123 <p>
 124 </p>
 125 </div>
 126 </div>
 127 <div class="refsect1">
 128 <a name="gst-plugins-good-plugins-v4l2sink.property-details"></a><h2>Property Details</h2>
 129 <div class="refsect2">
 130 <a name="GstV4l2Sink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 131 <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>
 132 <p>Device location.</p>
 133 <p>Default value: "/dev/video1"</p>
 134 </div>
 135 <hr>
 136 <div class="refsect2">
 137 <a name="GstV4l2Sink--device-fd"></a><h3>The <code class="literal">"device-fd"</code> property</h3>
 138 <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>
 139 <p>File descriptor of the device.</p>
 140 <p>Allowed values: &gt;= G_MAXULONG</p>
 141 <p>Default value: -1</p>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="GstV4l2Sink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 146 <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>
 147 <p>Name of the device.</p>
 148 <p>Default value: NULL</p>
 149 </div>
 150 <hr>
 151 <div class="refsect2">
 152 <a name="GstV4l2Sink--flags"></a><h3>The <code class="literal">"flags"</code> property</h3>
 153 <pre class="programlisting">  "flags"                    <span class="type">GstV4l2DeviceTypeFlags</span>  : Read</pre>
 154 <p>Device type flags.</p>
 155 </div>
 156 <hr>
 157 <div class="refsect2">
 158 <a name="GstV4l2Sink--overlay-height"></a><h3>The <code class="literal">"overlay-height"</code> property</h3>
 159 <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>
 160 <p>The height of the video overlay; default is equal to negotiated image height.</p>
 161 <p>Default value: 0</p>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="GstV4l2Sink--overlay-left"></a><h3>The <code class="literal">"overlay-left"</code> property</h3>
 166 <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>
 167 <p>The leftmost (x) coordinate of the video overlay; top left corner of screen is 0,0.</p>
 168 <p>Default value: 0</p>
 169 </div>
 170 <hr>
 171 <div class="refsect2">
 172 <a name="GstV4l2Sink--overlay-top"></a><h3>The <code class="literal">"overlay-top"</code> property</h3>
 173 <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>
 174 <p>The topmost (y) coordinate of the video overlay; top left corner of screen is 0,0.</p>
 175 <p>Default value: 0</p>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="GstV4l2Sink--overlay-width"></a><h3>The <code class="literal">"overlay-width"</code> property</h3>
 180 <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>
 181 <p>The width of the video overlay; default is equal to negotiated image width.</p>
 182 <p>Default value: 0</p>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="GstV4l2Sink--queue-size"></a><h3>The <code class="literal">"queue-size"</code> property</h3>
 187 <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>
 188 <p>Number of buffers to be enqueud in the driver in streaming mode.</p>
 189 <p>Allowed values: [1,16]</p>
 190 <p>Default value: 12</p>
 191 </div>
 192 <hr>
 193 <div class="refsect2">
 194 <a name="GstV4l2Sink--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
 195 <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>
 196 <p>Picture brightness, or more precisely, the black level.</p>
 197 <p>Default value: 0</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="GstV4l2Sink--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
 202 <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>
 203 <p>Picture contrast or luma gain.</p>
 204 <p>Default value: 0</p>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="GstV4l2Sink--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
 209 <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>
 210 <p>Hue or color balance.</p>
 211 <p>Default value: 0</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="GstV4l2Sink--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
 216 <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>
 217 <p>Picture color saturation or chroma gain.</p>
 218 <p>Default value: 0</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="GstV4l2Sink--crop-height"></a><h3>The <code class="literal">"crop-height"</code> property</h3>
 223 <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>
 224 <p>The height of the video crop; default is equal to negotiated image height.</p>
 225 <p>Default value: 0</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="GstV4l2Sink--crop-left"></a><h3>The <code class="literal">"crop-left"</code> property</h3>
 230 <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>
 231 <p>The leftmost (x) coordinate of the video crop; top left corner of image is 0,0.</p>
 232 <p>Default value: 0</p>
 233 </div>
 234 <hr>
 235 <div class="refsect2">
 236 <a name="GstV4l2Sink--crop-top"></a><h3>The <code class="literal">"crop-top"</code> property</h3>
 237 <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>
 238 <p>The topmost (y) coordinate of the video crop; top left corner of image is 0,0.</p>
 239 <p>Default value: 0</p>
 240 </div>
 241 <hr>
 242 <div class="refsect2">
 243 <a name="GstV4l2Sink--crop-width"></a><h3>The <code class="literal">"crop-width"</code> property</h3>
 244 <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>
 245 <p>The width of the video crop; default is equal to negotiated image width.</p>
 246 <p>Default value: 0</p>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="GstV4l2Sink--min-queued-bufs"></a><h3>The <code class="literal">"min-queued-bufs"</code> property</h3>
 251 <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>
 252 <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>
 253 <p>Allowed values: &lt;= 16</p>
 254 <p>Default value: 1</p>
 255 </div>
 256 </div>
 257 </div>
 258 <div class="footer">
 259 <hr>
 260           Generated by GTK-Doc V1.17</div>
 261 </body>
 262 </html>