Gst.Video.OverlayComposition – gstreamer-video-1.0

Description:

[ CCode ( ref_function = "gst_video_overlay_composition_ref" , type_id = "gst_video_overlay_composition_get_type ()" , unref_function = "gst_video_overlay_composition_unref" ) ]
[ Compact ]
[ GIR ( name = "VideoOverlayComposition" ) ]
public class OverlayComposition : MiniObject

Functions to create and handle overlay compositions on video buffers.

An overlay composition describes one or more overlay rectangles to be blended on top of a video buffer.

This API serves two main purposes:

* it can be used to attach overlay information (subtitles or logos) to non-raw video buffers such as GL/VAAPI/VDPAU surfaces. The actual blending of the overlay can then be done by e.g. the video sink that processes these non-raw buffers.

* it can also be used to blend overlay rectangles on top of raw video buffers, thus consolidating blending functionality for raw video in one place.

Together, this allows existing overlay elements to easily handle raw and non-raw video as input in without major changes (once the overlays have been put into a OverlayComposition object anyway) - for raw video the overlay can just use the blending function to blend the data on top of the video, and for surface buffers it can just attach them to the buffer and let the sink render the overlays.

Namespace: Gst.Video

Content:

Creation methods:

public OverlayComposition (OverlayRectangle? rectangle)

Creates a new video overlay composition object to hold one or more overlay rectangles.

Methods:

public void add_rectangle (OverlayRectangle rectangle)

Adds an overlay rectangle to an existing overlay composition object.

public bool blend (Frame video_buf)

Blends the overlay rectangles in this on top of the raw video data contained in video_buf.

public OverlayComposition copy ()

Makes a copy of this and all contained rectangles, so that it is possible to modify the composition and contained rectangles (e.

public unowned OverlayRectangle get_rectangle (uint n)

Returns the n-th OverlayRectangle contained in this.

public uint get_seqnum ()

Returns the sequence number of this composition.

public OverlayComposition make_writable ()

Takes ownership of this and returns a version of this that is writable (i.

public uint n_rectangles ()

Returns the number of OverlayRectangles contained in this.

Inherited Members:

OverlayComposition

Object Hierarchy:

Description:

Content:

Creation methods:

Methods:

Inherited Members: