GstCaps: GStreamer 1.0 Core Reference Manual

## GstCaps GstCaps |

## Functions

#define | GST_CAPS_REFCOUNT()
#define | GST_CAPS_REFCOUNT_VALUE()
#define | GST_CAPS_IS_SIMPLE()
#define | GST_STATIC_CAPS()
#define | GST_CAPS_FLAGS()
#define | GST_CAPS_FLAG_IS_SET()
#define | GST_CAPS_FLAG_SET()
#define | GST_CAPS_FLAG_UNSET()
gboolean | (*GstCapsForeachFunc) ()
gboolean | (*GstCapsMapFunc) ()
gboolean | (*GstCapsFilterMapFunc) ()
GstCaps * | gst_caps_new_empty ()
GstCaps * | gst_caps_new_empty_simple ()
GstCaps * | gst_caps_new_any ()
GstCaps * | gst_caps_new_simple ()
GstCaps * | gst_caps_new_full ()
GstCaps * | gst_caps_new_full_valist ()
#define | gst_caps_is_writable()
GstCaps * | gst_caps_copy ()
GstCaps * | gst_caps_copy_nth ()
GstCaps * | gst_static_caps_get ()
void | gst_static_caps_cleanup ()
void | gst_caps_append ()
GstCaps * | gst_caps_merge ()
void | gst_caps_append_structure ()
void | gst_caps_append_structure_full ()
void | gst_caps_remove_structure ()
GstStructure * | gst_caps_steal_structure ()
GstCaps * | gst_caps_merge_structure ()
GstCaps * | gst_caps_merge_structure_full ()
guint | gst_caps_get_size ()
GstStructure * | gst_caps_get_structure ()
GstCapsFeatures * | gst_caps_get_features ()
void | gst_caps_set_features ()
void | gst_caps_set_value ()
void | gst_caps_set_simple ()
void | gst_caps_set_simple_valist ()
gboolean | gst_caps_foreach ()
gboolean | gst_caps_map_in_place ()
void | gst_caps_filter_and_map_in_place ()
gboolean | gst_caps_is_any ()
gboolean | gst_caps_is_empty ()
gboolean | gst_caps_is_fixed ()
gboolean | gst_caps_is_equal ()
gboolean | gst_caps_is_equal_fixed ()
gboolean | gst_caps_is_strictly_equal ()
gboolean | gst_caps_is_always_compatible ()
gboolean | gst_caps_is_subset ()
gboolean | gst_caps_is_subset_structure ()
gboolean | gst_caps_is_subset_structure_full ()
gboolean | gst_caps_can_intersect ()
GstCaps * | gst_caps_intersect ()
GstCaps * | gst_caps_intersect_full ()
GstCaps * | gst_caps_normalize ()
GstCaps * | gst_caps_simplify ()
gboolean | gst_caps_replace ()
gboolean | gst_caps_take ()
gchar * | gst_caps_to_string ()
GstCaps * | gst_caps_from_string ()
GstCaps * | gst_caps_subtract ()
#define | gst_caps_make_writable()
GstCaps * | gst_caps_truncate ()
GstCaps * | gst_caps_fixate ()
GstCaps * | gst_caps_ref ()
void | gst_caps_unref ()

## Types and Values

struct | GstCaps
struct | GstStaticCaps
enum | GstCapsIntersectMode
enum | GstCapsFlags
#define | GST_CAPS_ANY
#define | GST_CAPS_NONE
#define | GST_STATIC_CAPS_ANY
#define | GST_STATIC_CAPS_NONE

## Object Hierarchy

        GBoxed
        ╰── GstCaps

## Includes

    #include <gst/gst.h>

## Description

## Functions

### GST_CAPS_REFCOUNT()

    #define GST_CAPS_REFCOUNT(caps)                 GST_MINI_OBJECT_REFCOUNT(caps)

### GST_CAPS_REFCOUNT_VALUE()

    #define GST_CAPS_REFCOUNT_VALUE(caps)           GST_MINI_OBJECT_REFCOUNT_VALUE(caps)

