GI.GstVideo.Structs.VideoRegionOfInterestMeta

Extra buffer metadata describing an image region of interest

Exported types

newtype VideoRegionOfInterestMeta

Memory-managed wrapper type.

Constructors

VideoRegionOfInterestMeta (ManagedPtr VideoRegionOfInterestMeta)

Instances

WrappedPtr VideoRegionOfInterestMeta

Defined in GI.GstVideo.Structs.VideoRegionOfInterestMeta

Methods

wrappedPtrCalloc :: IO (Ptr VideoRegionOfInterestMeta)

wrappedPtrCopy :: VideoRegionOfInterestMeta -> IO VideoRegionOfInterestMeta

wrappedPtrFree :: Maybe (GDestroyNotify VideoRegionOfInterestMeta)

tag ~ AttrSet => Constructible VideoRegionOfInterestMeta tag

Defined in GI.GstVideo.Structs.VideoRegionOfInterestMeta

Methods

new :: MonadIO m => (ManagedPtr VideoRegionOfInterestMeta -> VideoRegionOfInterestMeta) -> [AttrOp VideoRegionOfInterestMeta tag] -> m VideoRegionOfInterestMeta

newZeroVideoRegionOfInterestMeta :: MonadIO m => m VideoRegionOfInterestMeta

Construct a VideoRegionOfInterestMeta struct initialized to zero.

noVideoRegionOfInterestMeta :: Maybe VideoRegionOfInterestMeta

A convenience alias for Nothing :: Maybe VideoRegionOfInterestMeta.

Methods

addParam

videoRegionOfInterestMetaAddParam

Arguments

:: (HasCallStack, MonadIO m)

=> VideoRegionOfInterestMeta

meta: a VideoRegionOfInterestMeta

-> Structure

s: a Structure

-> m ()

Attach element-specific parameters to meta 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 meta. Multiple parameters can be defined for the same meta so different encoders can be supported by cross platform applications).

Since: 1.14

getInfo

videoRegionOfInterestMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo

No description available in the introspection data.

getParam

videoRegionOfInterestMetaGetParam

Arguments

:: (HasCallStack, MonadIO m)

=> VideoRegionOfInterestMeta

meta: a VideoRegionOfInterestMeta

-> Text

name: a name.

-> m (Maybe Structure)

Returns: a Structure

Retrieve the parameter for meta having name as structure name, or Nothing if there is none.

Since: 1.14

Properties

h

bounding box height

getVideoRegionOfInterestMetaH :: MonadIO m => VideoRegionOfInterestMeta -> m Word32

Get the value of the “h” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #h

setVideoRegionOfInterestMetaH :: MonadIO m => VideoRegionOfInterestMeta -> Word32 -> m ()

Set the value of the “h” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #h := value ]

id

identifier of this particular ROI

getVideoRegionOfInterestMetaId :: MonadIO m => VideoRegionOfInterestMeta -> m Int32

Get the value of the “id” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #id

setVideoRegionOfInterestMetaId :: MonadIO m => VideoRegionOfInterestMeta -> Int32 -> m ()

Set the value of the “id” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #id := value ]

meta

parent Meta

getVideoRegionOfInterestMetaMeta :: MonadIO m => VideoRegionOfInterestMeta -> m Meta

Get the value of the “meta” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #meta

params

list of Structure containing element-specific params for downstream, see gst_video_region_of_interest_meta_add_params(). (Since: 1.14)

clearVideoRegionOfInterestMetaParams :: MonadIO m => VideoRegionOfInterestMeta -> m ()

Set the value of the “params” field to Nothing. When overloading is enabled, this is equivalent to

clear #params

getVideoRegionOfInterestMetaParams :: MonadIO m => VideoRegionOfInterestMeta -> m [Ptr ()]

Get the value of the “params” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #params

setVideoRegionOfInterestMetaParams :: MonadIO m => VideoRegionOfInterestMeta -> Ptr (GList (Ptr ())) -> m ()

Set the value of the “params” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #params := value ]

parentId

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

getVideoRegionOfInterestMetaParentId :: MonadIO m => VideoRegionOfInterestMeta -> m Int32

Get the value of the “parent_id” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #parentId

setVideoRegionOfInterestMetaParentId :: MonadIO m => VideoRegionOfInterestMeta -> Int32 -> m ()

Set the value of the “parent_id” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #parentId := value ]

roiType

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

getVideoRegionOfInterestMetaRoiType :: MonadIO m => VideoRegionOfInterestMeta -> m Word32

Get the value of the “roi_type” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #roiType

setVideoRegionOfInterestMetaRoiType :: MonadIO m => VideoRegionOfInterestMeta -> Word32 -> m ()

Set the value of the “roi_type” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #roiType := value ]

w

bounding box width

getVideoRegionOfInterestMetaW :: MonadIO m => VideoRegionOfInterestMeta -> m Word32

Get the value of the “w” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #w

setVideoRegionOfInterestMetaW :: MonadIO m => VideoRegionOfInterestMeta -> Word32 -> m ()

Set the value of the “w” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #w := value ]

x

x component of upper-left corner

getVideoRegionOfInterestMetaX :: MonadIO m => VideoRegionOfInterestMeta -> m Word32

Get the value of the “x” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #x

setVideoRegionOfInterestMetaX :: MonadIO m => VideoRegionOfInterestMeta -> Word32 -> m ()

Set the value of the “x” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #x := value ]

y

y component of upper-left corner

getVideoRegionOfInterestMetaY :: MonadIO m => VideoRegionOfInterestMeta -> m Word32

Get the value of the “y” field. When overloading is enabled, this is equivalent to

get videoRegionOfInterestMeta #y

setVideoRegionOfInterestMetaY :: MonadIO m => VideoRegionOfInterestMeta -> Word32 -> m ()

Set the value of the “y” field. When overloading is enabled, this is equivalent to

set videoRegionOfInterestMeta [ #y := value ]