mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-08 15:45:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

Add docs for the Xoverlay interface.

Browse source 
Original commit message from CVS:
2005-11-28  Julien MOUTTE  <julien@moutte.net>

* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstxoverlay.sgml:
* gst-libs/gst/interfaces/xoverlay.c: Add docs for the Xoverlay
interface.
This commit is contained in:
Julien Moutte 2005-11-28 13:06:05 +00:00
parent 390aa5ec7c
commit 4a3356cd6f
5 changed files with 93 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
2005-11-28 Julien MOUTTE <julien@moutte.net>
* docs/libs/tmpl/gstcolorbalance.sgml:
* docs/libs/tmpl/gstmixer.sgml:
* docs/libs/tmpl/gstxoverlay.sgml:
* gst-libs/gst/interfaces/xoverlay.c: Add docs for the Xoverlay
interface.
2005-11-28 Julien MOUTTE <julien@moutte.net>
* sys/xvimage/xvimagesink.c: (gst_xvimagesink_xvimage_new):

2
docs/libs/tmpl/gstcolorbalance.sgml
View file

@ -2,7 +2,7 @@
gstcolorbalance
<!-- ##### SECTION Short_Description ##### -->
interface for adjusting color balance settings
<!-- ##### SECTION Long_Description ##### -->
<para>

2
docs/libs/tmpl/gstmixer.sgml
View file

@ -2,7 +2,7 @@
gstmixer
<!-- ##### SECTION Short_Description ##### -->
interface for elements that provide mixer operations
<!-- ##### SECTION Long_Description ##### -->
<para>

2
docs/libs/tmpl/gstxoverlay.sgml
View file

@ -2,7 +2,7 @@
gstxoverlay
<!-- ##### SECTION Short_Description ##### -->
interface for setting/getting a Window on elements supporting it.
<!-- ##### SECTION Long_Description ##### -->
<para>

82
gst-libs/gst/interfaces/xoverlay.c
View file

@ -19,6 +19,88 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstxoverlay
* @short_description: Interface for setting/getting a Window on elements
* supporting it.
*
* <refsect2>
* <para>
* The XOverlay interface is used for 2 main purposes :
* <itemizedlist>
* <listitem>
* <para>
* To get a grab on the Window where the video sink element is going to render.
* This is achieved by either being informed about the Window identifier that
* the video sink element generated, or by forcing the video sink element to use
* a specific Window identifier for rendering.
* </para>
* </listitem>
* <listitem>
* <para>
* To force a redrawing of the latest video frame the video sink element
* displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
* state, moving the Window around will damage its content. Application
* developers will want to handle the Expose events themselves and force the
* video sink element to refresh the Window's content.
* </para>
* </listitem>
* </itemizedlist>
* </para>
* <para>
* Using the Window created by the video sink is probably the simplest scenario,
* in some cases, though, it might not be flexible enough for application
* developers if they need to catch events such as mouse moves and button
* clicks.
* </para>
* <para>
* Setting a specific Window identifier on the video sink element is the most
* flexible solution but it has some issues. Indeed the application needs to set
* its Window identifier at the right time to avoid internal Window creation
* from the video sink element. To solve this issue a #GstMessage is posted on
* the bus to inform the application that it should set the Window identifier
* immediately. Here is an example on how to do that correctly:
* <programlisting>
* static GstBusSyncReply
* create_window (GstBus * bus, GstMessage * message, GstPipeline * pipeline)
* {
* XGCValues values;
* const GstStructure *s;
*
* s = gst_message_get_structure (message);
* if (!gst_structure_has_name (s, "prepare-xwindow-id")) {
* return GST_BUS_PASS;
* }
*
* win = XCreateSimpleWindow (disp, root, 0, 0, 320, 240, 0, 0, 0);
*
* XSetWindowBackgroundPixmap (disp, win, None);
*
* gc = XCreateGC (disp, win, 0, &amp;values);
*
* XMapRaised (disp, win);
*
* XSync (disp, FALSE);
*
* gst_x_overlay_set_xwindow_id (GST_X_OVERLAY (GST_MESSAGE_SRC (message)),
* win);
*
* return GST_BUS_DROP;
* }
* ...
* int
* main (int argc, char **argv)
* {
* ...
* bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
* gst_bus_set_sync_handler (bus, (GstBusSyncHandler) create_window, pipeline);
* ...
* }
* </programlisting>
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif