org.freedesktop.gstreamer.interfaces

Class VideoOverlay

java.lang.Object

org.freedesktop.gstreamer.interfaces.VideoOverlay

All Implemented Interfaces:

GObject.GInterface

public class VideoOverlay
extends Object

Interface for setting/getting a window system resource on elements supporting it to configure a window into which to render a video.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	element

Method Summary

Modifier and Type	Method and Description
void	expose() Tell an overlay that it has been exposed.
Element	getGObject() Get the GObject implementing this interface.
void	handleEvent(boolean handle_events) Tell an overlay that it should handle events from the window system.
static boolean	isPrepareWindowHandleMessage(Message message) Convenience function to check if the given message is a "prepare-window-handle".
boolean	setRenderRectangle(int x, int y, int width, int height) Configure a subregion as a video target within the window set by setWindowHandle(long).
void	setWindowHandle(long handle) Sets the native window for the Element to use to display video.
static VideoOverlay	wrap(Element element) Wraps the Element in a XOverlay interface

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

element

protected final Element element

Method Detail

wrap

public static VideoOverlay wrap(Element element)

Wraps the Element in a XOverlay interface

Parameters:

element - the element to use as a XOverlay

Returns:

a XOverlay for the element

isPrepareWindowHandleMessage

public static boolean isPrepareWindowHandleMessage(Message message)

Convenience function to check if the given message is a "prepare-window-handle". This useful for setup native window handles with BusSyncReply.

Parameters:

message -

Returns:

setWindowHandle

public void setWindowHandle(long handle)

Sets the native window for the Element to use to display video.

Parameters:

handle - A native handle to use to display video.

expose

public void expose()

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

handleEvent

public void handleEvent(boolean handle_events)

Tell an overlay that it should handle events from the window system. These events are forwared upstream as navigation events. In some window system, events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely from the XOverlay.

setRenderRectangle

public boolean setRenderRectangle(int x,
                                  int y,
                                  int width,
                                  int height)

Configure a subregion as a video target within the window set by setWindowHandle(long). If this is not used or not supported the video will fill the area of the window set as the overlay to 100%. By specifying the rectangle, the video can be overlaid to a specific region of that window only. After setting the new rectangle one should call expose() to force a redraw. To unset the region pass -1 for the width and height parameters. This method is needed for non fullscreen video overlay in UI toolkits that do not support subwindows.

Parameters:

x -

y -

width -

height -

getGObject

public Element getGObject()

Description copied from interface: GObject.GInterface

Get the GObject implementing this interface.

Specified by:

getGObject in interface GObject.GInterface

Returns:

implementing GObject