GstPlay.PlayVideoOverlayVideoRenderer¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
the video output element to use ( |
||
r/w/c |
Window handle to embed the video into |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class GstPlay.PlayVideoOverlayVideoRenderer(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
New in version 1.20.
- classmethod new(window_handle)¶
-
New in version 1.20.
- classmethod new_with_sink(window_handle, video_sink)¶
- Parameters:
window_handle (
object
orNone
) – Window handle to use orNone
video_sink (
Gst.Element
) – the custom video_sink element to be set for the video renderer
- Return type:
New in version 1.20.
- expose()¶
Tell an overlay that it has been exposed. This will redraw the current frame in the drawable even if the pipeline is PAUSED.
New in version 1.20.
- get_render_rectangle()¶
- Returns:
- x:
the horizontal offset of the render area inside the window
- y:
the vertical offset of the render area inside the window
- width:
the width of the render area inside the window
- height:
the height of the render area inside the window
- Return type:
Return the currently configured render rectangle. See
GstPlay.PlayVideoOverlayVideoRenderer.set_render_rectangle
() for details.New in version 1.20.
- get_window_handle()¶
-
New in version 1.20.
- set_render_rectangle(x, y, width, height)¶
- Parameters:
Configure a subregion as a video target within the window set by
GstPlay.PlayVideoOverlayVideoRenderer.set_window_handle
(). 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 callGstPlay.PlayVideoOverlayVideoRenderer.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.
New in version 1.20.