Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gst.Structs.Caps

Contents

Exported types
Methods
Properties
- MiniObject

Description

Caps (capabilities) are lightweight refcounted objects describing media types. They are composed of an array of #GstStructure.

Caps are exposed on #GstPadTemplate to describe all possible types a given pad can handle. They are also stored in the #GstRegistry along with a description of the #GstElement.

Caps are exposed on the element pads using the gst_pad_query_caps() pad function. This function describes the possible types that the pad can handle or produce at runtime.

A #GstCaps can be constructed with the following code fragment: |[ GstCaps *caps = gst_caps_new_simple ("video/x-raw", "format", G_TYPE_STRING, I420, "framerate", GST_TYPE_FRACTION, 25, 1, "pixel-aspect-ratio", GST_TYPE_FRACTION, 1, 1, "width", G_TYPE_INT, 320, "height", G_TYPE_INT, 240, NULL); ]|

A #GstCaps is fixed when it has no properties with ranges or lists. Use gst_caps_is_fixed() to test for fixed caps. Fixed caps can be used in a caps event to notify downstream elements of the current media type.

Various methods exist to work with the media types such as subtracting or intersecting.

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 Caps Source

Constructors

Caps (ForeignPtr Caps)

Instances

BoxedObject Caps Source
(~) AttrOpTag tag AttrSet => Constructible Caps tag Source
((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsTruncateMethodInfo Caps signature Source
((~) * signature (m Text), MonadIO m) => MethodInfo * CapsToStringMethodInfo Caps signature Source
((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsSubtractMethodInfo Caps signature Source
((~) * signature (Word32 -> m Structure), MonadIO m) => MethodInfo * CapsStealStructureMethodInfo Caps signature Source
((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsSimplifyMethodInfo Caps signature Source
((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * CapsSetValueMethodInfo Caps signature Source
((~) * signature (Word32 -> Maybe CapsFeatures -> m ()), MonadIO m) => MethodInfo * CapsSetFeaturesMethodInfo Caps signature Source
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * CapsRemoveStructureMethodInfo Caps signature Source
((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsNormalizeMethodInfo Caps signature Source
((~) * signature (Structure -> Maybe CapsFeatures -> m Caps), MonadIO m) => MethodInfo * CapsMergeStructureFullMethodInfo Caps signature Source
((~) * signature (Structure -> m Caps), MonadIO m) => MethodInfo * CapsMergeStructureMethodInfo Caps signature Source
((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsMergeMethodInfo Caps signature Source
((~) * signature (CapsMapFunc -> m Bool), MonadIO m) => MethodInfo * CapsMapInPlaceMethodInfo Caps signature Source
((~) * signature (Structure -> Maybe CapsFeatures -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetStructureFullMethodInfo Caps signature Source
((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetStructureMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsStrictlyEqualMethodInfo Caps signature Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsFixedMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsEqualFixedMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsEqualMethodInfo Caps signature Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsEmptyMethodInfo Caps signature Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsAnyMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsAlwaysCompatibleMethodInfo Caps signature Source
((~) * signature (Caps -> CapsIntersectMode -> m Caps), MonadIO m) => MethodInfo * CapsIntersectFullMethodInfo Caps signature Source
((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsIntersectMethodInfo Caps signature Source
((~) * signature (Word32 -> m Structure), MonadIO m) => MethodInfo * CapsGetStructureMethodInfo Caps signature Source
((~) * signature (m Word32), MonadIO m) => MethodInfo * CapsGetSizeMethodInfo Caps signature Source
((~) * signature (Word32 -> m CapsFeatures), MonadIO m) => MethodInfo * CapsGetFeaturesMethodInfo Caps signature Source
((~) * signature (CapsForeachFunc -> m Bool), MonadIO m) => MethodInfo * CapsForeachMethodInfo Caps signature Source
((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsFixateMethodInfo Caps signature Source
((~) * signature (CapsFilterMapFunc -> m ()), MonadIO m) => MethodInfo * CapsFilterAndMapInPlaceMethodInfo Caps signature Source
((~) * signature (Word32 -> m Caps), MonadIO m) => MethodInfo * CapsCopyNthMethodInfo Caps signature Source
((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsCanIntersectMethodInfo Caps signature Source
((~) * signature (Structure -> Maybe CapsFeatures -> m ()), MonadIO m) => MethodInfo * CapsAppendStructureFullMethodInfo Caps signature Source
((~) * signature (Structure -> m ()), MonadIO m) => MethodInfo * CapsAppendStructureMethodInfo Caps signature Source
((~) * signature (Caps -> m ()), MonadIO m) => MethodInfo * CapsAppendMethodInfo Caps signature Source
((~) * info (ResolveCapsMethod t Caps), MethodInfo * info Caps p) => IsLabelProxy t (Caps -> p) Source
type AttributeList Caps Source

newZeroCaps :: MonadIO m => m Caps Source

Construct a Caps struct initialized to zero.

noCaps :: Maybe Caps Source

Methods

capsAppend

data CapsAppendMethodInfo Source

Instances

((~) * signature (Caps -> m ()), MonadIO m) => MethodInfo * CapsAppendMethodInfo Caps signature Source

capsAppend :: MonadIO m => Caps -> Caps -> m () Source

capsAppendStructure

data CapsAppendStructureMethodInfo Source

Instances

((~) * signature (Structure -> m ()), MonadIO m) => MethodInfo * CapsAppendStructureMethodInfo Caps signature Source

capsAppendStructure :: MonadIO m => Caps -> Structure -> m () Source

capsAppendStructureFull

data CapsAppendStructureFullMethodInfo Source

Instances

((~) * signature (Structure -> Maybe CapsFeatures -> m ()), MonadIO m) => MethodInfo * CapsAppendStructureFullMethodInfo Caps signature Source

capsAppendStructureFull :: MonadIO m => Caps -> Structure -> Maybe CapsFeatures -> m () Source

capsCanIntersect

data CapsCanIntersectMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsCanIntersectMethodInfo Caps signature Source

capsCanIntersect :: MonadIO m => Caps -> Caps -> m Bool Source

capsCopyNth

data CapsCopyNthMethodInfo Source

Instances

((~) * signature (Word32 -> m Caps), MonadIO m) => MethodInfo * CapsCopyNthMethodInfo Caps signature Source

capsCopyNth :: MonadIO m => Caps -> Word32 -> m Caps Source

capsFilterAndMapInPlace

data CapsFilterAndMapInPlaceMethodInfo Source

Instances

((~) * signature (CapsFilterMapFunc -> m ()), MonadIO m) => MethodInfo * CapsFilterAndMapInPlaceMethodInfo Caps signature Source

capsFilterAndMapInPlace :: MonadIO m => Caps -> CapsFilterMapFunc -> m () Source

capsFixate

data CapsFixateMethodInfo Source

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsFixateMethodInfo Caps signature Source

capsFixate :: MonadIO m => Caps -> m Caps Source

capsForeach

data CapsForeachMethodInfo Source

Instances

((~) * signature (CapsForeachFunc -> m Bool), MonadIO m) => MethodInfo * CapsForeachMethodInfo Caps signature Source

capsForeach :: MonadIO m => Caps -> CapsForeachFunc -> m Bool Source

capsFromString

capsFromString :: MonadIO m => Text -> m Caps Source

capsGetFeatures

data CapsGetFeaturesMethodInfo Source

Instances

((~) * signature (Word32 -> m CapsFeatures), MonadIO m) => MethodInfo * CapsGetFeaturesMethodInfo Caps signature Source

capsGetFeatures :: MonadIO m => Caps -> Word32 -> m CapsFeatures Source

capsGetSize

data CapsGetSizeMethodInfo Source

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * CapsGetSizeMethodInfo Caps signature Source

capsGetSize :: MonadIO m => Caps -> m Word32 Source

capsGetStructure

data CapsGetStructureMethodInfo Source

Instances

((~) * signature (Word32 -> m Structure), MonadIO m) => MethodInfo * CapsGetStructureMethodInfo Caps signature Source

capsGetStructure :: MonadIO m => Caps -> Word32 -> m Structure Source

capsIntersect

data CapsIntersectMethodInfo Source

Instances

((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsIntersectMethodInfo Caps signature Source

capsIntersect :: MonadIO m => Caps -> Caps -> m Caps Source

capsIntersectFull

data CapsIntersectFullMethodInfo Source

Instances

((~) * signature (Caps -> CapsIntersectMode -> m Caps), MonadIO m) => MethodInfo * CapsIntersectFullMethodInfo Caps signature Source

capsIntersectFull :: MonadIO m => Caps -> Caps -> CapsIntersectMode -> m Caps Source

capsIsAlwaysCompatible

data CapsIsAlwaysCompatibleMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsAlwaysCompatibleMethodInfo Caps signature Source

capsIsAlwaysCompatible :: MonadIO m => Caps -> Caps -> m Bool Source

capsIsAny

data CapsIsAnyMethodInfo Source

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsAnyMethodInfo Caps signature Source

capsIsAny :: MonadIO m => Caps -> m Bool Source

capsIsEmpty

data CapsIsEmptyMethodInfo Source

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsEmptyMethodInfo Caps signature Source

capsIsEmpty :: MonadIO m => Caps -> m Bool Source

capsIsEqual

data CapsIsEqualMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsEqualMethodInfo Caps signature Source

capsIsEqual :: MonadIO m => Caps -> Caps -> m Bool Source

capsIsEqualFixed

data CapsIsEqualFixedMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsEqualFixedMethodInfo Caps signature Source

capsIsEqualFixed :: MonadIO m => Caps -> Caps -> m Bool Source

capsIsFixed

data CapsIsFixedMethodInfo Source

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * CapsIsFixedMethodInfo Caps signature Source

capsIsFixed :: MonadIO m => Caps -> m Bool Source

capsIsStrictlyEqual

data CapsIsStrictlyEqualMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsStrictlyEqualMethodInfo Caps signature Source

capsIsStrictlyEqual :: MonadIO m => Caps -> Caps -> m Bool Source

capsIsSubset

data CapsIsSubsetMethodInfo Source

Instances

((~) * signature (Caps -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetMethodInfo Caps signature Source

capsIsSubset :: MonadIO m => Caps -> Caps -> m Bool Source

capsIsSubsetStructure

data CapsIsSubsetStructureMethodInfo Source

Instances

((~) * signature (Structure -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetStructureMethodInfo Caps signature Source

capsIsSubsetStructure :: MonadIO m => Caps -> Structure -> m Bool Source

capsIsSubsetStructureFull

data CapsIsSubsetStructureFullMethodInfo Source

Instances

((~) * signature (Structure -> Maybe CapsFeatures -> m Bool), MonadIO m) => MethodInfo * CapsIsSubsetStructureFullMethodInfo Caps signature Source

capsIsSubsetStructureFull :: MonadIO m => Caps -> Structure -> Maybe CapsFeatures -> m Bool Source

capsMapInPlace

data CapsMapInPlaceMethodInfo Source

Instances

((~) * signature (CapsMapFunc -> m Bool), MonadIO m) => MethodInfo * CapsMapInPlaceMethodInfo Caps signature Source

capsMapInPlace :: MonadIO m => Caps -> CapsMapFunc -> m Bool Source

capsMerge

data CapsMergeMethodInfo Source

Instances

((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsMergeMethodInfo Caps signature Source

capsMerge :: MonadIO m => Caps -> Caps -> m Caps Source

capsMergeStructure

data CapsMergeStructureMethodInfo Source

Instances

((~) * signature (Structure -> m Caps), MonadIO m) => MethodInfo * CapsMergeStructureMethodInfo Caps signature Source

capsMergeStructure :: MonadIO m => Caps -> Structure -> m Caps Source

capsMergeStructureFull

data CapsMergeStructureFullMethodInfo Source

Instances

((~) * signature (Structure -> Maybe CapsFeatures -> m Caps), MonadIO m) => MethodInfo * CapsMergeStructureFullMethodInfo Caps signature Source

capsMergeStructureFull :: MonadIO m => Caps -> Structure -> Maybe CapsFeatures -> m Caps Source

capsNewAny

capsNewAny :: MonadIO m => m Caps Source

capsNewEmpty

capsNewEmpty :: MonadIO m => m Caps Source

capsNewEmptySimple

capsNewEmptySimple :: MonadIO m => Text -> m Caps Source

capsNormalize

data CapsNormalizeMethodInfo Source

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsNormalizeMethodInfo Caps signature Source

capsNormalize :: MonadIO m => Caps -> m Caps Source

capsRemoveStructure

data CapsRemoveStructureMethodInfo Source

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * CapsRemoveStructureMethodInfo Caps signature Source

capsRemoveStructure :: MonadIO m => Caps -> Word32 -> m () Source

capsSetFeatures

data CapsSetFeaturesMethodInfo Source

Instances

((~) * signature (Word32 -> Maybe CapsFeatures -> m ()), MonadIO m) => MethodInfo * CapsSetFeaturesMethodInfo Caps signature Source

capsSetFeatures :: MonadIO m => Caps -> Word32 -> Maybe CapsFeatures -> m () Source

capsSetValue

data CapsSetValueMethodInfo Source

Instances

((~) * signature (Text -> GValue -> m ()), MonadIO m) => MethodInfo * CapsSetValueMethodInfo Caps signature Source

capsSetValue :: MonadIO m => Caps -> Text -> GValue -> m () Source

capsSimplify

data CapsSimplifyMethodInfo Source

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsSimplifyMethodInfo Caps signature Source

capsSimplify :: MonadIO m => Caps -> m Caps Source

capsStealStructure

data CapsStealStructureMethodInfo Source

Instances

((~) * signature (Word32 -> m Structure), MonadIO m) => MethodInfo * CapsStealStructureMethodInfo Caps signature Source

capsStealStructure :: MonadIO m => Caps -> Word32 -> m Structure Source

capsSubtract

data CapsSubtractMethodInfo Source

Instances

((~) * signature (Caps -> m Caps), MonadIO m) => MethodInfo * CapsSubtractMethodInfo Caps signature Source

capsSubtract :: MonadIO m => Caps -> Caps -> m Caps Source

capsToString

data CapsToStringMethodInfo Source

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CapsToStringMethodInfo Caps signature Source

capsToString :: MonadIO m => Caps -> m Text Source

capsTruncate

data CapsTruncateMethodInfo Source

Instances

((~) * signature (m Caps), MonadIO m) => MethodInfo * CapsTruncateMethodInfo Caps signature Source

capsTruncate :: MonadIO m => Caps -> m Caps Source

Properties

MiniObject

capsClearMiniObject :: MonadIO m => Caps -> m () Source

capsMiniObject :: AttrLabelProxy "miniObject" Source

capsReadMiniObject :: MonadIO m => Caps -> m (Maybe MiniObject) Source

capsWriteMiniObject :: MonadIO m => Caps -> Ptr MiniObject -> m () Source