Gjsify LogoGjsify Logo

An opaque video overlay rectangle object. A rectangle contains a single overlay rectangle which can be added to a composition.

record

Hierarchy

  • VideoOverlayRectangle

Index

Constructors

Properties

name: string

Methods

  • 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 copied.

    Returns VideoOverlayRectangle

  • 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 rectangle uses premultiplied or not, it can request the pixel data in the format it is stored in, to avoid unnecessary conversion.

    Returns VideoOverlayFormatFlags

  • get_global_alpha(): number
  • 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 retrieved using gst_video_overlay_rectangle_get_render_rectangle().

    Parameters

    • flags: VideoOverlayFormatFlags

      flags. If a global_alpha value != 1 is set for the rectangle, the caller should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data.

    Returns Gst.Buffer

  • 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 retrieved using gst_video_overlay_rectangle_get_render_rectangle().

    Parameters

    • flags: VideoOverlayFormatFlags

      flags. If a global_alpha value != 1 is set for the rectangle, the caller should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data.

    Returns Gst.Buffer

  • 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 retrieved using gst_video_overlay_rectangle_get_render_rectangle().

    Parameters

    • flags: VideoOverlayFormatFlags

      flags. If a global_alpha value != 1 is set for the rectangle, the caller should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data.

    Returns Gst.Buffer

  • get_render_rectangle(): [boolean, number, number, number, number]
  • Retrieves the render position and render dimension of the overlay rectangle on the video.

    Returns [boolean, number, number, number, number]

  • get_seqnum(): number
  • 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 same sequence number as a composition).

    Using the sequence number of a rectangle as an indicator for changed pixel-data of a rectangle is dangereous. Some API calls, like e.g. gst_video_overlay_rectangle_set_global_alpha(), automatically update the per rectangle sequence number, which is misleading for renderers/ consumers, that handle global-alpha themselves. For them the pixel-data returned by gst_video_overlay_rectangle_get_pixels_*() won't be different for different global-alpha values. In this case a renderer could also use the GstBuffer pointers as a hint for changed pixel-data.

    Returns number

  • set_global_alpha(global_alpha: number): void
  • 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.

    rectangle must be writable, meaning its refcount must be 1. You can make the rectangles inside a #GstVideoOverlayComposition writable using gst_video_overlay_composition_make_writable() or gst_video_overlay_composition_copy().

    Parameters

    • global_alpha: number

      Global alpha value (0 to 1.0)

    Returns void

  • set_render_rectangle(render_x: number, render_y: number, render_width: number, render_height: number): void
  • 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 to adjust the details of any overlays to match the operation that changed the size.

    rectangle must be writable, meaning its refcount must be 1. You can make the rectangles inside a #GstVideoOverlayComposition writable using gst_video_overlay_composition_make_writable() or gst_video_overlay_composition_copy().

    Parameters

    • render_x: number

      render X position of rectangle on video

    • render_y: number

      render Y position of rectangle on video

    • render_width: number

      render width of rectangle

    • render_height: number

      render height of rectangle

    Returns void

  • 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 #GST_VIDEO_FORMAT_BGRA) and A-R-G-B on big-endian platforms (corresponding to #GST_VIDEO_FORMAT_ARGB). In other words, pixels are treated as 32-bit words and the lowest 8 bits then contain the blue component value and the highest 8 bits contain the alpha component value. Unless specified in the flags, the RGB values are non-premultiplied. This is the format that is used by most hardware, and also many rendering libraries such as Cairo, for example. The pixel data buffer must have #GstVideoMeta set.

    Parameters

    • pixels: Gst.Buffer

      a #GstBuffer pointing to the pixel memory

    • render_x: number

      the X co-ordinate on the video where the top-left corner of this overlay rectangle should be rendered to

    • render_y: number

      the Y co-ordinate on the video where the top-left corner of this overlay rectangle should be rendered to

    • render_width: number

      the render width of this rectangle on the video

    • render_height: number

      the render height of this rectangle on the video

    • flags: VideoOverlayFormatFlags

      flags

    Returns VideoOverlayRectangle

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method