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

Contents

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 

Methods

boxedType :: Caps -> IO GType

((~) * info (ResolveCapsMethod t Caps), MethodInfo * info Caps p) => IsLabel t (Caps -> p) Source 

Methods

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

((~) * info (ResolveCapsMethod t Caps), MethodInfo * info Caps p) => IsLabelProxy t (Caps -> p) Source 

Methods

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

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

newZeroCaps :: MonadIO m => m Caps Source

Construct a Caps struct initialized to zero.

noCaps :: Maybe Caps Source

Methods

capsAppend

data CapsAppendMethodInfo Source

Instances

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

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

capsAppendStructure

data CapsAppendStructureMethodInfo Source

Instances

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

capsAppendStructureFull

data CapsAppendStructureFullMethodInfo Source

Instances

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

capsCanIntersect

data CapsCanIntersectMethodInfo Source

Instances

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

capsCopyNth

data CapsCopyNthMethodInfo Source

Instances

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

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

capsFilterAndMapInPlace

data CapsFilterAndMapInPlaceMethodInfo Source

Instances

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

capsFixate

data CapsFixateMethodInfo Source

Instances

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

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

capsForeach

data CapsForeachMethodInfo Source

Instances

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

capsFromString

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

capsGetFeatures

data CapsGetFeaturesMethodInfo Source

Instances

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

capsGetSize

data CapsGetSizeMethodInfo Source

Instances

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

capsGetStructure

data CapsGetStructureMethodInfo Source

Instances

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

capsIntersect

data CapsIntersectMethodInfo Source

Instances

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

capsIntersectFull

data CapsIntersectFullMethodInfo Source

Instances

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

capsIsAlwaysCompatible

data CapsIsAlwaysCompatibleMethodInfo Source

Instances

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

capsIsAny

data CapsIsAnyMethodInfo Source

Instances

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

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

capsIsEmpty

data CapsIsEmptyMethodInfo Source

Instances

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

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

capsIsEqual

data CapsIsEqualMethodInfo Source

Instances

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

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

capsIsEqualFixed

data CapsIsEqualFixedMethodInfo Source

Instances

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

capsIsFixed

data CapsIsFixedMethodInfo Source

Instances

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

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

capsIsStrictlyEqual

data CapsIsStrictlyEqualMethodInfo Source

Instances

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

capsIsSubset

data CapsIsSubsetMethodInfo Source

Instances

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

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

capsIsSubsetStructure

data CapsIsSubsetStructureMethodInfo Source

Instances

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

capsIsSubsetStructureFull

data CapsIsSubsetStructureFullMethodInfo Source

Instances

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

capsMapInPlace

data CapsMapInPlaceMethodInfo Source

Instances

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

capsMerge

data CapsMergeMethodInfo Source

Instances

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

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

capsMergeStructure

data CapsMergeStructureMethodInfo Source

Instances

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

capsMergeStructureFull

data CapsMergeStructureFullMethodInfo Source

Instances

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

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

capsRemoveStructure

data CapsRemoveStructureMethodInfo Source

Instances

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

capsSetFeatures

data CapsSetFeaturesMethodInfo Source

Instances

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

capsSetValue

data CapsSetValueMethodInfo Source

Instances

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

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

capsSimplify

data CapsSimplifyMethodInfo Source

Instances

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

capsStealStructure

data CapsStealStructureMethodInfo Source

Instances

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

capsSubtract

data CapsSubtractMethodInfo Source

Instances

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

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

capsToString

data CapsToStringMethodInfo Source

Instances

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

capsTruncate

data CapsTruncateMethodInfo Source

Instances

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

Properties

MiniObject

capsReadMiniObject :: Caps -> IO MiniObject Source