GI.Gst.Structs.Structure

A #GstStructure is a collection of key/value pairs. The keys are expressed as GQuarks and the values can be of any GType.

In addition to the key/value pairs, a #GstStructure also has a name. The name starts with a letter and can be filled by letters, numbers and any of "/-_.:".

#GstStructure is used by various GStreamer subsystems to store information in a flexible and extensible way. A #GstStructure does not have a refcount because it usually is part of a higher level object such as #GstCaps, GstEvent, #GstQuery. It provides a means to enforce mutability using the refcount of the parent with the gst_structure_set_parent_refcount() method.

A #GstStructure can be created with gst_structure_new_empty() or gst_structure_new(), which both take a name and an optional set of key/value pairs along with the types of the values.

Field values can be changed with gst_structure_set_value() or gst_structure_set().

Field values can be retrieved with gst_structure_get_value() or the more convenient gst_structure_get_*() functions.

Fields can be removed with gst_structure_remove_field() or gst_structure_remove_fields().

Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not allowed. Strings may be %NULL however.

Be aware that the current GstStructure serialization into string has limited support for nested GstStructure fields. It can only support one level of nesting. Using more levels will lead to unexpected behavior when using serialization features, such as gst_caps_to_string() or gst_value_serialize() and their counterparts.

Exported types

newtype Structure

Constructors

Structure (ForeignPtr Structure)

Instances

BoxedObject Structure

(~) AttrOpTag tag AttrSet => Constructible Structure tag

((~) * signature (m Text), MonadIO m) => MethodInfo * StructureToStringMethodInfo Structure signature

((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * StructureTakeValueMethodInfo Structure signature

((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * StructureSetValueMethodInfo Structure signature

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * StructureSetParentRefcountMethodInfo Structure signature

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * StructureSetNameMethodInfo Structure signature

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * StructureRemoveFieldMethodInfo Structure signature

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureRemoveAllFieldsMethodInfo Structure signature

((~) * signature (Word32 -> m Text), MonadIO m) => MethodInfo * StructureNthFieldNameMethodInfo Structure signature

((~) * signature (m Int32), MonadIO m) => MethodInfo * StructureNFieldsMethodInfo Structure signature

((~) * signature (StructureMapFunc -> m Bool), MonadIO m) => MethodInfo * StructureMapInPlaceMethodInfo Structure signature

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureIsSubsetMethodInfo Structure signature

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureIsEqualMethodInfo Structure signature

((~) * signature (Structure -> m Structure), MonadIO m) => MethodInfo * StructureIntersectMethodInfo Structure signature

((~) * signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo * StructureIdTakeValueMethodInfo Structure signature

((~) * signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo * StructureIdSetValueMethodInfo Structure signature

((~) * signature (Word32 -> GType -> m Bool), MonadIO m) => MethodInfo * StructureIdHasFieldTypedMethodInfo Structure signature

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * StructureIdHasFieldMethodInfo Structure signature

((~) * signature (Word32 -> m GValue), MonadIO m) => MethodInfo * StructureIdGetValueMethodInfo Structure signature

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureHasNameMethodInfo Structure signature

((~) * signature (Text -> GType -> m Bool), MonadIO m) => MethodInfo * StructureHasFieldTypedMethodInfo Structure signature

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureHasFieldMethodInfo Structure signature

((~) * signature (Text -> m GValue), MonadIO m) => MethodInfo * StructureGetValueMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo * StructureGetUint64MethodInfo Structure signature

((~) * signature (Text -> m (Bool, Word32)), MonadIO m) => MethodInfo * StructureGetUintMethodInfo Structure signature

((~) * signature (Text -> m (Maybe Text)), MonadIO m) => MethodInfo * StructureGetStringMethodInfo Structure signature

((~) * signature (m Word32), MonadIO m) => MethodInfo * StructureGetNameIdMethodInfo Structure signature

((~) * signature (m Text), MonadIO m) => MethodInfo * StructureGetNameMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Int64)), MonadIO m) => MethodInfo * StructureGetInt64MethodInfo Structure signature

((~) * signature (Text -> m (Bool, Int32)), MonadIO m) => MethodInfo * StructureGetIntMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Int32, Int32)), MonadIO m) => MethodInfo * StructureGetFractionMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Word32, Word32)), MonadIO m) => MethodInfo * StructureGetFlagsetMethodInfo Structure signature

