GST_CAPS_FLAGS_ANY

#define GST_CAPS_FLAGS_ANY	  (1 << 0)

Flags that this caps has no specific content, but can contain anything.

GST_CAPS_ANY

#define GST_CAPS_ANY              gst_caps_new_any()

Means that the element/pad can output 'anything'. Useful for elements that output unknown media, such as filesrc.

GST_CAPS_NONE

#define GST_CAPS_NONE             gst_caps_new_empty()

The opposite of GST_CAPS_ANY: it means that the pad/element outputs an undefined media type that can not be detected.

GST_STATIC_CAPS_ANY

#define GST_STATIC_CAPS_ANY       GST_STATIC_CAPS("ANY")

Creates a static caps that matches anything. This can be used in pad templates.

GST_STATIC_CAPS_NONE

#define GST_STATIC_CAPS_NONE      GST_STATIC_CAPS("NONE")

Creates a static caps that matches nothing. This can be used in pad templates.

GST_CAPS_IS_SIMPLE()

#define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)

Convinience macro that checks if the number of structures in the gives caps is exactly one.

gst_caps_is_simple()

#define gst_caps_is_simple(caps) GST_CAPS_IS_SIMPLE(caps)

GST_DEBUG_CAPS()

#define     GST_DEBUG_CAPS(string, caps)

Convinience macro for prining out the contents of caps with GST_DEBUG().

GST_STATIC_CAPS()

#define     GST_STATIC_CAPS(string)

Creates a static caps from an input string. This can be used in pad templates.

struct GstCaps

struct GstCaps {

  GType type;

  guint16 flags;
  GPtrArray *structs;

  gpointer _gst_reserved[GST_PADDING];
};

struct GstStaticCaps

struct GstStaticCaps {

  GstCaps caps;
  const char *string;
  gpointer _gst_reserved[GST_PADDING];
};

gst_caps_new_empty ()

GstCaps*    gst_caps_new_empty              (void);

Creates a new GstCaps that is empty. That is, the returned GstCaps contains no media formats.

gst_caps_new_any ()

GstCaps*    gst_caps_new_any                (void);

Creates a new GstCaps that indicates that it is compatible with any media format.

gst_caps_new_simple ()

GstCaps*    gst_caps_new_simple             (const char *media_type,
                                             const char *fieldname,
                                             ...);

Creates a new GstCaps that contains one GstStructure. The structure is defined by the arguments, which have the same format as @gst_structure_new().

gst_caps_new_full ()

GstCaps*    gst_caps_new_full               (GstStructure *struct1,
                                             ...);

Creates a new GstCaps and adds all the structures listed as arguments. The list must be NULL-terminated. The structures are not copied; the returned GstCaps owns the structures.

gst_caps_new_full_valist ()

GstCaps*    gst_caps_new_full_valist        (GstStructure *structure,
                                             va_list var_args);

Creates a new GstCaps and adds all the structures listed as arguments. The list must be NULL-terminated. The structures are not copied; the returned GstCaps owns the structures.

gst_caps_copy ()

GstCaps*    gst_caps_copy                   (const GstCaps *caps);

Deeply copies a GstCaps, including all structures and all the structures' values.

gst_caps_free ()

void        gst_caps_free                   (GstCaps *caps);

Frees a GstCaps and all its structures and the structures' values.

gst_static_caps_get ()

G_CONST_RETURN GstCaps* gst_static_caps_get (GstStaticCaps *static_caps);

Converts a GstStaticCaps to a GstCaps.

gst_caps_append ()

void        gst_caps_append                 (GstCaps *caps1,
                                             GstCaps *caps2);

Appends the structures contained in caps2 to caps1. The structures in caps2 are not copied -- they are transferred to caps1, and then caps2 is freed.

gst_caps_append_structure ()

void        gst_caps_append_structure       (GstCaps *caps,
                                             GstStructure *structure);

Appends structure to caps. The structure is not copied; caps becomes the owner of structure.

gst_caps_split_one ()

GstCaps*    gst_caps_split_one              (GstCaps *caps);

This function is not implemented.

gst_caps_get_size ()

int         gst_caps_get_size               (const GstCaps *caps);

Gets the number of structures contained in caps.

gst_caps_get_structure ()

GstStructure* gst_caps_get_structure        (const GstCaps *caps,
                                             int index);

Finds the structure in caps that has the index index, and returns it.

WARNING: This function takes a const GstCaps *, but returns a non-const GstStructure *. This is for programming convenience -- the caller should be aware that structures inside a constant GstCaps should not be modified.

gst_caps_copy_1 ()

GstCaps*    gst_caps_copy_1                 (const GstCaps *caps);

Creates a new GstCaps and appends a copy of the first structure contained in caps.

gst_caps_set_simple ()

void        gst_caps_set_simple             (GstCaps *caps,
                                             char *field,
                                             ...);

Sets fields in a simple GstCaps. A simple GstCaps is one that only has one structure. The arguments must be passed in the same manner as @gst_structure_set(), and be NULL-terminated.

