gi-gst-1.0.18: GStreamer bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.CapsFeatures

Contents

Description

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

Synopsis

Exported types

newtype CapsFeatures Source #

Memory-managed wrapper type.

Instances
BoxedObject CapsFeatures Source # 
Instance details

Defined in GI.Gst.Structs.CapsFeatures

Methods

add

capsFeaturesAdd Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature.

-> m () 

Adds feature to features.

Since: 1.2

addId

capsFeaturesAddId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature.

-> m () 

Adds feature to features.

Since: 1.2

contains

capsFeaturesContains Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature

-> m Bool

Returns: True if features contains feature.

Check if features contains feature.

Since: 1.2

containsId

capsFeaturesContainsId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature

-> m Bool

Returns: True if features contains feature.

Check if features contains feature.

Since: 1.2

copy

capsFeaturesCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures to duplicate

-> m CapsFeatures

Returns: a new CapsFeatures.

Duplicates a CapsFeatures and all its values.

Free-function: gst_caps_features_free

Since: 1.2

free

capsFeaturesFree Source #

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

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. Free with capsFeaturesFree after use.

Creates a CapsFeatures from a string representation.

Free-function: gst_caps_features_free

Since: 1.2

getNth

capsFeaturesGetNth Source #

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

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

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

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> m Bool

Returns: True if features is GST_CAPS_FEATURES_ANY.

Check if features is GST_CAPS_FEATURES_ANY.

Since: 1.2

isEqual

capsFeaturesIsEqual Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features1: a CapsFeatures.

-> CapsFeatures

features2: a CapsFeatures.

-> m Bool

Returns: True if features1 and features2 are equal.

Check if features1 and features2 are equal.

Since: 1.2

newAny

capsFeaturesNewAny Source #

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.

Free-function: gst_caps_features_free

Since: 1.2

newEmpty

capsFeaturesNewEmpty Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m CapsFeatures

Returns: a new, empty CapsFeatures

Creates a new, empty CapsFeatures.

Free-function: gst_caps_features_free

Since: 1.2

remove

capsFeaturesRemove Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Text

feature: a feature.

-> m () 

Removes feature from features.

Since: 1.2

removeId

capsFeaturesRemoveId Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures.

-> Word32

feature: a feature.

-> m () 

Removes feature from features.

Since: 1.2

setParentRefcount

capsFeaturesSetParentRefcount Source #

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 section of the design documents.

Since: 1.2

toString

capsFeaturesToString Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CapsFeatures

features: a CapsFeatures

-> m Text

Returns: a pointer to string allocated by malloc. free after usage.

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.

Free-function: g_free

Since: 1.2