Class (GI Struct)

GstVideo-1.0 ▶ GstVideo ▶ VideoMeta

Extra buffer metadata describing image properties

This meta can also be used by downstream elements to specifiy their buffer layout requirements for upstream. Upstream should try to fit those requirements, if possible, in order to prevent buffer copies.

This is done by passing a custom Gst.Structure to gst_query_add_allocation_meta() when handling the ALLOCATION query. This structure should be named 'video-meta' and can have the following fields:

  • padding-top (uint): extra pixels on the top
  • padding-bottom (uint): extra pixels on the bottom
  • padding-left (uint): extra pixels on the left side
  • padding-right (uint): extra pixels on the right side The padding fields have the same semantic as GstVideo.VideoMeta.alignment and so represent the paddings requested on produced video buffers.
Index

Constructors

constructor

Properties

alignment flags format height id n_planes offset stride width $gtype

Methods

get_plane_height get_plane_size map set_alignment unmap get_info

Constructors

Properties

alignment: VideoAlignment
flags: GstVideo.VideoFrameFlags
format: GstVideo.VideoFormat
height: number
id: number
n_planes: number
offset: number[]
stride: number[]
width: number
$gtype: GType<VideoMeta>

Methods

  • Compute the padded height of each plane from meta (padded size divided by stride).

    It is not valid to call this function with a meta associated to a TILED video format.

    Returns [boolean, number[]]

    true if meta's alignment is valid and plane_height has been updated, false otherwise

  • Compute the size, in bytes, of each video plane described in meta including any padding and alignment constraint defined in meta->alignment.

    Returns [boolean, number[]]

    true if meta's alignment is valid and plane_size has been updated, false otherwise

  • Map the video plane with index plane in meta and return a pointer to the first byte of the plane and the stride of the plane.

    Parameters

    Returns [boolean, any, number]

    TRUE if the map operation was successful.