docs/plugins/html/gst-plugins-base-plugins-xvimagesink.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>xvimagesink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-ximagesink.html" title="ximagesink">
  10 <link rel="next" href="ch02.html" title="gst-plugins-base Plugins">
  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-base-plugins-ximagesink.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 Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="ch02.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-base-plugins-xvimagesink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-xvimagesink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-xvimagesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-xvimagesink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-xvimagesink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-xvimagesink"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-xvimagesink.top_of_page"></a>xvimagesink</span></h2>
  40 <p>xvimagesink — A Xv based videosink</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-xvimagesink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstXvImageSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink-struct" title="struct GstXvImageSink">GstXvImageSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-xvimagesink.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/GstBaseSink.html">GstBaseSink</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideosink.html#GstVideoSink">GstVideoSink</a>
  57                            +----GstXvImageSink
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-base-plugins-xvimagesink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstXvImageSink implements
  64  <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-gstnavigation.html#GstNavigation">GstNavigation</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-gstcolorbalance.html#GstColorBalance">GstColorBalance</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>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-base-plugins-xvimagesink.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  70   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  71   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--display" title='The "display" property'>display</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  72   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  73   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--pixel-aspect-ratio" title='The "pixel-aspect-ratio" property'>pixel-aspect-ratio</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
  74   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  75   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--synchronous" title='The "synchronous" property'>synchronous</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  76   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--force-aspect-ratio" title='The "force-aspect-ratio" property'>force-aspect-ratio</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  77   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  78   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--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
  79   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--handle-events" title='The "handle-events" property'>handle-events</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  80   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--double-buffer" title='The "double-buffer" property'>double-buffer</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  81   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--handle-expose" title='The "handle-expose" property'>handle-expose</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  82   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--autopaint-colorkey" title='The "autopaint-colorkey" property'>autopaint-colorkey</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  83   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--colorkey" title='The "colorkey" property'>colorkey</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  84   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--draw-borders" title='The "draw-borders" property'>draw-borders</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  85   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--window-height" title='The "window-height" property'>window-height</a>"            <span class="type">guint64</span>               : Read
  86   "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--window-width" title='The "window-width" property'>window-width</a>"             <span class="type">guint64</span>               : Read
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="gst-plugins-base-plugins-xvimagesink.description"></a><h2>Description</h2>
  91 <div class="refsynopsisdiv">
  92 <h2>Synopsis</h2>
  93 <div class="refsect2">
  94 <a name="idp16140224"></a><h3>Element Information</h3>
  95 <div class="variablelist"><table border="0">
  96 <col align="left" valign="top">
  97 <tbody>
  98 <tr>
  99 <td><p><span class="term">plugin</span></p></td>
 100 <td>
 101             <a class="link" href="gst-plugins-base-plugins-plugin-xvimagesink.html#plugin-xvimagesink">xvimagesink</a>
 102           </td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term">author</span></p></td>
 106 <td>Julien Moutte &lt;julien@moutte.net&gt;</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term">class</span></p></td>
 110 <td>Sink/Video</td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 </div>
 115 <hr>
 116 <div class="refsect2">
 117 <a name="idp16147680"></a><h3>Element Pads</h3>
 118 <div class="variablelist"><table border="0">
 119 <col align="left" valign="top">
 120 <tbody>
 121 <tr>
 122 <td><p><span class="term">name</span></p></td>
 123 <td>sink</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term">direction</span></p></td>
 127 <td>sink</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term">presence</span></p></td>
 131 <td>always</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term">details</span></p></td>
 135 <td>video/x-raw-rgb, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"></span></p></td>
 139 <td> video/x-raw-yuv, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 </div>
 144 </div>
 145 <p>
 146 </p>
 147 </div>
 148 <div class="refsect1">
 149 <a name="gst-plugins-base-plugins-xvimagesink.details"></a><h2>Details</h2>
 150 <div class="refsect2">
 151 <a name="GstXvImageSink-struct"></a><h3>struct GstXvImageSink</h3>
 152 <pre class="programlisting">struct GstXvImageSink;</pre>
 153 <p>
 154 </p>
 155 </div>
 156 </div>
 157 <div class="refsect1">
 158 <a name="gst-plugins-base-plugins-xvimagesink.property-details"></a><h2>Property Details</h2>
 159 <div class="refsect2">
 160 <a name="GstXvImageSink--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>The brightness of the video.</p>
 163 <p>Allowed values: [-1000,1000]</p>
 164 <p>Default value: 0</p>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="GstXvImageSink--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
 169 <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>
 170 <p>The contrast of the video.</p>
 171 <p>Allowed values: [-1000,1000]</p>
 172 <p>Default value: 0</p>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="GstXvImageSink--display"></a><h3>The <code class="literal">"display"</code> property</h3>
 177 <pre class="programlisting">  "display"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 178 <p>X Display name.</p>
 179 <p>Default value: NULL</p>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="GstXvImageSink--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
 184 <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>
 185 <p>The hue of the video.</p>
 186 <p>Allowed values: [-1000,1000]</p>
 187 <p>Default value: 0</p>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="GstXvImageSink--pixel-aspect-ratio"></a><h3>The <code class="literal">"pixel-aspect-ratio"</code> property</h3>
 192 <pre class="programlisting">  "pixel-aspect-ratio"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 193 <p>The pixel aspect ratio of the device.</p>
 194 <p>Default value: "1/1"</p>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="GstXvImageSink--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
 199 <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>
 200 <p>The saturation of the video.</p>
 201 <p>Allowed values: [-1000,1000]</p>
 202 <p>Default value: 0</p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="GstXvImageSink--synchronous"></a><h3>The <code class="literal">"synchronous"</code> property</h3>
 207 <pre class="programlisting">  "synchronous"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 208 <p>When enabled, runs the X display in synchronous mode. (unrelated to A/V sync, used only for debugging).</p>
 209 <p>Default value: FALSE</p>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="GstXvImageSink--force-aspect-ratio"></a><h3>The <code class="literal">"force-aspect-ratio"</code> property</h3>
 214 <pre class="programlisting">  "force-aspect-ratio"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 215 <p>When enabled, scaling will respect original aspect ratio.</p>
 216 <p>Default value: FALSE</p>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="GstXvImageSink--device"></a><h3>The <code class="literal">"device"</code> property</h3>
 221 <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>
 222 <p>The number of the video adaptor.</p>
 223 <p>Default value: "0"</p>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="GstXvImageSink--device-name"></a><h3>The <code class="literal">"device-name"</code> property</h3>
 228 <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>
 229 <p>The name of the video adaptor.</p>
 230 <p>Default value: NULL</p>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="GstXvImageSink--handle-events"></a><h3>The <code class="literal">"handle-events"</code> property</h3>
 235 <pre class="programlisting">  "handle-events"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 236 <p>When enabled, XEvents will be selected and handled.</p>
 237 <p>Default value: TRUE</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstXvImageSink--double-buffer"></a><h3>The <code class="literal">"double-buffer"</code> property</h3>
 242 <pre class="programlisting">  "double-buffer"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 243 <p>Whether to double-buffer the output.</p>
 244 <p>Default value: TRUE</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="GstXvImageSink--handle-expose"></a><h3>The <code class="literal">"handle-expose"</code> property</h3>
 249 <pre class="programlisting">  "handle-expose"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 250 <p>When enabled, the current frame will always be drawn in response to X Expose events.</p>
 251 <p>Default value: TRUE</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="GstXvImageSink--autopaint-colorkey"></a><h3>The <code class="literal">"autopaint-colorkey"</code> property</h3>
 256 <pre class="programlisting">  "autopaint-colorkey"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 257 <p>Whether to autofill overlay with colorkey.</p>
 258 <p>Default value: TRUE</p>
 259 </div>
 260 <hr>
 261 <div class="refsect2">
 262 <a name="GstXvImageSink--colorkey"></a><h3>The <code class="literal">"colorkey"</code> property</h3>
 263 <pre class="programlisting">  "colorkey"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 264 <p>Color to use for the overlay mask.</p>
 265 <p>Default value: 0</p>
 266 </div>
 267 <hr>
 268 <div class="refsect2">
 269 <a name="GstXvImageSink--draw-borders"></a><h3>The <code class="literal">"draw-borders"</code> property</h3>
 270 <pre class="programlisting">  "draw-borders"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 271 <p>Draw black borders to fill unused area in force-aspect-ratio mode.</p>
 272 <p>Default value: TRUE</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="GstXvImageSink--window-height"></a><h3>The <code class="literal">"window-height"</code> property</h3>
 277 <pre class="programlisting">  "window-height"            <span class="type">guint64</span>               : Read</pre>
 278 <p>Height of the window.</p>
 279 <p>Default value: 0</p>
 280 </div>
 281 <hr>
 282 <div class="refsect2">
 283 <a name="GstXvImageSink--window-width"></a><h3>The <code class="literal">"window-width"</code> property</h3>
 284 <pre class="programlisting">  "window-width"             <span class="type">guint64</span>               : Read</pre>
 285 <p>Width of the window.</p>
 286 <p>Default value: 0</p>
 287 </div>
 288 </div>
 289 </div>
 290 <div class="footer">
 291 <hr>
 292           Generated by GTK-Doc V1.18</div>
 293 </body>
 294 </html>