| 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
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
| Eq CustomMeta Source # | |
Defined in GI.Gst.Structs.CustomMeta | |
| BoxedPtr CustomMeta Source # | |
Defined in GI.Gst.Structs.CustomMeta | |
| CallocPtr CustomMeta Source # | |
Defined in GI.Gst.Structs.CustomMeta Methods boxedPtrCalloc :: IO (Ptr CustomMeta) | |
| ManagedPtrNewtype CustomMeta Source # | |
Defined in GI.Gst.Structs.CustomMeta Methods toManagedPtr :: CustomMeta -> ManagedPtr CustomMeta | |
| tag ~ 'AttrSet => Constructible CustomMeta tag Source # | |
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
getStructure
customMetaGetStructure Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => CustomMeta | |
| -> m Structure | Returns: the |
hasName
Arguments
| :: (HasCallStack, MonadIO m) | |
| => CustomMeta | |
| -> Text | |
| -> m Bool | Returns: Whether |
Checks whether the name of the custom meta is name
Since: 1.20
Properties
meta
parent Meta
getCustomMetaMeta :: MonadIO m => CustomMeta -> m Meta Source #
Get the value of the “meta” field.
When overloading is enabled, this is equivalent to
get customMeta #meta
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
setcustomMeta [ #structure:=value ]