mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-20 07:16:55 +00:00
bbf6413bdf
Original commit message from CVS: fix build
581 lines
7.6 KiB
Text
581 lines
7.6 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstValue
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
GValue implementations specific to GStreamer
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
|
|
<para>
|
|
will transform four characters into a host-endiannness guint32 fourcc:
|
|
<informalexample>
|
|
<programlisting>
|
|
guint32 fourcc = GST_MAKE_FOURCC ('M','J','P','G');
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
|
|
@a: the first component
|
|
@b: the second component
|
|
@c: the third component
|
|
@d: the fourth component
|
|
|
|
|
|
<!-- ##### MACRO GST_STR_FOURCC ##### -->
|
|
<para>
|
|
Creates a fourcc from an input string. The input string should consisnt
|
|
of at least four characters (this is not checked for!).
|
|
<informalexample>
|
|
<programlisting>
|
|
guint32 fourcc = GST_STR_FOURCC("MJPG");
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
|
|
@f: a string with four characters
|
|
|
|
|
|
<!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
|
|
<para>
|
|
Can be used to properly output a fourcc (a guint32) value in a
|
|
printf()-style text message.
|
|
<informalexample>
|
|
<programlisting>
|
|
printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
|
|
<para>
|
|
Can be used to properly output a fourcc (a guint32) value in a
|
|
printf()-style text message.
|
|
<informalexample>
|
|
<programlisting>
|
|
printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
|
|
@fourcc: the fourcc value to print
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a FOURCC value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a INT_RANGE value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a DOUBLE_RANGE value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a LIST value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_FIXED_LIST ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a FIXED_LIST value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a CAPS value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
|
|
<para>
|
|
Checks if the give GValue contains a FRACTION value.
|
|
</para>
|
|
|
|
@x: the #GValue to check
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
|
|
<para>
|
|
Indicates that the first value provided to a comparison function
|
|
(gst_value_compare()) is lesser than the second one.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_EQUAL ##### -->
|
|
<para>
|
|
Indicates that the first value provided to a comparison function
|
|
(gst_value_compare()) is equal to the second one.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
|
|
<para>
|
|
Indicates that the first value provided to a comparison function
|
|
(gst_value_compare()) is greater than the second one.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_VALUE_UNORDERED ##### -->
|
|
<para>
|
|
Indicates that the comparison function (gst_value_compare()) can not
|
|
determine a order for the two provided values.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@value2:
|
|
@Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL,
|
|
GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@s:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@minuend:
|
|
@subtrahend:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### STRUCT GstValueTable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@compare:
|
|
@serialize:
|
|
@deserialize:
|
|
|
|
<!-- ##### FUNCTION gst_type_is_fixed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_is_fixed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_register ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@table:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@src:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_serialize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_deserialize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@src:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_list_append_value ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@append_value:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@prepend_value:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_list_concat ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@value1:
|
|
@value2:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_list_get_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_list_get_value ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@index:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@fourcc:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_set_int_range ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@start:
|
|
@end:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_set_double_range ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@start:
|
|
@end:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_caps ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_set_caps ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@caps:
|
|
<!-- # Unused Parameters # -->
|
|
@calue:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_set_fraction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value:
|
|
@numerator:
|
|
@denominator:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@product:
|
|
@factor1:
|
|
@factor2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_compare ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_can_compare ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_union ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_can_union ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_register_union_func ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type1:
|
|
@type2:
|
|
@func:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_subtract ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@minuend:
|
|
@subtrahend:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_can_subtract ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@minuend:
|
|
@subtrahend:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_register_subtract_func ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@minuend_type:
|
|
@subtrahend_type:
|
|
@func:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_intersect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@dest:
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@value1:
|
|
@value2:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type1:
|
|
@type2:
|
|
@func:
|
|
|
|
|