gst_caps_set_simple_valist ()

void        gst_caps_set_simple_valist      (GstCaps *caps,
                                             char *field,
                                             va_list varargs);

Sets fields in a simple GstCaps. A simple GstCaps is one that only has one structure. The arguments must be passed in the same manner as @gst_structure_set(), and be NULL-terminated.

gst_caps_is_any ()

gboolean    gst_caps_is_any                 (const GstCaps *caps);

Determines if caps represents any media format.

gst_caps_is_empty ()

gboolean    gst_caps_is_empty               (const GstCaps *caps);

Determines if caps represents no media formats.

gst_caps_is_chained ()

gboolean    gst_caps_is_chained             (const GstCaps *caps);

Determines if caps contains multiple GstStructures.

This function is deprecated, and should not be used in new code. Use #gst_caps_is_simple() instead.

gst_caps_is_fixed ()

gboolean    gst_caps_is_fixed               (const GstCaps *caps);

Fixed GstCaps describe exactly one format, that is, they have exactly one structure, and each field in the structure describes a fixed type. Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST.

gst_caps_is_equal ()

gboolean    gst_caps_is_equal               (const GstCaps *caps1,
                                             const GstCaps *caps2);

Checks if the given caps represent the same set of caps.

gst_caps_is_equal_fixed ()

gboolean    gst_caps_is_equal_fixed         (const GstCaps *caps1,
                                             const GstCaps *caps2);

Tests if two GstCaps are equal. This function only works on fixed GstCaps.

gst_caps_is_always_compatible ()

gboolean    gst_caps_is_always_compatible   (const GstCaps *caps1,
                                             const GstCaps *caps2);

A given GstCaps structure is always compatible with another if every media format that is in the first is also contained in the second. That is, caps1 is a subset of caps2.

gst_caps_is_subset ()

gboolean    gst_caps_is_subset              (const GstCaps *subset,
                                             const GstCaps *superset);

Checks if all caps represented by subset are also represented by superset

gst_caps_intersect ()

GstCaps*    gst_caps_intersect              (const GstCaps *caps1,
                                             const GstCaps *caps2);

Creates a new GstCaps that contains all the formats that are common to both caps1 and caps2.

gst_caps_union ()

GstCaps*    gst_caps_union                  (const GstCaps *caps1,
                                             const GstCaps *caps2);

Creates a new GstCaps that contains all the formats that are in either caps1 and caps2.

gst_caps_normalize ()

GstCaps*    gst_caps_normalize              (const GstCaps *caps);

Creates a new GstCaps that represents the same set of formats as caps, but contains no lists. Each list is expanded into separate GstStructures.

gst_caps_simplify ()

GstCaps*    gst_caps_simplify               (const GstCaps *caps);

Creates a new GstCaps that represents the same set of formats as caps, but simpler. Component structures that are identical are merged. Component structures that have ranges or lists that can be merged are also merged.

gst_caps_do_simplify ()

gboolean    gst_caps_do_simplify            (GstCaps *caps);

Modifies the given caps inplace into a representation that represents the same set of formats, but in a simpler form. Component structures that are identical are merged. Component structures that have values that can be merged are also merged.

gst_caps_save_thyself ()

xmlNodePtr  gst_caps_save_thyself           (const GstCaps *caps,
                                             xmlNodePtr parent);

Serializes a GstCaps to XML and adds it as a child node of parent.

gst_caps_load_thyself ()

GstCaps*    gst_caps_load_thyself           (xmlNodePtr parent);

Creates a GstCaps from its XML serialization.

gst_caps_replace ()

void        gst_caps_replace                (GstCaps **caps,
                                             GstCaps *newcaps);

Replaces *caps with newcaps. Frees the GstCaps in the location pointed to by caps, if applicable, then modifies caps to point to newcaps.

gst_caps_to_string ()

gchar*      gst_caps_to_string              (const GstCaps *caps);

Converts caps to a string representation. This string representation can be converted back to a GstCaps by gst_caps_from_string.

gst_caps_from_string ()

GstCaps*    gst_caps_from_string            (const gchar *string);

Converts caps from a string representation.

gst_caps_structure_fixate_field_nearest_int ()

gboolean    gst_caps_structure_fixate_field_nearest_int
                                            (GstStructure *structure,
                                             const char *field_name,
                                             int target);

Fixates a GstStructure by changing the given field to the nearest integer to target that is a subset of the existing field.

gst_caps_structure_fixate_field_nearest_double ()

gboolean    gst_caps_structure_fixate_field_nearest_double
                                            (GstStructure *structure,
                                             const char *field_name,
                                             double target);

Fixates a GstStructure by changing the given field to the nearest double to target that is a subset of the existing field.

gst_caps_subtract ()

GstCaps*    gst_caps_subtract               (const GstCaps *minuend,
                                             const GstCaps *subtrahend);

Subtracts the subtrahend from the minuend.