mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-06-30 03:40:41 +00:00
339012e033
Original commit message from CVS: fix up docs remove props commit automatic moving and removing of documentation
233 lines
4.4 KiB
Plaintext
233 lines
4.4 KiB
Plaintext
<!-- ##### 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. GstCaps can be named and chained into
|
|
a list, which is then a GstCaps on its own.
|
|
</para>
|
|
<para>
|
|
GstCaps are created with gst_caps_new(), which takes a name, a mime type and
|
|
a pointer to a #GstProps. A convenience macro with a cleaner syntax is
|
|
available to create a caps with GST_CAPS_NEW(). The following example shows how
|
|
to create a GstCaps.
|
|
<programlisting>
|
|
GstCaps *caps;
|
|
|
|
caps = gst_caps_new (
|
|
"my_caps", /* capability name */
|
|
"audio/raw", /* mime type */
|
|
gst_props_new ( /* properties */
|
|
"format", GST_PROPS_STRING ("float"),
|
|
"channels", GST_PROPS_INT (5),
|
|
NULL));
|
|
</programlisting>
|
|
|
|
The following code example is equivalent to the above example:
|
|
<programlisting>
|
|
GstCaps *caps;
|
|
|
|
caps = GST_CAPS_NEW (
|
|
"my_caps", /* capability name */
|
|
"audio/raw", /* mime type */
|
|
"format", GST_PROPS_STRING ("float"),
|
|
"channels", GST_PROPS_INT (5)
|
|
);
|
|
</programlisting>
|
|
</para>
|
|
<para>
|
|
GstCaps are refcounted with gst_caps_ref() and gst_caps_unref().
|
|
</para>
|
|
<para>
|
|
GstCaps can be chained with the gst_caps_append(), gst_caps_prepend() and
|
|
gst_caps_chain() functions. Use gst_caps_get_by_name() to get a named caps
|
|
structure from a chained list.
|
|
</para>
|
|
<para>
|
|
To get the properties of a caps structure the functions
|
|
gst_caps_get_boolean(), gst_caps_get_fourcc_int(), gst_caps_get_int(),
|
|
gst_caps_get_string(), gst_caps_get_float(), which all take a property name as an argument.
|
|
</para>
|
|
<para>
|
|
The properties of the caps structure can be modified with gst_caps_set, which
|
|
takes a list of key value pairs in the #GstProps syntax as shown by this example:
|
|
|
|
<programlisting>
|
|
GstCaps *caps;
|
|
....
|
|
|
|
gst_caps_set (caps, "format", GST_PROPS_STRING ("int"), NULL);
|
|
gst_caps_set (caps, "channels", GST_PROPS_INT (20), NULL);
|
|
|
|
</programlisting>
|
|
</para>
|
|
<para>
|
|
before modifying a GstCaps, it is a good idea to make a copy if it first with
|
|
gst_caps_copy_on_write(). This will copy the GstCaps if the refcount is >1.
|
|
</para>
|
|
<para>
|
|
If you need a unique instance of a GstCaps you can use the convenient
|
|
GST_CAPS_FACTORY() macro as shown below.
|
|
<programlisting>
|
|
GST_CAPS_FACTORY (my_caps,
|
|
GST_CAPS_NEW (
|
|
"caps1",
|
|
"audio/raw",
|
|
"format", GST_PROPS_STRING ("float"),
|
|
"channels", GST_PROPS_INT (5)
|
|
),
|
|
GST_CAPS_NEW (
|
|
"caps2",
|
|
"audio/raw",
|
|
"format", GST_PROPS_STRING ("int"),
|
|
"channels", GST_PROPS_INT (5)
|
|
)
|
|
)
|
|
|
|
void
|
|
some_function (void)
|
|
{
|
|
GstCaps *caps = GST_CAPS_GET (my_caps);
|
|
|
|
...
|
|
}
|
|
</programlisting>
|
|
</para>
|
|
<para>
|
|
If you want to check if a link between source and destination caps
|
|
is always possible, use gst_caps_is_always_compatible(), which returns
|
|
a boolean.
|
|
If you want to check if a link between source and destination caps
|
|
might be possible, use gst_caps_intersect(), which returns an intersection
|
|
of the capabilities.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
#GstProps, #GstPad
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_TYPE_CAPS ##### -->
|
|
<para>
|
|
The GType of the caps boxed type, for use in GValues.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GstCaps ##### -->
|
|
<para>
|
|
The gstcaps structure
|
|
</para>
|
|
|
|
@type:
|
|
@flags:
|
|
@structs:
|
|
|
|
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_append ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps1:
|
|
@caps2:
|
|
<!-- # Unused Parameters # -->
|
|
@caps:
|
|
@capstoadd:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps:
|
|
@newcaps:
|
|
<!-- # Unused Parameters # -->
|
|
@oldcaps:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps1:
|
|
@caps2:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@fromcaps:
|
|
@tocaps:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_normalize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps1:
|
|
@caps2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps:
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_load_thyself ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_caps_union ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@caps1:
|
|
@caps2:
|
|
@Returns:
|
|
|
|
|