gstreamer/docs/gst/tmpl/gstcaps.sgml
Thomas Vander Stichele 0944ac134b some more docs cleanup
Original commit message from CVS:
some more docs cleanup
2005-06-19 10:54:12 +00:00

388 lines
4.6 KiB
Text

<!-- ##### SECTION Title ##### -->
GstCaps
<!-- ##### SECTION Short_Description ##### -->
Structure describing sets of media formats
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@type:
@refcount:
@flags:
@structs:
<!-- ##### STRUCT GstStaticCaps ##### -->
<para>
</para>
@caps:
@string:
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
<para>
Flags that this caps has no specific content, but can contain anything.
</para>
<!-- ##### MACRO GST_CAPS_ANY ##### -->
<para>
Means that the element/pad can output 'anything'. Useful for elements
that output unknown media, such as filesrc.
</para>
<!-- ##### MACRO GST_CAPS_NONE ##### -->
<para>
The opposite of GST_CAPS_ANY: it means that the pad/element outputs an
undefined media type that can not be detected.
</para>
<!-- ##### MACRO GST_STATIC_CAPS_ANY ##### -->
<para>
Creates a static caps that matches anything. This can be used in pad
templates.
</para>
@Returns: a new #GstCaps instance
<!-- ##### MACRO GST_STATIC_CAPS_NONE ##### -->
<para>
Creates a static caps that matches nothing. This can be used in pad
templates.
</para>
@Returns: a new #GstCaps instance
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
<para>
Convinience macro that checks if the number of structures in the gives caps is
exactly one.
</para>
@caps: the #GstCaps instance to check
<!-- ##### MACRO gst_caps_is_simple ##### -->
<para>
</para>
@caps:
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
<para>
Convinience macro for prining out the contents of caps with GST_DEBUG().
</para>
@string: a string the should be prepend to the caps data.
@caps: the caps to print
<!-- ##### MACRO GST_STATIC_CAPS ##### -->
<para>
Creates a static caps from an input string. This can be used in pad
templates.
</para>
@string: the string describing the caps.
@Returns: a new #GstCaps instance
<!-- ##### 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:
<!-- ##### FUNCTION gst_caps_copy ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_static_caps_get ##### -->
<para>
</para>
@static_caps:
@Returns:
<!-- # Unused Parameters # -->
@caps:
<!-- ##### FUNCTION gst_caps_append ##### -->
<para>
</para>
@caps1:
@caps2:
<!-- ##### FUNCTION gst_caps_append_structure ##### -->
<para>
</para>
@caps:
@structure:
<!-- # Unused Parameters # -->
@caps1:
<!-- ##### FUNCTION gst_caps_get_size ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### 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:
<!-- ##### FUNCTION gst_caps_is_equal ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_is_subset ##### -->
<para>
</para>
@subset:
@superset:
@Returns:
<!-- ##### FUNCTION gst_caps_intersect ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_union ##### -->
<para>
</para>
@caps1:
@caps2:
@Returns:
<!-- ##### FUNCTION gst_caps_normalize ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_do_simplify ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
<para>
</para>
@caps:
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_replace ##### -->
<para>
</para>
@caps:
@newcaps:
<!-- ##### FUNCTION gst_caps_to_string ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_from_string ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION gst_caps_subtract ##### -->
<para>
</para>
@minuend:
@subtrahend:
@Returns: