GI.Gst.Structs.CapsFeatures

CapsFeatures can optionally be set on a Caps to add requirements for additional features for a specific Structure. Caps structures with the same name but with a non-equal set of caps features are not compatible. If a pad supports multiple sets of features it has to add multiple equal structures with different feature sets to the caps.

Empty CapsFeatures are equivalent with the CapsFeatures that only contain CAPS_FEATURE_MEMORY_SYSTEM_MEMORY. ANY CapsFeatures as created by capsFeaturesNewAny are equal to any other CapsFeatures and can be used to specify that any CapsFeatures would be supported, e.g. for elements that don't touch buffer memory. Caps with ANY CapsFeatures are considered non-fixed and during negotiation some CapsFeatures have to be selected.

Examples for caps features would be the requirement of a specific Memory types or the requirement of having a specific Meta on the buffer. Features are given as a string of the format memory:GstMemoryTypeName or meta:GstMetaAPIName.

Since: 1.2

Exported types

newtype CapsFeatures

Memory-managed wrapper type.

Constructors

CapsFeatures (ManagedPtr CapsFeatures)

Instances

Eq CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

Methods

(==) :: CapsFeatures -> CapsFeatures -> Bool

(/=) :: CapsFeatures -> CapsFeatures -> Bool

GBoxed CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

ManagedPtrNewtype CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

Methods

toManagedPtr :: CapsFeatures -> ManagedPtr CapsFeatures

TypedObject CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

Methods

glibType :: IO GType

HasParentTypes CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

IsGValue (Maybe CapsFeatures)

Convert CapsFeatures to and from GValue. See toGValue and fromGValue.

Defined in GI.Gst.Structs.CapsFeatures

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe CapsFeatures -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe CapsFeatures)

type ParentTypes CapsFeatures

Defined in GI.Gst.Structs.CapsFeatures

type ParentTypes CapsFeatures = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

add, addId, contains, containsId, copy, free, isAny, isEqual, remove, removeId, toString.

Getters

getNth, getNthId, getSize.

Setters

setParentRefcount.

add

capsFeaturesAdd

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature.

-> m ()

Adds feature to features.

Since: 1.2

addId

capsFeaturesAddId

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature.

-> m ()

Adds feature to features.

Since: 1.2

contains

capsFeaturesContains

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature

-> m Bool

Returns: True if features contains feature.

Checks if features contains feature.

Since: 1.2

containsId

capsFeaturesContainsId

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature

-> m Bool

Returns: True if features contains feature.

Checks if features contains feature.

Since: 1.2

copy

capsFeaturesCopy

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures to duplicate

-> m CapsFeatures

Returns: a new CapsFeatures.

Duplicates a CapsFeatures and all its values.

Since: 1.2

free

capsFeaturesFree

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: the CapsFeatures to free

-> m ()

Frees a CapsFeatures and all its values. The caps features must not have a parent when this function is called.

Since: 1.2

fromString

capsFeaturesFromString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

features: a string representation of a CapsFeatures.

-> m (Maybe CapsFeatures)

Returns: a new CapsFeatures or Nothing when the string could not be parsed.

Creates a CapsFeatures from a string representation.

Since: 1.2

getNth

capsFeaturesGetNth

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Word32

i: index of the feature

-> m (Maybe Text)

Returns: The i-th feature of features.

Returns the i-th feature of features.

Since: 1.2

getNthId

capsFeaturesGetNthId

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Word32

i: index of the feature

-> m Word32

Returns: The i-th feature of features.

Returns the i-th feature of features.

Since: 1.2

getSize

capsFeaturesGetSize

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> m Word32

Returns: The number of features in features.

Returns the number of features in features.

Since: 1.2

isAny

capsFeaturesIsAny

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> m Bool

Returns: True if features is GST_CAPS_FEATURES_ANY.

Checks if features is GST_CAPS_FEATURES_ANY.

Since: 1.2

isEqual

capsFeaturesIsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features1: a CapsFeatures.

-> CapsFeatures

features2: a CapsFeatures.

-> m Bool

Returns: True if features1 and features2 are equal.

Checks if features1 and features2 are equal.

Since: 1.2

newAny

capsFeaturesNewAny

Arguments

:: (HasCallStack, MonadIO m)

=> m CapsFeatures

Returns: a new, ANY CapsFeatures

Creates a new, ANY CapsFeatures. This will be equal to any other CapsFeatures but caps with these are unfixed.

Since: 1.2

newEmpty

capsFeaturesNewEmpty

Arguments

:: (HasCallStack, MonadIO m)

=> m CapsFeatures

Returns: a new, empty CapsFeatures

Creates a new, empty CapsFeatures.

Since: 1.2

newSingle

capsFeaturesNewSingle

Arguments

:: (HasCallStack, MonadIO m)

=> Text

feature: The feature

-> m CapsFeatures

Returns: a new CapsFeatures

Creates a new CapsFeatures with a single feature.

Since: 1.20

remove

capsFeaturesRemove

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature.

-> m ()

Removes feature from features.

Since: 1.2

removeId

capsFeaturesRemoveId

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature.

-> m ()

Removes feature from features.

Since: 1.2

setParentRefcount

capsFeaturesSetParentRefcount

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures

-> Int32

refcount: a pointer to the parent's refcount

-> m Bool

Returns: True if the parent refcount could be set.

Sets the parent_refcount field of CapsFeatures. This field is used to determine whether a caps features is mutable or not. This function should only be called by code implementing parent objects of CapsFeatures, as described in the MT refcounting design document.

Since: 1.2

toString

capsFeaturesToString

Arguments

:: (HasCallStack, MonadIO m)

=> CapsFeatures

features: a CapsFeatures

-> m Text

Returns: a pointer to string allocated by malloc.

Converts features to a human-readable string representation.

For debugging purposes its easier to do something like this:

C code

GST_LOG ("features is %" GST_PTR_FORMAT, features);

This prints the features in human readable form.

Since: 1.2