Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gst.Structs.CustomMeta

Contents

Exported types
Methods
- getStructure
- hasName
Properties
- meta
- structure

Description

Extra custom metadata. The structure field is the same as returned by customMetaGetStructure.

Since 1.24 it can be serialized using metaSerialize and metaDeserialize, but only if the Structure does not contain any fields that cannot be serialized, see SerializeFlagsStrict.

Since: 1.20

Synopsis

newtype CustomMeta = CustomMeta (ManagedPtr CustomMeta)
newZeroCustomMeta :: MonadIO m => m CustomMeta
customMetaGetStructure :: (HasCallStack, MonadIO m) => CustomMeta -> m Structure
customMetaHasName :: (HasCallStack, MonadIO m) => CustomMeta -> Text -> m Bool
getCustomMetaMeta :: MonadIO m => CustomMeta -> m Meta
clearCustomMetaStructure :: MonadIO m => CustomMeta -> m ()
getCustomMetaStructure :: MonadIO m => CustomMeta -> m (Maybe Structure)
setCustomMetaStructure :: MonadIO m => CustomMeta -> Ptr Structure -> m ()

Exported types

newtype CustomMeta Source #

Memory-managed wrapper type.

Constructors

CustomMeta (ManagedPtr CustomMeta)

Instances

Instances details

Eq CustomMeta Source #
Instance details Defined in GI.Gst.Structs.CustomMeta Methods (==) :: CustomMeta -> CustomMeta -> Bool # (/=) :: CustomMeta -> CustomMeta -> Bool #
BoxedPtr CustomMeta Source #
Instance details Defined in GI.Gst.Structs.CustomMeta Methods boxedPtrCopy :: CustomMeta -> IO CustomMeta boxedPtrFree :: CustomMeta -> IO ()
CallocPtr CustomMeta Source #
Instance details Defined in GI.Gst.Structs.CustomMeta Methods boxedPtrCalloc :: IO (Ptr CustomMeta)
ManagedPtrNewtype CustomMeta Source #
Instance details Defined in GI.Gst.Structs.CustomMeta Methods toManagedPtr :: CustomMeta -> ManagedPtr CustomMeta
tag ~ 'AttrSet => Constructible CustomMeta tag Source #
Instance details Defined in GI.Gst.Structs.CustomMeta Methods new :: MonadIO m => (ManagedPtr CustomMeta -> CustomMeta) -> [AttrOp CustomMeta tag] -> m CustomMeta

newZeroCustomMeta :: MonadIO m => m CustomMeta Source #

Construct a CustomMeta struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

hasName.

Getters

getStructure.

Setters

None.

getStructure

customMetaGetStructure Source #

Arguments

:: (HasCallStack, MonadIO m)
=> CustomMeta
-> m Structure	Returns: the `Structure` backing `meta`

Retrieve the Structure backing a custom meta, the structure's mutability is conditioned to the writability of the Buffer meta is attached to.

Since: 1.20

hasName

customMetaHasName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> CustomMeta
-> Text
-> m Bool	Returns: Whether `name` is the name of the custom meta

Checks whether the name of the custom meta is name

Since: 1.20

Properties

structure

Structure containing custom metadata.

Since: 1.24

clearCustomMetaStructure :: MonadIO m => CustomMeta -> m () Source #

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

clear #structure

getCustomMetaStructure :: MonadIO m => CustomMeta -> m (Maybe Structure) Source #

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

get customMeta #structure

setCustomMetaStructure :: MonadIO m => CustomMeta -> Ptr Structure -> m () Source #

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

set customMeta [ #structure := value ]