gstreamer/docs/gst/tmpl/gstcaps.sgml
Wim Taymans 426ac6ae66 More docs updates
Original commit message from CVS:
More docs updates
2001-03-27 17:34:39 +00:00

327 lines
3.6 KiB
Text

<!-- ##### SECTION Title ##### -->
GstCaps
<!-- ##### SECTION Short_Description ##### -->
Capabilities of pads
<!-- ##### SECTION Long_Description ##### -->
<para>
GstCaps is used to attach capabilities to a pad. Capabilities are made of
a mime-type and a set of properties.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
<para>
Lock the caps structure
</para>
@caps: The caps structure to lock
<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
<para>
Try to lock the caps structure
</para>
@caps: The caps structure to try to lock
<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
<para>
Unlock the caps structure
</para>
@caps: The caps structure to unlock
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@name: the name of the capability, for the application
@id: the typeid of the capability
@refcount: a refcounter for this caps structure
@lock: the lock for this caps structure
@properties: the properties of the capability
@next: a pointer to the next caps.
<!-- ##### TYPEDEF GstCapsFactory ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstCapsFactory[] ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_caps_new ##### -->
<para>
</para>
@name:
@mime:
@Returns:
<!-- ##### FUNCTION gst_caps_new_with_props ##### -->
<para>
</para>
@name:
@mime:
@props:
@Returns:
<!-- ##### FUNCTION gst_caps_destroy ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_ref ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_unref ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_register ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_caps_register_count ##### -->
<para>
</para>
@factory:
@counter:
@Returns:
<!-- # Unused Parameters # -->
@count:
<!-- ##### FUNCTION gst_caps_copy ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_append ##### -->
<para>
</para>
@caps:
@capstoadd:
@Returns:
<!-- ##### FUNCTION gst_caps_prepend ##### -->
<para>
</para>
@caps:
@capstoadd:
@Returns:
<!-- ##### FUNCTION gst_caps_set_name ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_get_name ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
<para>
</para>
@caps:
@type_id:
<!-- # Unused Parameters # -->
@Param2:
@typeid:
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_mime ##### -->
<para>
</para>
@caps:
@mime:
<!-- ##### FUNCTION gst_caps_get_mime ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_set_props ##### -->
<para>
</para>
@caps:
@props:
@Returns:
<!-- ##### FUNCTION gst_caps_get_props ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_check_compatibility ##### -->
<para>
</para>
@fromcaps:
@tocaps:
@Returns:
<!-- ##### MACRO gst_caps_set ##### -->
<para>
</para>
@caps:
@name:
@args...:
<!-- ##### MACRO gst_caps_get_boolean ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_get_by_name ##### -->
<para>
</para>
@caps:
@name:
@Returns:
<!-- ##### MACRO gst_caps_get_fourcc_int ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### MACRO gst_caps_get_int ##### -->
<para>
</para>
@caps:
@name:
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
<para>
</para>
@caps:
@parent:
@Returns:
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
<para>
</para>
@parent:
@Returns: