GstVideo.VideoRegionOfInterestMeta

Fields

Name

Type

Access

Description

h

int

r/w

bounding box height

id

int

r/w

identifier of this particular ROI

meta

Gst.Meta

r/w

parent Gst.Meta

params

[object]

r/w

list of Gst.Structure containing element-specific params for downstream, see GstVideo.VideoRegionOfInterestMeta.add_param().

parent_id

int

r/w

identifier of its parent ROI, used f.i. for ROI hierarchisation.

roi_type

int

r/w

GQuark describing the semantic of the Roi (f.i. a face, a pedestrian)

w

int

r/w

bounding box width

x

int

r/w

x component of upper-left corner

y

int

r/w

y component of upper-left corner

Methods

class

get_info ()

add_param (s)

get_param (name)

Details

class GstVideo.VideoRegionOfInterestMeta

Extra buffer metadata describing an image region of interest

classmethod get_info()
Return type:

Gst.MetaInfo

add_param(s)
Parameters:

s (Gst.Structure) – a Gst.Structure

Attach element-specific parameters to self meant to be used by downstream elements which may handle this ROI. The name of s is used to identify the element these parameters are meant for.

This is typically used to tell encoders how they should encode this specific region. For example, a structure named “roi/x264enc” could be used to give the QP offsets this encoder should use when encoding the region described in self. Multiple parameters can be defined for the same meta so different encoders can be supported by cross platform applications).

New in version 1.14.

get_param(name)
Parameters:

name (str) – a name.

Returns:

a Gst.Structure

Return type:

Gst.Structure or None

Retrieve the parameter for self having name as structure name, or None if there is none.

New in version 1.14.