Class (GI Struct)

Gst-1.0 ▶ Gst ▶ CapsFeaturesSince 1.2

Gst.CapsFeatures can optionally be set on a Gst.Caps to add requirements for additional features for a specific Gst.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 Gst.CapsFeatures are equivalent with the Gst.CapsFeatures that only contain #GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY. ANY Gst.CapsFeatures as created by gst_caps_features_new_any() are equal to any other Gst.CapsFeatures and can be used to specify that any Gst.CapsFeatures would be supported, e.g. for elements that don't touch buffer memory. Gst.Caps with ANY Gst.CapsFeatures are considered non-fixed and during negotiation some Gst.CapsFeatures have to be selected.

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

1.2

Index

Constructors

constructor

Properties

$gtype

Methods

add add_id add_id_str add_static_str contains contains_id contains_id_str copy free get_nth get_nth_id get_nth_id_str get_size is_any is_equal remove remove_id remove_id_str set_parent_refcount to_string from_string new_any new_empty new_single new_single_static_str

Constructors

Properties

$gtype: GType<CapsFeatures>

Methods

  • Adds feature to features.

    Parameters

    • feature: string

      a feature.

    Returns void

  • Adds feature to features.

    Parameters

    • feature: number

      a feature.

    Returns void

  • Adds feature to features.

    feature needs to be valid for the remaining lifetime of the process, e.g. has to be a static string.

    Parameters

    • feature: string

      a feature.

    Returns void

  • Checks if features contains feature.

    Parameters

    • feature: string

      a feature

    Returns boolean

    true if features contains feature.

  • Checks if features contains feature.

    Parameters

    • feature: number

      a feature

    Returns boolean

    true if features contains feature.

  • Checks if features contains feature.

    Parameters

    Returns boolean

    true if features contains feature.

  • Returns the i-th feature of features.

    Parameters

    • i: number

      index of the feature

    Returns string

    The i-th feature of features.

  • Returns the i-th feature of features.

    Parameters

    • i: number

      index of the feature

    Returns number

    The i-th feature of features.

  • Returns the i-th feature of features.

    Parameters

    • i: number

      index of the feature

    Returns IdStr

    The i-th feature of features.

  • Returns the number of features in features.

    Returns number

    The number of features in features.

  • Checks if features is GST_CAPS_FEATURES_ANY.

    Returns boolean

    true if features is GST_CAPS_FEATURES_ANY.

  • Removes feature from features.

    Parameters

    • feature: string

      a feature.

    Returns void

  • Removes feature from features.

    Parameters

    • feature: number

      a feature.

    Returns void

  • Sets the parent_refcount field of Gst.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 Gst.CapsFeatures, as described in the MT refcounting design document.

    Parameters

    • refcount: number

      a pointer to the parent's refcount

    Returns boolean

    true if the parent refcount could be set.

  • Converts features to a human-readable string representation.

    For debugging purposes its easier to do something like this:

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

    This prints the features in human readable form.

    Returns string

    a pointer to string allocated by g_malloc().