Gjsify LogoGjsify Logo

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

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

record

Hierarchy

  • CapsFeatures

Index

Constructors

Properties

name: string

Methods

  • add(feature: string): void
  • Adds feature to features.

    Parameters

    • feature: string

      a feature.

    Returns void

  • addId(feature: number): void
  • Adds feature to features.

    Parameters

    • feature: number

      a feature.

    Returns void

  • contains(feature: string): boolean
  • Checks if features contains feature.

    Parameters

    • feature: string

      a feature

    Returns boolean

  • containsId(feature: number): boolean
  • Checks if features contains feature.

    Parameters

    • feature: number

      a feature

    Returns boolean

  • free(): void
  • Frees a #GstCapsFeatures and all its values. The caps features must not have a parent when this function is called.

    Returns void

  • getNth(i: number): string
  • Returns the i-th feature of features.

    Parameters

    • i: number

      index of the feature

    Returns string

  • getNthId(i: number): number
  • Returns the i-th feature of features.

    Parameters

    • i: number

      index of the feature

    Returns number

  • getSize(): number
  • isAny(): boolean
  • Checks if features is %GST_CAPS_FEATURES_ANY.

    Returns boolean

  • remove(feature: string): void
  • Removes feature from features.

    Parameters

    • feature: string

      a feature.

    Returns void

  • removeId(feature: number): void
  • Removes feature from features.

    Parameters

    • feature: number

      a feature.

    Returns void

  • setParentRefcount(refcount: number): boolean
  • Sets the parent_refcount field of #GstCapsFeatures. 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 #GstCapsFeatures, as described in the MT refcounting design document.

    Parameters

    • refcount: number

      a pointer to the parent's refcount

    Returns boolean

  • toString(): string
  • 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

  • Creates a #GstCapsFeatures from a string representation.

    Parameters

    • features: string

      a string representation of a #GstCapsFeatures.

    Returns CapsFeatures

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

    Returns CapsFeatures

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method