gstvideo.video_overlay_rectangle
Module for [VideoOverlayRectangle] class
class VideoOverlayRectangle
Types 1
An opaque video overlay rectangle object. A rectangle contains a single overlay rectangle which can be added to a composition.
Methods
VideoOverlayRectangle self()Returns `this`, for use in `with` statements.gstvideo.video_overlay_rectangle.VideoOverlayRectangle newRaw(gst.buffer.Buffer pixels, int renderX, int renderY, uint renderWidth, uint renderHeight, gstvideo.types.VideoOverlayFormatFlags flags)Creates a new video overlay rectangle with ARGB or AYUV pixel data. The layout in case of ARGB of the components in memory is B-G-R-A on little-endian platforms (corresponding to #GSTVIDEOFORMATBGR...gstvideo.video_overlay_rectangle.VideoOverlayRectangle copy()Makes a copy of rectangle, so that it is possible to modify it (e.g. to change the render co-ordinates or render dimension). The actual overlay pixel data buffers contained in the rectangle are not...gstvideo.types.VideoOverlayFormatFlags getFlags()Retrieves the flags associated with a #GstVideoOverlayRectangle. This is useful if the caller can handle both premultiplied alpha and non premultiplied alpha, for example. By knowing whether the re...float getGlobalAlpha()Retrieves the global-alpha value associated with a #GstVideoOverlayRectangle. Returns: the global-alpha value associated with the rectangle.gst.buffer.Buffer getPixelsUnscaledArgb(gstvideo.types.VideoOverlayFormatFlags flags)Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be r...gst.buffer.Buffer getPixelsUnscaledAyuv(gstvideo.types.VideoOverlayFormatFlags flags)Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be r...gst.buffer.Buffer getPixelsUnscaledRaw(gstvideo.types.VideoOverlayFormatFlags flags)Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be r...bool getRenderRectangle(out int renderX, out int renderY, out uint renderWidth, out uint renderHeight)Retrieves the render position and render dimension of the overlay rectangle on the video.uint getSeqnum()Returns the sequence number of this rectangle. Sequence numbers are monotonically increasing and unique for overlay compositions and rectangles (meaning there will never be a rectangle with the sam...void setGlobalAlpha(float globalAlpha)Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per- pixel alpha values are multiplied with this value. Valid values: 0 <= global_alpha <= 1; 1 to deactivate.void setRenderRectangle(int renderX, int renderY, uint renderWidth, uint renderHeight)Sets the render position and dimensions of the rectangle on the video. This function is mainly for elements that modify the size of the video in some way (e.g. through scaling or cropping) and need...