docs/plugins/html/gst-plugins-base-plugins-ximagesink.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>ximagesink</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-vorbistag.html" title="vorbistag">
  10 <link rel="next" href="gst-plugins-base-plugins-xvimagesink.html" title="xvimagesink">
  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-vorbistag.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="gst-plugins-base-plugins-xvimagesink.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-ximagesink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-ximagesink.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-ximagesink.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-ximagesink.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-ximagesink.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-ximagesink"></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-ximagesink.top_of_page"></a>ximagesink</span></h2>
  40 <p>ximagesink — A standard X 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-ximagesink.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstXImageSink"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink-struct" title="struct GstXImageSink">GstXImageSink</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-ximagesink.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                            +----GstXImageSink
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-base-plugins-ximagesink.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstXImageSink 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> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstxoverlay.html#GstXOverlay">GstXOverlay</a>.</p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-base-plugins-ximagesink.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  70   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  71   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  72   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  73   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  74   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--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
  75   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--window-height" title='The "window-height" property'>window-height</a>"            <span class="type">guint64</span>               : Read
  76   "<a class="link" href="gst-plugins-base-plugins-ximagesink.html#GstXImageSink--window-width" title='The "window-width" property'>window-width</a>"             <span class="type">guint64</span>               : Read
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="gst-plugins-base-plugins-ximagesink.description"></a><h2>Description</h2>
  81 <div class="refsynopsisdiv">
  82 <h2>Synopsis</h2>
  83 <div class="refsect2">
  84 <a name="idp14442752"></a><h3>Element Information</h3>
  85 <div class="variablelist"><table border="0">
  86 <col align="left" valign="top">
  87 <tbody>
  88 <tr>
  89 <td><p><span class="term">plugin</span></p></td>
  90 <td>
  91             <a class="link" href="gst-plugins-base-plugins-plugin-ximagesink.html#plugin-ximagesink">ximagesink</a>
  92           </td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term">author</span></p></td>
  96 <td>Julien Moutte &lt;julien@moutte.net&gt;</td>
  97 </tr>
  98 <tr>
  99 <td><p><span class="term">class</span></p></td>
 100 <td>Sink/Video</td>
 101 </tr>
 102 </tbody>
 103 </table></div>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="idp14450208"></a><h3>Element Pads</h3>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody>
 111 <tr>
 112 <td><p><span class="term">name</span></p></td>
 113 <td>sink</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">direction</span></p></td>
 117 <td>sink</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">presence</span></p></td>
 121 <td>always</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">details</span></p></td>
 125 <td>video/x-raw-rgb, framerate=(fraction)[ 0/1, 2147483647/1 ], width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ]</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 </div>
 131 <p>
 132 </p>
 133 </div>
 134 <div class="refsect1">
 135 <a name="gst-plugins-base-plugins-ximagesink.details"></a><h2>Details</h2>
 136 <div class="refsect2">
 137 <a name="GstXImageSink-struct"></a><h3>struct GstXImageSink</h3>
 138 <pre class="programlisting">struct GstXImageSink;</pre>
 139 <p>
 140 </p>
 141 </div>
 142 </div>
 143 <div class="refsect1">
 144 <a name="gst-plugins-base-plugins-ximagesink.property-details"></a><h2>Property Details</h2>
 145 <div class="refsect2">
 146 <a name="GstXImageSink--display"></a><h3>The <code class="literal">"display"</code> property</h3>
 147 <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>
 148 <p>X Display name.</p>
 149 <p>Default value: NULL</p>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="GstXImageSink--pixel-aspect-ratio"></a><h3>The <code class="literal">"pixel-aspect-ratio"</code> property</h3>
 154 <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>
 155 <p>The pixel aspect ratio of the device.</p>
 156 <p>Default value: "1/1"</p>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="GstXImageSink--synchronous"></a><h3>The <code class="literal">"synchronous"</code> property</h3>
 161 <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>
 162 <p>When enabled, runs the X display in synchronous mode. (unrelated to A/V sync, used only for debugging).</p>
 163 <p>Default value: FALSE</p>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="GstXImageSink--force-aspect-ratio"></a><h3>The <code class="literal">"force-aspect-ratio"</code> property</h3>
 168 <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>
 169 <p>When enabled, reverse caps negotiation (scaling) will respect original aspect ratio.</p>
 170 <p>Default value: FALSE</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GstXImageSink--handle-events"></a><h3>The <code class="literal">"handle-events"</code> property</h3>
 175 <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>
 176 <p>When enabled, XEvents will be selected and handled.</p>
 177 <p>Default value: TRUE</p>
 178 </div>
 179 <hr>
 180 <div class="refsect2">
 181 <a name="GstXImageSink--handle-expose"></a><h3>The <code class="literal">"handle-expose"</code> property</h3>
 182 <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>
 183 <p>When enabled, the current frame will always be drawn in response to X Expose events.</p>
 184 <p>Default value: TRUE</p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="GstXImageSink--window-height"></a><h3>The <code class="literal">"window-height"</code> property</h3>
 189 <pre class="programlisting">  "window-height"            <span class="type">guint64</span>               : Read</pre>
 190 <p>Height of the window.</p>
 191 <p>Default value: 0</p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="GstXImageSink--window-width"></a><h3>The <code class="literal">"window-width"</code> property</h3>
 196 <pre class="programlisting">  "window-width"             <span class="type">guint64</span>               : Read</pre>
 197 <p>Width of the window.</p>
 198 <p>Default value: 0</p>
 199 </div>
 200 </div>
 201 </div>
 202 <div class="footer">
 203 <hr>
 204           Generated by GTK-Doc V1.18</div>
 205 </body>
 206 </html>