### GST_CAPS_IS_SIMPLE()

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

### GST_STATIC_CAPS()

    #define             GST_STATIC_CAPS(string)

### GST_CAPS_FLAGS()

    #define GST_CAPS_FLAGS(caps)                    GST_MINI_OBJECT_FLAGS(caps)

### GST_CAPS_FLAG_IS_SET()

    #define GST_CAPS_FLAG_IS_SET(caps,flag)        GST_MINI_OBJECT_FLAG_IS_SET (caps, flag)

### GST_CAPS_FLAG_SET()

    #define GST_CAPS_FLAG_SET(caps,flag)           GST_MINI_OBJECT_FLAG_SET (caps, flag)

### GST_CAPS_FLAG_UNSET()

    #define GST_CAPS_FLAG_UNSET(caps,flag)         GST_MINI_OBJECT_FLAG_UNSET (caps, flag)

### GstCapsForeachFunc ()

    gboolean
    (*GstCapsForeachFunc) (GstCapsFeatures *features,
                           GstStructure *structure,
                           gpointer user_data);

### GstCapsMapFunc ()

    gboolean
    (*GstCapsMapFunc) (GstCapsFeatures *features,
                       GstStructure *structure,
                       gpointer user_data);

### GstCapsFilterMapFunc ()

    gboolean
    (*GstCapsFilterMapFunc) (GstCapsFeatures *features,
                             GstStructure *structure,
                             gpointer user_data);

### gst_caps_new_empty ()

    GstCaps *
    gst_caps_new_empty (void);

### gst_caps_new_empty_simple ()

    GstCaps *
    gst_caps_new_empty_simple (const char *media_type);

### gst_caps_new_any ()

    GstCaps *
    gst_caps_new_any (void);

### gst_caps_new_simple ()

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

### gst_caps_new_full ()

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

### gst_caps_new_full_valist ()

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

### gst_caps_is_writable()

    #define         gst_caps_is_writable(caps)     gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (caps))

### gst_caps_copy ()

    GstCaps *
    gst_caps_copy (const GstCaps *caps);

### gst_caps_copy_nth ()

    GstCaps *
    gst_caps_copy_nth (const GstCaps *caps,
                       guint nth);

### gst_static_caps_get ()

    GstCaps *
    gst_static_caps_get (GstStaticCaps *static_caps);

### gst_static_caps_cleanup ()

    void
    gst_static_caps_cleanup (GstStaticCaps *static_caps);

### gst_caps_append ()

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

### gst_caps_merge ()

    GstCaps *
    gst_caps_merge (GstCaps *caps1,
                    GstCaps *caps2);

### gst_caps_append_structure ()

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

### gst_caps_append_structure_full ()

    void
    gst_caps_append_structure_full (GstCaps *caps,
                                    GstStructure *structure,
                                    GstCapsFeatures *features);

### gst_caps_remove_structure ()

    void
    gst_caps_remove_structure (GstCaps *caps,
                               guint idx);

### gst_caps_steal_structure ()

    GstStructure *
    gst_caps_steal_structure (GstCaps *caps,
                              guint index);

### gst_caps_merge_structure ()

    GstCaps *
    gst_caps_merge_structure (GstCaps *caps,
                              GstStructure *structure);

### gst_caps_merge_structure_full ()

    GstCaps *
    gst_caps_merge_structure_full (GstCaps *caps,
                                   GstStructure *structure,
                                   GstCapsFeatures *features);

### gst_caps_get_size ()

    guint
    gst_caps_get_size (const GstCaps *caps);

### gst_caps_get_structure ()

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

### gst_caps_get_features ()

    GstCapsFeatures *
    gst_caps_get_features (const GstCaps *caps,
                           guint index);

### gst_caps_set_features ()

    void
    gst_caps_set_features (GstCaps *caps,
                           guint index,
                           GstCapsFeatures *features);

### gst_caps_set_value ()

    void
    gst_caps_set_value (GstCaps *caps,
                        const char *field,
                        const GValue *value);

