gi-gst-1.0.30: GStreamer bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gst.Structs.MetaInfo

Description

The MetaInfo provides information about a specific metadata structure.

Synopsis

Exported types

newtype MetaInfo Source #

Memory-managed wrapper type.

Constructors

MetaInfo (ManagedPtr MetaInfo) 

Instances

Instances details
Eq MetaInfo Source # 
Instance details

Defined in GI.Gst.Structs.MetaInfo

BoxedPtr MetaInfo Source # 
Instance details

Defined in GI.Gst.Structs.MetaInfo

CallocPtr MetaInfo Source # 
Instance details

Defined in GI.Gst.Structs.MetaInfo

ManagedPtrNewtype MetaInfo Source # 
Instance details

Defined in GI.Gst.Structs.MetaInfo

Methods

toManagedPtr :: MetaInfo -> ManagedPtr MetaInfo

tag ~ 'AttrSet => Constructible MetaInfo tag Source # 
Instance details

Defined in GI.Gst.Structs.MetaInfo

Methods

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

newZeroMetaInfo :: MonadIO m => m MetaInfo Source #

Construct a MetaInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

isCustom, register.

Getters

None.

Setters

None.

isCustom

metaInfoIsCustom Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MetaInfo 
-> m Bool

Returns: whether info was registered as a CustomMeta with metaRegisterCustom

No description available in the introspection data.

Since: 1.20

register

metaInfoRegister Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MetaInfo

info: a new MetaInfo created by gst_meta_info_new()

-> m MetaInfo

Returns: the registered meta

Registers a new meta.

Use the structure returned by gst_meta_info_new(), it consumes it and the structure shouldnt be used after. The one returned by the function can be kept.

Since: 1.24

Properties

api

tag identifying the metadata structure and api

getMetaInfoApi :: MonadIO m => MetaInfo -> m GType Source #

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

get metaInfo #api

setMetaInfoApi :: MonadIO m => MetaInfo -> GType -> m () Source #

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

set metaInfo [ #api := value ]

clearFunc

Function for clearing the metadata, or Nothing if not supported by this meta. This is called by the buffer pool when a buffer is returned for pooled metas.

Since: 1.24

clearMetaInfoClearFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #clearFunc

getMetaInfoClearFunc :: MonadIO m => MetaInfo -> m (Maybe MetaClearFunction) Source #

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

get metaInfo #clearFunc

setMetaInfoClearFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaClearFunction -> m () Source #

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

set metaInfo [ #clearFunc := value ]

deserializeFunc

Function for deserializing the metadata, or Nothing if not supported by this meta.

Since: 1.24

clearMetaInfoDeserializeFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #deserializeFunc

getMetaInfoDeserializeFunc :: MonadIO m => MetaInfo -> m (Maybe MetaDeserializeFunction) Source #

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

get metaInfo #deserializeFunc

setMetaInfoDeserializeFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaDeserializeFunction -> m () Source #

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

set metaInfo [ #deserializeFunc := value ]

freeFunc

function for freeing the metadata

clearMetaInfoFreeFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #freeFunc

getMetaInfoFreeFunc :: MonadIO m => MetaInfo -> m (Maybe MetaFreeFunction) Source #

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

get metaInfo #freeFunc

setMetaInfoFreeFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaFreeFunction -> m () Source #

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

set metaInfo [ #freeFunc := value ]

initFunc

function for initializing the metadata

clearMetaInfoInitFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #initFunc

getMetaInfoInitFunc :: MonadIO m => MetaInfo -> m (Maybe MetaInitFunction) Source #

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

get metaInfo #initFunc

setMetaInfoInitFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaInitFunction -> m () Source #

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

set metaInfo [ #initFunc := value ]

serializeFunc

Function for serializing the metadata, or Nothing if not supported by this meta.

Since: 1.24

clearMetaInfoSerializeFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #serializeFunc

getMetaInfoSerializeFunc :: MonadIO m => MetaInfo -> m (Maybe MetaSerializeFunction) Source #

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

get metaInfo #serializeFunc

setMetaInfoSerializeFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaSerializeFunction -> m () Source #

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

set metaInfo [ #serializeFunc := value ]

size

size of the metadata

getMetaInfoSize :: MonadIO m => MetaInfo -> m CSize Source #

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

get metaInfo #size

setMetaInfoSize :: MonadIO m => MetaInfo -> CSize -> m () Source #

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

set metaInfo [ #size := value ]

transformFunc

function for transforming the metadata

clearMetaInfoTransformFunc :: MonadIO m => MetaInfo -> m () Source #

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

clear #transformFunc

getMetaInfoTransformFunc :: MonadIO m => MetaInfo -> m (Maybe MetaTransformFunction_WithClosures) Source #

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

get metaInfo #transformFunc

setMetaInfoTransformFunc :: MonadIO m => MetaInfo -> FunPtr C_MetaTransformFunction -> m () Source #

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

set metaInfo [ #transformFunc := value ]

type

type identifying the implementor of the api

getMetaInfoType :: MonadIO m => MetaInfo -> m GType Source #

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

get metaInfo #type

setMetaInfoType :: MonadIO m => MetaInfo -> GType -> m () Source #

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

set metaInfo [ #type := value ]