<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>xvimagesink</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-ximagesink.html" title="ximagesink">
<link rel="next" href="ch02.html" title="gst-plugins-base Plugins">
-<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
"<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
"<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
"<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
- "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--window-height" title='The "window-height" property'>window-height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read
- "<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--window-width" title='The "window-width" property'>window-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read
+ "<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
+ "<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
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-xvimagesink.description"></a><h2>Description</h2>
-<p>
-XvImageSink renders video frames to a drawable (XWindow) on a local display
-using the XVideo extension. Rendering to a remote display is theorically
-possible but i doubt that the XVideo extension is actually available when
-connecting to a remote display. This element can receive a Window ID from the
-application through the XOverlay interface and will then render video frames
-in this drawable. If no Window ID was provided by the application, the
-element will create its own internal window and render into it.
-</p>
-<p>
-</p>
-<div class="refsect2">
-<a name="idp16288528"></a><h3>Scaling</h3>
-<p>
-The XVideo extension, when it's available, handles hardware accelerated
-scaling of video frames. This means that the element will just accept
-incoming video frames no matter their geometry and will then put them to the
-drawable scaling them on the fly. Using the <a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--force-aspect-ratio" title='The "force-aspect-ratio" property'><span class="type">"force-aspect-ratio"</span></a>
-property it is possible to enforce scaling with a constant aspect ratio,
-which means drawing black borders around the video frame.
-</p>
-</div>
-<p>
-</p>
-<hr>
-<div class="refsect2">
-<a name="idp16291104"></a><h3>Events</h3>
-<p>
-XvImageSink creates a thread to handle events coming from the drawable. There
-are several kind of events that can be grouped in 2 big categories: input
-events and window state related events. Input events will be translated to
-navigation events and pushed upstream for other elements to react on them.
-This includes events such as pointer moves, key press/release, clicks etc...
-Other events are used to handle the drawable appearance even when the data
-is not flowing (GST_STATE_PAUSED). That means that even when the element is
-paused, it will receive expose events from the drawable and draw the latest
-frame with correct borders/aspect-ratio.
-</p>
-</div>
-<p>
-</p>
-<hr>
-<div class="refsect2">
-<a name="idp16293088"></a><h3>Pixel aspect ratio</h3>
-<p>
-When changing state to GST_STATE_READY, XvImageSink will open a connection to
-the display specified in the <a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--display" title='The "display" property'><span class="type">"display"</span></a> property or the
-default display if nothing specified. Once this connection is open it will
-inspect the display configuration including the physical display geometry and
-then calculate the pixel aspect ratio. When receiving video frames with a
-different pixel aspect ratio, XvImageSink will use hardware scaling to
-display the video frames correctly on display's pixel aspect ratio.
-Sometimes the calculated pixel aspect ratio can be wrong, it is
-then possible to enforce a specific pixel aspect ratio using the
-<a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--pixel-aspect-ratio" title='The "pixel-aspect-ratio" property'><span class="type">"pixel-aspect-ratio"</span></a> property.
-</p>
-</div>
-<p>
-</p>
-<hr>
-<div class="refsect2">
-<a name="idp16296736"></a><h3>Examples</h3>
-<div class="informalexample">
- <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
- <tbody>
- <tr>
- <td class="listing_lines" align="right"><pre>1</pre></td>
- <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> xvimagesink</pre></td>
- </tr>
- </tbody>
- </table>
-</div>
- A pipeline to test hardware scaling.
-When the test video signal appears you can resize the window and see that
-video frames are scaled through hardware (no extra CPU cost).
-<div class="informalexample">
- <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
- <tbody>
- <tr>
- <td class="listing_lines" align="right"><pre>1</pre></td>
- <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> xvimagesink force<span class="gtkdoc opt">-</span>aspect<span class="gtkdoc opt">-</span>ratio<span class="gtkdoc opt">=</span><span class="keyword">true</span></pre></td>
- </tr>
- </tbody>
- </table>
-</div>
- Same pipeline with <a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink--force-aspect-ratio" title='The "force-aspect-ratio" property'><span class="type">"force-aspect-ratio"</span></a> property set to true
-You can observe the borders drawn around the scaled image respecting aspect
-ratio.
-<div class="informalexample">
- <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
- <tbody>
- <tr>
- <td class="listing_lines" align="right"><pre>1</pre></td>
- <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> xvimagesink</pre></td>
- </tr>
- </tbody>
- </table>
-</div>
- A pipeline to test navigation events.
-While moving the mouse pointer over the test signal you will see a black box
-following the mouse pointer. If you press the mouse button somewhere on the
-video and release it somewhere else a green box will appear where you pressed
-the button and a red one where you released it. (The navigationtest element
-is part of gst-plugins-good.) You can observe here that even if the images
-are scaled through hardware the pointer coordinates are converted back to the
-original video frame geometry so that the box can be drawn to the correct
-position. This also handles borders correctly, limiting coordinates to the
-image area
-<div class="informalexample">
- <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
- <tbody>
- <tr>
- <td class="listing_lines" align="right"><pre>1</pre></td>
- <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> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">-</span>yuv<span class="gtkdoc opt">,</span> pixel<span class="gtkdoc opt">-</span>aspect<span class="gtkdoc opt">-</span>ratio<span class="gtkdoc opt">=(</span>fraction<span class="gtkdoc opt">)</span><span class="number">4</span><span class="gtkdoc opt">/</span><span class="number">3</span> <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
- </tr>
- </tbody>
- </table>
-</div>
- This is faking a 4/3 pixel aspect ratio caps on video frames produced by
-videotestsrc, in most cases the pixel aspect ratio of the display will be
-1/1. This means that XvImageSink will have to do the scaling to convert
-incoming frames to a size that will match the display pixel aspect ratio
-(from 320x240 to 320x180 in this case). Note that you might have to escape
-some characters for your shell like '\(fraction\)'.
-<div class="informalexample">
- <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
- <tbody>
- <tr>
- <td class="listing_lines" align="right"><pre>1</pre></td>
- <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> xvimagesink hue<span class="gtkdoc opt">=</span><span class="number">100</span> saturation<span class="gtkdoc opt">=-</span><span class="number">100</span> brightness<span class="gtkdoc opt">=</span><span class="number">100</span></pre></td>
- </tr>
- </tbody>
- </table>
-</div>
- Demonstrates how to use the colorbalance interface.
-</div>
-<p>
-</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
-<a name="idp16304880"></a><h3>Element Information</h3>
+<a name="idp16140224"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
</div>
<hr>
<div class="refsect2">
-<a name="idp16312336"></a><h3>Element Pads</h3>
+<a name="idp16147680"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<a name="GstXvImageSink-struct"></a><h3>struct GstXvImageSink</h3>
<pre class="programlisting">struct GstXvImageSink;</pre>
<p>
-The <a class="link" href="gst-plugins-base-plugins-xvimagesink.html#GstXvImageSink"><span class="type">GstXvImageSink</span></a> data structure.
</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody></tbody>
-</table></div>
</div>
</div>
<div class="refsect1">
<div class="refsect2">
<a name="GstXvImageSink--synchronous"></a><h3>The <code class="literal">"synchronous"</code> property</h3>
<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>
-<p>When enabled, runs the X display in synchronous mode. (used only for debugging).</p>
+<p>When enabled, runs the X display in synchronous mode. (unrelated to A/V sync, used only for debugging).</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--double-buffer"></a><h3>The <code class="literal">"double-buffer"</code> property</h3>
<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>
-<p>
-Whether to double-buffer the output.
-</p>
+<p>Whether to double-buffer the output.</p>
<p>Default value: TRUE</p>
-<p class="since">Since 0.10.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--handle-expose"></a><h3>The <code class="literal">"handle-expose"</code> property</h3>
<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>
-<p>
-When enabled, the current frame will always be drawn in response to X
-Expose.
-</p>
+<p>When enabled, the current frame will always be drawn in response to X Expose events.</p>
<p>Default value: TRUE</p>
-<p class="since">Since 0.10.14</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--autopaint-colorkey"></a><h3>The <code class="literal">"autopaint-colorkey"</code> property</h3>
<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>
-<p>
-Whether to autofill overlay with colorkey
-</p>
+<p>Whether to autofill overlay with colorkey.</p>
<p>Default value: TRUE</p>
-<p class="since">Since 0.10.21</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--colorkey"></a><h3>The <code class="literal">"colorkey"</code> property</h3>
<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>
-<p>
-Color to use for the overlay mask.
-</p>
+<p>Color to use for the overlay mask.</p>
<p>Default value: 0</p>
-<p class="since">Since 0.10.21</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--draw-borders"></a><h3>The <code class="literal">"draw-borders"</code> property</h3>
<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>
-<p>
-Draw black borders when using GstXvImageSink:force-aspect-ratio to fill
-unused parts of the video area.
-</p>
+<p>Draw black borders to fill unused area in force-aspect-ratio mode.</p>
<p>Default value: TRUE</p>
-<p class="since">Since 0.10.21</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--window-height"></a><h3>The <code class="literal">"window-height"</code> property</h3>
-<pre class="programlisting"> "window-height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read</pre>
-<p>
-Actual height of the video window.
-</p>
+<pre class="programlisting"> "window-height" <span class="type">guint64</span> : Read</pre>
+<p>Height of the window.</p>
<p>Default value: 0</p>
-<p class="since">Since 0.10.32</p>
</div>
<hr>
<div class="refsect2">
<a name="GstXvImageSink--window-width"></a><h3>The <code class="literal">"window-width"</code> property</h3>
-<pre class="programlisting"> "window-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read</pre>
-<p>
-Actual width of the video window.
-</p>
+<pre class="programlisting"> "window-width" <span class="type">guint64</span> : Read</pre>
+<p>Width of the window.</p>
<p>Default value: 0</p>
-<p class="since">Since 0.10.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
- Generated by GTK-Doc V1.17</div>
+ Generated by GTK-Doc V1.18</div>
</body>
</html>
\ No newline at end of file
projects / framework / multimedia / gst-plugins-base0.10.git / blobdiff