2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GstCaps
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2004-03-25 04:20:33 +00:00
|
|
|
Structure describing sets of media formats
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
</para>
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
|
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
Flags that this caps has no specific content, but can contain anything.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_CAPS_ANY ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
Means that the element/pad can output 'anything'. Useful for elements
|
|
|
|
that output unknown media, such as filesrc.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_CAPS_NONE ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
The opposite of GST_CAPS_ANY: it means that the pad/element outputs an
|
|
|
|
undefined media type that can not be detected.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
Creates a static caps that matches anything. This can be used in pad
|
|
|
|
templates.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2004-09-02 14:24:22 +00:00
|
|
|
@Returns: a new #GstCaps instance
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
<!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
Creates a static caps that matches nothing. This can be used in pad
|
|
|
|
templates.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2004-09-02 14:24:22 +00:00
|
|
|
@Returns: a new #GstCaps instance
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
|
|
|
|
<para>
|
2004-11-03 09:21:01 +00:00
|
|
|
Convinience macro that checks if the number of structures in the gives caps is
|
|
|
|
exactly one.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
2004-11-03 09:21:01 +00:00
|
|
|
@caps: the #GstCaps instance to check
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_caps_is_simple ##### -->
|
2002-10-01 22:17:58 +00:00
|
|
|
<para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
2002-10-01 22:17:58 +00:00
|
|
|
</para>
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
@caps:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-11-03 09:21:01 +00:00
|
|
|
Convinience macro for prining out the contents of caps with GST_DEBUG().
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2004-11-03 09:21:01 +00:00
|
|
|
@string: a string the should be prepend to the caps data.
|
|
|
|
@caps: the caps to print
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_STATIC_CAPS ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
2004-09-02 14:24:22 +00:00
|
|
|
Creates a static caps from an input string. This can be used in pad
|
|
|
|
templates.
|
2002-01-15 00:41:22 +00:00
|
|
|
</para>
|
|
|
|
|
2004-09-02 14:24:22 +00:00
|
|
|
@string: the string describing the caps.
|
|
|
|
@Returns: a new #GstCaps instance
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2003-02-10 23:01:55 +00:00
|
|
|
<!-- ##### STRUCT GstCaps ##### -->
|
|
|
|
<para>
|
2004-03-25 04:20:33 +00:00
|
|
|
|
2003-02-10 23:01:55 +00:00
|
|
|
</para>
|
|
|
|
|
2004-01-07 16:32:24 +00:00
|
|
|
@type:
|
2005-03-29 10:55:39 +00:00
|
|
|
@refcount:
|
2003-02-10 23:01:55 +00:00
|
|
|
@flags:
|
2004-01-07 16:32:24 +00:00
|
|
|
@structs:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### STRUCT GstStaticCaps ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@string:
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_new_empty ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_new_any ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_new_simple ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@media_type:
|
|
|
|
@fieldname:
|
|
|
|
@Varargs:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_new_full ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@struct1:
|
|
|
|
@Varargs:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_new_full_valist ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@var_args:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### FUNCTION gst_static_caps_get ##### -->
|
2002-06-12 22:27:18 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-03-30 07:36:19 +00:00
|
|
|
@static_caps:
|
2002-06-12 22:27:18 +00:00
|
|
|
@Returns:
|
2004-03-30 07:36:19 +00:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@caps:
|
2002-06-12 22:27:18 +00:00
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_append ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-01-07 16:32:24 +00:00
|
|
|
@caps1:
|
|
|
|
@caps2:
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_append_structure ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-03-30 07:36:19 +00:00
|
|
|
@caps:
|
2004-03-25 04:20:33 +00:00
|
|
|
@structure:
|
2004-03-30 07:36:19 +00:00
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@caps1:
|
2004-03-25 04:20:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_get_size ##### -->
|
2003-02-10 23:01:55 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-01-07 16:32:24 +00:00
|
|
|
@caps:
|
2004-03-25 04:20:33 +00:00
|
|
|
@Returns:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_get_structure ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@index:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_set_simple ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@field:
|
|
|
|
@Varargs:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_set_simple_valist ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@field:
|
|
|
|
@varargs:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_is_any ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_is_empty ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_is_fixed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_is_equal ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps1:
|
|
|
|
@caps2:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
@caps1:
|
|
|
|
@caps2:
|
2002-01-15 00:41:22 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_is_subset ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@subset:
|
|
|
|
@superset:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps1:
|
|
|
|
@caps2:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_union ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps1:
|
|
|
|
@caps2:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_normalize ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_do_simplify ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2004-04-22 23:50:46 +00:00
|
|
|
@Returns:
|
2004-04-22 16:39:23 +00:00
|
|
|
|
|
|
|
|
2002-01-15 00:41:22 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
2002-01-15 00:41:22 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2004-03-25 04:20:33 +00:00
|
|
|
@caps:
|
|
|
|
@newcaps:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_to_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_from_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@string:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@field_name:
|
|
|
|
@target:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@structure:
|
|
|
|
@field_name:
|
|
|
|
@target:
|
2004-01-07 16:32:24 +00:00
|
|
|
@Returns:
|
2002-01-15 00:41:22 +00:00
|
|
|
|
|
|
|
|
2004-04-22 16:39:23 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_subtract ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@minuend:
|
|
|
|
@subtrahend:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|