2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### 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>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### 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
|
|
|
|
|
|
|
|
|
2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### STRUCT GstCaps ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-01-06 22:05:15 +00:00
|
|
|
@name: the name of the capability, for the application
|
2000-12-30 16:13:17 +00:00
|
|
|
@id: the typeid of the capability
|
2001-04-16 21:43:28 +00:00
|
|
|
@refcount: a refcounter for this caps structure
|
|
|
|
@lock: the lock for this caps structure
|
2000-12-30 16:13:17 +00:00
|
|
|
@properties: the properties of the capability
|
2001-04-16 21:43:28 +00:00
|
|
|
@next: a pointer to the next caps.
|
2000-12-30 16:13:17 +00:00
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_new ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@name:
|
|
|
|
@mime:
|
|
|
|
@props:
|
|
|
|
@Returns:
|
|
|
|
|
2000-12-30 16:13:17 +00:00
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_destroy ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
2000-12-30 16:13:17 +00:00
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_ref ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
2000-12-30 16:13:17 +00:00
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_unref ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2000-12-30 16:13:17 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
2000-12-30 16:13:17 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_append ##### -->
|
2000-12-31 17:02:47 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
|
|
|
@capstoadd:
|
2000-12-31 17:02:47 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_prepend ##### -->
|
2001-01-06 02:35:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2001-04-16 21:43:28 +00:00
|
|
|
@capstoadd:
|
2001-01-06 02:35:17 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_set_name ##### -->
|
2001-01-06 02:35:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2001-04-16 21:43:28 +00:00
|
|
|
@name:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_get_name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
2001-01-06 02:35:17 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_set_type_id ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2001-04-16 21:43:28 +00:00
|
|
|
@type_id:
|
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@Param2:
|
2001-01-06 02:35:17 +00:00
|
|
|
@typeid:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_set_mime ##### -->
|
2001-01-06 02:35:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2001-04-16 21:43:28 +00:00
|
|
|
@mime:
|
2001-01-06 02:35:17 +00:00
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_get_mime ##### -->
|
2001-01-06 02:35:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
2001-04-16 21:43:28 +00:00
|
|
|
@Returns:
|
2001-01-06 02:35:17 +00:00
|
|
|
|
|
|
|
|
2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### MACRO gst_caps_set ##### -->
|
2000-12-31 17:02:47 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
@caps:
|
|
|
|
@name:
|
|
|
|
@args...:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_caps_get_boolean ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@name:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_get_by_name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@name:
|
2000-12-31 17:02:47 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-04-16 21:43:28 +00:00
|
|
|
<!-- ##### MACRO gst_caps_get_fourcc_int ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@name:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_caps_get_int ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@name:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_caps_get_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@name:
|
|
|
|
|
|
|
|
|
2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@caps:
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|