gi-gst-0.1.6.13: Gst bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.Structure

Contents

Description

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.

Synopsis

Exported types

newtype Structure Source

Constructors

Structure (ForeignPtr Structure) 

Instances

BoxedObject Structure Source 
((~) * info (ResolveStructureMethod t Structure), MethodInfo * info Structure p) => IsLabel t (Structure -> p) Source 

Methods

fromLabel :: Proxy# Symbol t -> Structure -> p

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

Methods

fromLabelProxy :: Proxy Symbol t -> Structure -> p

((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) StructureToStringMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureTakeValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureSetValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Int32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureSetParentRefcountMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureSetNameMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureRemoveFieldMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureRemoveAllFieldsMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> m Text), MonadIO m) => MethodInfo (TYPE Lifted) StructureNthFieldNameMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m Int32), MonadIO m) => MethodInfo (TYPE Lifted) StructureNFieldsMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (StructureMapFunc -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureMapInPlaceMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Structure -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureIsSubsetMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Structure -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureIsEqualMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Structure -> m Structure), MonadIO m) => MethodInfo (TYPE Lifted) StructureIntersectMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureIdTakeValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> GValue -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureIdSetValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> GType -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureIdHasFieldTypedMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureIdHasFieldMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Word32 -> m GValue), MonadIO m) => MethodInfo (TYPE Lifted) StructureIdGetValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureHasNameMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> GType -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureHasFieldTypedMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureHasFieldMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m GValue), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetValueMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetUint64MethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Word32)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetUintMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m Text), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetStringMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m Word32), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetNameIdMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetNameMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Int64)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetInt64MethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Int32)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetIntMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Int32, Int32)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetFractionMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Word32, Word32)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetFlagsetMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m GType), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetFieldTypeMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> GType -> m (Bool, Int32)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetEnumMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Double)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetDoubleMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, DateTime)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetDateTimeMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Date)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetDateMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Word64)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetClockTimeMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m (Bool, Bool)), MonadIO m) => MethodInfo (TYPE Lifted) StructureGetBooleanMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureFreeMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (StructureForeachFunc -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureForeachMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldStringMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> Int32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldNearestIntMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> Int32 -> Int32 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldNearestFractionMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> Double -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldNearestDoubleMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> Bool -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldBooleanMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateFieldMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureFixateMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (StructureFilterMapFunc -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) StructureFilterAndMapInPlaceMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (m Structure), MonadIO m) => MethodInfo (TYPE Lifted) StructureCopyMethodInfo Structure signature Source 
((~) (TYPE Lifted) signature (Structure -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) StructureCanIntersectMethodInfo Structure signature Source 

newZeroStructure :: MonadIO m => m Structure Source

Construct a Structure struct initialized to zero.

noStructure :: Maybe Structure Source

Methods

structureCanIntersect

data StructureCanIntersectMethodInfo Source

Instances

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

structureCopy

data StructureCopyMethodInfo Source

Instances

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

structureFilterAndMapInPlace

data StructureFilterAndMapInPlaceMethodInfo Source

Instances

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

structureFixate

data StructureFixateMethodInfo Source

Instances

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

structureFixateField

data StructureFixateFieldMethodInfo Source

Instances

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

structureFixateFieldBoolean

data StructureFixateFieldBooleanMethodInfo Source

Instances

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

structureFixateFieldNearestDouble

data StructureFixateFieldNearestDoubleMethodInfo Source

Instances

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

structureFixateFieldNearestFraction

data StructureFixateFieldNearestFractionMethodInfo Source

Instances

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

structureFixateFieldNearestInt

data StructureFixateFieldNearestIntMethodInfo Source

Instances

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

structureFixateFieldString

data StructureFixateFieldStringMethodInfo Source

Instances

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

structureForeach

data StructureForeachMethodInfo Source

Instances

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

structureFree

data StructureFreeMethodInfo Source

Instances

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

structureFromString

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

structureGetBoolean

data StructureGetBooleanMethodInfo Source

Instances

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

structureGetClockTime

data StructureGetClockTimeMethodInfo Source

Instances

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

structureGetDate

data StructureGetDateMethodInfo Source

Instances

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

structureGetDateTime

data StructureGetDateTimeMethodInfo Source

Instances

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

structureGetDouble

data StructureGetDoubleMethodInfo Source

Instances

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

structureGetEnum

data StructureGetEnumMethodInfo Source

Instances

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

structureGetFieldType

data StructureGetFieldTypeMethodInfo Source

Instances

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

structureGetFlagset

data StructureGetFlagsetMethodInfo Source

Instances

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

structureGetFraction

data StructureGetFractionMethodInfo Source

Instances

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

structureGetInt

data StructureGetIntMethodInfo Source

Instances

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

structureGetInt64

data StructureGetInt64MethodInfo Source

Instances

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

structureGetName

data StructureGetNameMethodInfo Source

Instances

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

structureGetNameId

data StructureGetNameIdMethodInfo Source

Instances

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

structureGetString

data StructureGetStringMethodInfo Source

Instances

structureGetString :: MonadIO m => Structure -> Text -> m Text Source

structureGetUint

data StructureGetUintMethodInfo Source

Instances

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

structureGetUint64

data StructureGetUint64MethodInfo Source

Instances

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

structureGetValue

data StructureGetValueMethodInfo Source

Instances

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

structureHasField

data StructureHasFieldMethodInfo Source

Instances

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

structureHasFieldTyped

data StructureHasFieldTypedMethodInfo Source

Instances

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

structureHasName

data StructureHasNameMethodInfo Source

Instances

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

structureIdGetValue

data StructureIdGetValueMethodInfo Source

Instances

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

structureIdHasField

data StructureIdHasFieldMethodInfo Source

Instances

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

structureIdHasFieldTyped

data StructureIdHasFieldTypedMethodInfo Source

Instances

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

structureIdSetValue

data StructureIdSetValueMethodInfo Source

Instances

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

structureIdTakeValue

data StructureIdTakeValueMethodInfo Source

Instances

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

structureIntersect

data StructureIntersectMethodInfo Source

Instances

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

structureIsEqual

data StructureIsEqualMethodInfo Source

Instances

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

structureIsSubset

data StructureIsSubsetMethodInfo Source

Instances

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

structureMapInPlace

data StructureMapInPlaceMethodInfo Source

Instances

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

structureNFields

data StructureNFieldsMethodInfo Source

Instances

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

structureNewEmpty

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

structureNewFromString

structureNewFromString :: MonadIO m => Text -> m Structure Source

structureNewIdEmpty

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

structureNthFieldName

data StructureNthFieldNameMethodInfo Source

Instances

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

structureRemoveAllFields

data StructureRemoveAllFieldsMethodInfo Source

Instances

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

structureRemoveField

data StructureRemoveFieldMethodInfo Source

Instances

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

structureSetName

data StructureSetNameMethodInfo Source

Instances

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

structureSetParentRefcount

data StructureSetParentRefcountMethodInfo Source

Instances

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

structureSetValue

data StructureSetValueMethodInfo Source

Instances

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

structureTakeValue

data StructureTakeValueMethodInfo Source

Instances

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

structureToString

data StructureToStringMethodInfo Source

Instances

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

Properties

Type

structureReadType :: Structure -> IO GType Source