((~) * signature (Text -> m GType), MonadIO m) => MethodInfo * StructureGetFieldTypeMethodInfo Structure signature

((~) * signature (Text -> GType -> m (Bool, Int32)), MonadIO m) => MethodInfo * StructureGetEnumMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Double)), MonadIO m) => MethodInfo * StructureGetDoubleMethodInfo Structure signature

((~) * signature (Text -> m (Bool, DateTime)), MonadIO m) => MethodInfo * StructureGetDateTimeMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Date)), MonadIO m) => MethodInfo * StructureGetDateMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo * StructureGetClockTimeMethodInfo Structure signature

((~) * signature (Text -> m (Bool, Bool)), MonadIO m) => MethodInfo * StructureGetBooleanMethodInfo Structure signature

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureFreeMethodInfo Structure signature

((~) * signature (StructureForeachFunc -> m Bool), MonadIO m) => MethodInfo * StructureForeachMethodInfo Structure signature

((~) * signature (Text -> Text -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldStringMethodInfo Structure signature

((~) * signature (Text -> Int32 -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestIntMethodInfo Structure signature

((~) * signature (Text -> Int32 -> Int32 -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestFractionMethodInfo Structure signature

((~) * signature (Text -> Double -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestDoubleMethodInfo Structure signature

((~) * signature (Text -> Bool -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldBooleanMethodInfo Structure signature

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldMethodInfo Structure signature

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureFixateMethodInfo Structure signature

((~) * signature (StructureFilterMapFunc -> m ()), MonadIO m) => MethodInfo * StructureFilterAndMapInPlaceMethodInfo Structure signature

((~) * signature (m Structure), MonadIO m) => MethodInfo * StructureCopyMethodInfo Structure signature

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureCanIntersectMethodInfo Structure signature

((~) * info (ResolveStructureMethod t Structure), MethodInfo * info Structure p) => IsLabelProxy t (Structure -> p)

type AttributeList Structure

newZeroStructure :: MonadIO m => m Structure

Construct a Structure struct initialized to zero.

noStructure :: Maybe Structure

Methods

structureCanIntersect

data StructureCanIntersectMethodInfo

Instances

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureCanIntersectMethodInfo Structure signature

structureCanIntersect :: MonadIO m => Structure -> Structure -> m Bool

structureCopy

data StructureCopyMethodInfo

Instances

((~) * signature (m Structure), MonadIO m) => MethodInfo * StructureCopyMethodInfo Structure signature

structureCopy :: MonadIO m => Structure -> m Structure

structureFilterAndMapInPlace

data StructureFilterAndMapInPlaceMethodInfo

Instances

((~) * signature (StructureFilterMapFunc -> m ()), MonadIO m) => MethodInfo * StructureFilterAndMapInPlaceMethodInfo Structure signature

structureFilterAndMapInPlace :: MonadIO m => Structure -> StructureFilterMapFunc -> m ()

structureFixate

data StructureFixateMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureFixateMethodInfo Structure signature

structureFixate :: MonadIO m => Structure -> m ()

structureFixateField

data StructureFixateFieldMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldMethodInfo Structure signature

structureFixateField :: MonadIO m => Structure -> Text -> m Bool

structureFixateFieldBoolean

data StructureFixateFieldBooleanMethodInfo

Instances

((~) * signature (Text -> Bool -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldBooleanMethodInfo Structure signature

structureFixateFieldBoolean :: MonadIO m => Structure -> Text -> Bool -> m Bool

structureFixateFieldNearestDouble

data StructureFixateFieldNearestDoubleMethodInfo

Instances

((~) * signature (Text -> Double -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestDoubleMethodInfo Structure signature

structureFixateFieldNearestDouble :: MonadIO m => Structure -> Text -> Double -> m Bool

structureFixateFieldNearestFraction

data StructureFixateFieldNearestFractionMethodInfo

Instances

((~) * signature (Text -> Int32 -> Int32 -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestFractionMethodInfo Structure signature

structureFixateFieldNearestFraction :: MonadIO m => Structure -> Text -> Int32 -> Int32 -> m Bool

structureFixateFieldNearestInt

data StructureFixateFieldNearestIntMethodInfo

Instances

((~) * signature (Text -> Int32 -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldNearestIntMethodInfo Structure signature

structureFixateFieldNearestInt :: MonadIO m => Structure -> Text -> Int32 -> m Bool

structureFixateFieldString

data StructureFixateFieldStringMethodInfo

Instances

((~) * signature (Text -> Text -> m Bool), MonadIO m) => MethodInfo * StructureFixateFieldStringMethodInfo Structure signature

structureFixateFieldString :: MonadIO m => Structure -> Text -> Text -> m Bool

structureForeach

data StructureForeachMethodInfo

Instances

((~) * signature (StructureForeachFunc -> m Bool), MonadIO m) => MethodInfo * StructureForeachMethodInfo Structure signature

structureForeach :: MonadIO m => Structure -> StructureForeachFunc -> m Bool

structureFree

data StructureFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureFreeMethodInfo Structure signature

structureFree :: MonadIO m => Structure -> m ()

structureFromString

structureFromString :: MonadIO m => Text -> m (Maybe Structure, Text)

structureGetBoolean

data StructureGetBooleanMethodInfo

Instances

((~) * signature (Text -> m (Bool, Bool)), MonadIO m) => MethodInfo * StructureGetBooleanMethodInfo Structure signature

structureGetBoolean :: MonadIO m => Structure -> Text -> m (Bool, Bool)

structureGetClockTime

data StructureGetClockTimeMethodInfo

Instances

((~) * signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo * StructureGetClockTimeMethodInfo Structure signature

structureGetClockTime :: MonadIO m => Structure -> Text -> m (Bool, Word64)

structureGetDate

data StructureGetDateMethodInfo

Instances

((~) * signature (Text -> m (Bool, Date)), MonadIO m) => MethodInfo * StructureGetDateMethodInfo Structure signature

structureGetDate :: MonadIO m => Structure -> Text -> m (Bool, Date)

structureGetDateTime

data StructureGetDateTimeMethodInfo

Instances

((~) * signature (Text -> m (Bool, DateTime)), MonadIO m) => MethodInfo * StructureGetDateTimeMethodInfo Structure signature

structureGetDateTime :: MonadIO m => Structure -> Text -> m (Bool, DateTime)

structureGetDouble

data StructureGetDoubleMethodInfo

Instances

((~) * signature (Text -> m (Bool, Double)), MonadIO m) => MethodInfo * StructureGetDoubleMethodInfo Structure signature

structureGetDouble :: MonadIO m => Structure -> Text -> m (Bool, Double)

structureGetEnum

data StructureGetEnumMethodInfo

Instances

((~) * signature (Text -> GType -> m (Bool, Int32)), MonadIO m) => MethodInfo * StructureGetEnumMethodInfo Structure signature

structureGetEnum :: MonadIO m => Structure -> Text -> GType -> m (Bool, Int32)

structureGetFieldType

data StructureGetFieldTypeMethodInfo

Instances

((~) * signature (Text -> m GType), MonadIO m) => MethodInfo * StructureGetFieldTypeMethodInfo Structure signature

structureGetFieldType :: MonadIO m => Structure -> Text -> m GType

structureGetFlagset

data StructureGetFlagsetMethodInfo

Instances

((~) * signature (Text -> m (Bool, Word32, Word32)), MonadIO m) => MethodInfo * StructureGetFlagsetMethodInfo Structure signature

structureGetFlagset :: MonadIO m => Structure -> Text -> m (Bool, Word32, Word32)

structureGetFraction

data StructureGetFractionMethodInfo

Instances

((~) * signature (Text -> m (Bool, Int32, Int32)), MonadIO m) => MethodInfo * StructureGetFractionMethodInfo Structure signature

structureGetFraction :: MonadIO m => Structure -> Text -> m (Bool, Int32, Int32)

structureGetInt

data StructureGetIntMethodInfo

Instances

((~) * signature (Text -> m (Bool, Int32)), MonadIO m) => MethodInfo * StructureGetIntMethodInfo Structure signature

structureGetInt :: MonadIO m => Structure -> Text -> m (Bool, Int32)

structureGetInt64

data StructureGetInt64MethodInfo

Instances

((~) * signature (Text -> m (Bool, Int64)), MonadIO m) => MethodInfo * StructureGetInt64MethodInfo Structure signature

structureGetInt64 :: MonadIO m => Structure -> Text -> m (Bool, Int64)

structureGetName

data StructureGetNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * StructureGetNameMethodInfo Structure signature

structureGetName :: MonadIO m => Structure -> m Text

structureGetNameId

data StructureGetNameIdMethodInfo

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * StructureGetNameIdMethodInfo Structure signature

structureGetNameId :: MonadIO m => Structure -> m Word32

structureGetString

data StructureGetStringMethodInfo

Instances

((~) * signature (Text -> m (Maybe Text)), MonadIO m) => MethodInfo * StructureGetStringMethodInfo Structure signature

structureGetString :: MonadIO m => Structure -> Text -> m (Maybe Text)

structureGetUint

data StructureGetUintMethodInfo

Instances

((~) * signature (Text -> m (Bool, Word32)), MonadIO m) => MethodInfo * StructureGetUintMethodInfo Structure signature

structureGetUint :: MonadIO m => Structure -> Text -> m (Bool, Word32)

structureGetUint64

data StructureGetUint64MethodInfo

Instances

((~) * signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo * StructureGetUint64MethodInfo Structure signature

structureGetUint64 :: MonadIO m => Structure -> Text -> m (Bool, Word64)

structureGetValue

data StructureGetValueMethodInfo

Instances

((~) * signature (Text -> m GValue), MonadIO m) => MethodInfo * StructureGetValueMethodInfo Structure signature

structureGetValue :: MonadIO m => Structure -> Text -> m GValue

structureHasField

data StructureHasFieldMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureHasFieldMethodInfo Structure signature

structureHasField :: MonadIO m => Structure -> Text -> m Bool

structureHasFieldTyped

data StructureHasFieldTypedMethodInfo

Instances

((~) * signature (Text -> GType -> m Bool), MonadIO m) => MethodInfo * StructureHasFieldTypedMethodInfo Structure signature

structureHasFieldTyped :: MonadIO m => Structure -> Text -> GType -> m Bool

structureHasName

data StructureHasNameMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * StructureHasNameMethodInfo Structure signature

structureHasName :: MonadIO m => Structure -> Text -> m Bool

structureIdGetValue

data StructureIdGetValueMethodInfo

Instances

((~) * signature (Word32 -> m GValue), MonadIO m) => MethodInfo * StructureIdGetValueMethodInfo Structure signature

structureIdGetValue :: MonadIO m => Structure -> Word32 -> m GValue

structureIdHasField

data StructureIdHasFieldMethodInfo

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * StructureIdHasFieldMethodInfo Structure signature

structureIdHasField :: MonadIO m => Structure -> Word32 -> m Bool

structureIdHasFieldTyped

data StructureIdHasFieldTypedMethodInfo

Instances

((~) * signature (Word32 -> GType -> m Bool), MonadIO m) => MethodInfo * StructureIdHasFieldTypedMethodInfo Structure signature

structureIdHasFieldTyped :: MonadIO m => Structure -> Word32 -> GType -> m Bool

structureIdSetValue

data StructureIdSetValueMethodInfo

Instances

((~) * signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo * StructureIdSetValueMethodInfo Structure signature

structureIdSetValue :: MonadIO m => Structure -> Word32 -> GValue -> m ()

structureIdTakeValue

data StructureIdTakeValueMethodInfo

Instances

((~) * signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo * StructureIdTakeValueMethodInfo Structure signature

structureIdTakeValue :: MonadIO m => Structure -> Word32 -> GValue -> m ()

structureIntersect

data StructureIntersectMethodInfo

Instances

((~) * signature (Structure -> m Structure), MonadIO m) => MethodInfo * StructureIntersectMethodInfo Structure signature

structureIntersect :: MonadIO m => Structure -> Structure -> m Structure

structureIsEqual

data StructureIsEqualMethodInfo

Instances

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureIsEqualMethodInfo Structure signature

structureIsEqual :: MonadIO m => Structure -> Structure -> m Bool

structureIsSubset

data StructureIsSubsetMethodInfo

Instances

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * StructureIsSubsetMethodInfo Structure signature

structureIsSubset :: MonadIO m => Structure -> Structure -> m Bool

structureMapInPlace

data StructureMapInPlaceMethodInfo

Instances

((~) * signature (StructureMapFunc -> m Bool), MonadIO m) => MethodInfo * StructureMapInPlaceMethodInfo Structure signature

structureMapInPlace :: MonadIO m => Structure -> StructureMapFunc -> m Bool

structureNFields

data StructureNFieldsMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * StructureNFieldsMethodInfo Structure signature

structureNFields :: MonadIO m => Structure -> m Int32

structureNewEmpty

structureNewEmpty :: MonadIO m => Text -> m Structure

structureNewFromString

structureNewFromString :: MonadIO m => Text -> m (Maybe Structure)

structureNewIdEmpty

structureNewIdEmpty :: MonadIO m => Word32 -> m Structure

structureNthFieldName

data StructureNthFieldNameMethodInfo

Instances

((~) * signature (Word32 -> m Text), MonadIO m) => MethodInfo * StructureNthFieldNameMethodInfo Structure signature

structureNthFieldName :: MonadIO m => Structure -> Word32 -> m Text

structureRemoveAllFields

data StructureRemoveAllFieldsMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * StructureRemoveAllFieldsMethodInfo Structure signature

structureRemoveAllFields :: MonadIO m => Structure -> m ()

structureRemoveField

data StructureRemoveFieldMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * StructureRemoveFieldMethodInfo Structure signature

structureRemoveField :: MonadIO m => Structure -> Text -> m ()

structureSetName

data StructureSetNameMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * StructureSetNameMethodInfo Structure signature

structureSetName :: MonadIO m => Structure -> Text -> m ()

structureSetParentRefcount

data StructureSetParentRefcountMethodInfo

Instances

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * StructureSetParentRefcountMethodInfo Structure signature

structureSetParentRefcount :: MonadIO m => Structure -> Int32 -> m Bool

structureSetValue

data StructureSetValueMethodInfo

Instances

((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * StructureSetValueMethodInfo Structure signature

structureSetValue :: MonadIO m => Structure -> Text -> GValue -> m ()

structureTakeValue

data StructureTakeValueMethodInfo

Instances

((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * StructureTakeValueMethodInfo Structure signature

structureTakeValue :: MonadIO m => Structure -> Text -> GValue -> m ()

structureToString

data StructureToStringMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * StructureToStringMethodInfo Structure signature

structureToString :: MonadIO m => Structure -> m Text

Properties

Type

structureReadType :: MonadIO m => Structure -> m GType

structureType :: AttrLabelProxy "type"

structureWriteType :: MonadIO m => Structure -> GType -> m ()