gstxoverlay

gstxoverlay — interface for setting/getting a Window on elements supporting it.

Synopsis


#include <gst/interfaces/xoverlay.h>


            GstXOverlay;
            GstXOverlayClass;
void        gst_x_overlay_set_xwindow_id    (GstXOverlay *overlay,
                                             gulong xwindow_id);
void        gst_x_overlay_got_xwindow_id    (GstXOverlay *overlay,
                                             gulong xwindow_id);
void        gst_x_overlay_prepare_xwindow_id
                                            (GstXOverlay *overlay);
void        gst_x_overlay_expose            (GstXOverlay *overlay);

Object Hierarchy


  GInterface
   +----GstXOverlay

Prerequisites

GstXOverlay requires GstImplementsInterface and GstElement.

Description

Details

GstXOverlay

typedef struct _GstXOverlay GstXOverlay;


GstXOverlayClass

typedef struct {
  GTypeInterface klass;

  /* virtual functions */
  void (* set_xwindow_id) (GstXOverlay *overlay,
                           gulong       xwindow_id);

  void (* expose)         (GstXOverlay *overlay);
} GstXOverlayClass;


gst_x_overlay_set_xwindow_id ()

void        gst_x_overlay_set_xwindow_id    (GstXOverlay *overlay,
                                             gulong xwindow_id);

This will call the video overlay's set_xwindow_id method. You should use this method to tell to a XOverlay to display video output to a specific XWindow. Passing 0 as the xwindow_id will tell the overlay to stop using that window and create an internal one.

overlay : a GstXOverlay to set the XWindow on.
xwindow_id : a XID referencing the XWindow.

gst_x_overlay_got_xwindow_id ()

void        gst_x_overlay_got_xwindow_id    (GstXOverlay *overlay,
                                             gulong xwindow_id);

This will post a "have-xwindow-id" element message on the bus.

This function should only be used by video overlay plugin developers.

overlay : a GstXOverlay which got a XWindow.
xwindow_id : a XID referencing the XWindow.

gst_x_overlay_prepare_xwindow_id ()

void        gst_x_overlay_prepare_xwindow_id
                                            (GstXOverlay *overlay);

This will post a "prepare-xwindow-id" element message on the bus to give applications an opportunity to call gst_x_overlay_set_xwindow_id() before a plugin creates its own window.

This function should only be used by video overlay plugin developers.

overlay : a GstXOverlay which does not yet have an XWindow.

gst_x_overlay_expose ()

void        gst_x_overlay_expose            (GstXOverlay *overlay);

Tell an overlay that it has been exposed. This will redraw the current frame in the drawable even if the pipeline is PAUSED.

overlay : a GstXOverlay to expose.