### gst_caps_set_simple ()

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

### gst_caps_set_simple_valist ()

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

### gst_caps_foreach ()

    gboolean
    gst_caps_foreach (const GstCaps *caps,
                      GstCapsForeachFunc func,
                      gpointer user_data);

### gst_caps_map_in_place ()

    gboolean
    gst_caps_map_in_place (GstCaps *caps,
                           GstCapsMapFunc func,
                           gpointer user_data);

### gst_caps_filter_and_map_in_place ()

    void
    gst_caps_filter_and_map_in_place (GstCaps *caps,
                                      GstCapsFilterMapFunc func,
                                      gpointer user_data);

### gst_caps_is_any ()

    gboolean
    gst_caps_is_any (const GstCaps *caps);

### gst_caps_is_empty ()

    gboolean
    gst_caps_is_empty (const GstCaps *caps);

### gst_caps_is_fixed ()

    gboolean
    gst_caps_is_fixed (const GstCaps *caps);

### gst_caps_is_equal ()

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

### gst_caps_is_equal_fixed ()

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

### gst_caps_is_strictly_equal ()

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

### gst_caps_is_always_compatible ()

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

### gst_caps_is_subset ()

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

### gst_caps_is_subset_structure ()

    gboolean
    gst_caps_is_subset_structure (const GstCaps *caps,
                                  const GstStructure *structure);

### gst_caps_is_subset_structure_full ()

    gboolean
    gst_caps_is_subset_structure_full (const GstCaps *caps,
                                       const GstStructure *structure,
                                       const GstCapsFeatures *features);

### gst_caps_can_intersect ()

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

### gst_caps_intersect ()

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

### gst_caps_intersect_full ()

    GstCaps *
    gst_caps_intersect_full (GstCaps *caps1,
                             GstCaps *caps2,
                             GstCapsIntersectMode mode);

### gst_caps_normalize ()

    GstCaps *
    gst_caps_normalize (GstCaps *caps);

### gst_caps_simplify ()

    GstCaps *
    gst_caps_simplify (GstCaps *caps);

### gst_caps_replace ()

    gboolean
    gst_caps_replace (GstCaps **old_caps,
                      GstCaps *new_caps);

### gst_caps_take ()

    gboolean
    gst_caps_take (GstCaps **old_caps,
                   GstCaps *new_caps);

### gst_caps_to_string ()

    gchar *
    gst_caps_to_string (const GstCaps *caps);

### gst_caps_from_string ()

    GstCaps *
    gst_caps_from_string (const gchar *string);

### gst_caps_subtract ()

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

### gst_caps_make_writable()

    #define         gst_caps_make_writable(caps)   GST_CAPS_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (caps)))

### gst_caps_truncate ()

    GstCaps *
    gst_caps_truncate (GstCaps *caps);

### gst_caps_fixate ()

    GstCaps *
    gst_caps_fixate (GstCaps *caps);

### gst_caps_ref ()

    GstCaps *
    gst_caps_ref (GstCaps *caps);

### gst_caps_unref ()

    void
    gst_caps_unref (GstCaps *caps);

## Types and Values

### struct GstCaps

    struct GstCaps {
      GstMiniObject mini_object;
    };

### struct GstStaticCaps

    struct GstStaticCaps {
      GstCaps *caps;
      const char *string;
    };

### enum GstCapsIntersectMode

#### Members

GST_CAPS_INTERSECT_ZIG_ZAG |  |
GST_CAPS_INTERSECT_FIRST |  |

### enum GstCapsFlags

#### Members

GST_CAPS_FLAG_ANY |  |

### GST_CAPS_ANY

    #define GST_CAPS_ANY              _gst_caps_any

### GST_CAPS_NONE

    #define GST_CAPS_NONE             _gst_caps_none

### GST_STATIC_CAPS_ANY

    #define GST_STATIC_CAPS_ANY       GST_STATIC_CAPS("ANY")

### GST_STATIC_CAPS_NONE

    #define GST_STATIC_CAPS_NONE      GST_STATIC_CAPS("NONE")