GI.GstVideo.Structs.VideoMeta

Extra buffer metadata describing image properties

Exported types

newtype VideoMeta

Memory-managed wrapper type.

Constructors

VideoMeta (ManagedPtr VideoMeta)

Instances

WrappedPtr VideoMeta

Defined in GI.GstVideo.Structs.VideoMeta

Methods

wrappedPtrCalloc :: IO (Ptr VideoMeta)

wrappedPtrCopy :: VideoMeta -> IO VideoMeta

wrappedPtrFree :: Maybe (GDestroyNotify VideoMeta)

tag ~ AttrSet => Constructible VideoMeta tag

Defined in GI.GstVideo.Structs.VideoMeta

Methods

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

newZeroVideoMeta :: MonadIO m => m VideoMeta

Construct a VideoMeta struct initialized to zero.

noVideoMeta :: Maybe VideoMeta

A convenience alias for Nothing :: Maybe VideoMeta.

Methods

getInfo

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

No description available in the introspection data.

map

videoMetaMap

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMeta

meta: a VideoMeta

-> Word32

plane: a plane

-> MapInfo

info: a MapInfo

-> [MapFlags]

flags: gstMapFlags

-> m (Bool, Ptr (), Int32)

Returns: TRUE if the map operation was successful.

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.

unmap

videoMetaUnmap

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMeta

meta: a VideoMeta

-> Word32

plane: a plane

-> MapInfo

info: a MapInfo

-> m Bool

Returns: TRUE if the memory was successfully unmapped.

Unmap a previously mapped plane with videoMetaMap.

Properties

buffer

the buffer this metadata belongs to

clearVideoMetaBuffer :: MonadIO m => VideoMeta -> m ()

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

clear #buffer

getVideoMetaBuffer :: MonadIO m => VideoMeta -> m (Maybe Buffer)

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

get videoMeta #buffer

setVideoMetaBuffer :: MonadIO m => VideoMeta -> Ptr Buffer -> m ()

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

set videoMeta [ #buffer := value ]

flags

additional video flags

getVideoMetaFlags :: MonadIO m => VideoMeta -> m [VideoFrameFlags]

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

get videoMeta #flags

setVideoMetaFlags :: MonadIO m => VideoMeta -> [VideoFrameFlags] -> m ()

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

set videoMeta [ #flags := value ]

format

the video format

getVideoMetaFormat :: MonadIO m => VideoMeta -> m VideoFormat

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

get videoMeta #format

setVideoMetaFormat :: MonadIO m => VideoMeta -> VideoFormat -> m ()

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

set videoMeta [ #format := value ]

height

the video height

getVideoMetaHeight :: MonadIO m => VideoMeta -> m Word32

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

get videoMeta #height

setVideoMetaHeight :: MonadIO m => VideoMeta -> Word32 -> m ()

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

set videoMeta [ #height := value ]

id

identifier of the frame

getVideoMetaId :: MonadIO m => VideoMeta -> m Int32

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

get videoMeta #id

setVideoMetaId :: MonadIO m => VideoMeta -> Int32 -> m ()

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

set videoMeta [ #id := value ]

map

No description available in the introspection data.

clearVideoMetaMap :: MonadIO m => VideoMeta -> m ()

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

clear #map

getVideoMetaMap :: MonadIO m => VideoMeta -> m (Maybe VideoMetaMapFieldCallback)

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

get videoMeta #map

setVideoMetaMap :: MonadIO m => VideoMeta -> FunPtr C_VideoMetaMapFieldCallback -> m ()

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

set videoMeta [ #map := value ]

meta

parent Meta

getVideoMetaMeta :: MonadIO m => VideoMeta -> m Meta

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

get videoMeta #meta

nPlanes

the number of planes in the image

getVideoMetaNPlanes :: MonadIO m => VideoMeta -> m Word32

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

get videoMeta #nPlanes

setVideoMetaNPlanes :: MonadIO m => VideoMeta -> Word32 -> m ()

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

set videoMeta [ #nPlanes := value ]

unmap

No description available in the introspection data.

clearVideoMetaUnmap :: MonadIO m => VideoMeta -> m ()

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

clear #unmap

getVideoMetaUnmap :: MonadIO m => VideoMeta -> m (Maybe VideoMetaUnmapFieldCallback)

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

get videoMeta #unmap

setVideoMetaUnmap :: MonadIO m => VideoMeta -> FunPtr C_VideoMetaUnmapFieldCallback -> m ()

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

set videoMeta [ #unmap := value ]

width

the video width

getVideoMetaWidth :: MonadIO m => VideoMeta -> m Word32

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

get videoMeta #width

setVideoMetaWidth :: MonadIO m => VideoMeta -> Word32 -> m ()

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

set videoMeta [ #width := value ]