summaryrefslogtreecommitdiff
path: root/docs/gst/tmpl
diff options
context:
space:
mode:
authorThomas Vander Stichele <thomas@apestaart.org>2005-09-11 12:01:12 +0000
committerThomas Vander Stichele <thomas@apestaart.org>2005-09-11 12:01:12 +0000
commitff783ad5fa4f5082b9e38366e8b8090e4646719f (patch)
tree3c28d148a288373fee9ce28ff1f6364908042038 /docs/gst/tmpl
parent574cabacbae0d88b2b475d4d0893e9ebdd315740 (diff)
docs/gst/: rearrange gstvalue section
Original commit message from CVS: * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/gstvalue.sgml: rearrange gstvalue section * gst/gstutils.c: (gst_element_state_get_name): NONE -> VOID * gst/gstvalue.c: (_gst_value_initialize): * gst/gstvalue.h: doc updates
Diffstat (limited to 'docs/gst/tmpl')
-rw-r--r--docs/gst/tmpl/gstvalue.sgml369
1 files changed, 191 insertions, 178 deletions
diff --git a/docs/gst/tmpl/gstvalue.sgml b/docs/gst/tmpl/gstvalue.sgml
index 46b27b3cf..299cf4937 100644
--- a/docs/gst/tmpl/gstvalue.sgml
+++ b/docs/gst/tmpl/gstvalue.sgml
@@ -17,190 +17,194 @@ GValue implementations specific to GStreamer
<!-- ##### SECTION Stability_Level ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
+
+
+@x:
+
+
<!-- ##### 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
+
+@a:
+@b:
+@c:
+@d:
<!-- ##### 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
+
+@f:
<!-- ##### MACRO GST_FOURCC_FORMAT ##### -->
+
+
+
+
+<!-- ##### MACRO GST_FOURCC_ARGS ##### -->
+
+
+@fourcc:
+
+
+<!-- ##### MACRO GST_TYPE_FOURCC ##### -->
<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 ##### -->
+<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
<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
+@value:
+@fourcc:
-<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
+<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
-Checks if the give GValue contains a FOURCC value.
+
</para>
-@x: the #GValue to check
+@value:
+@Returns:
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
+
+
+@x:
+
+
+<!-- ##### MACRO GST_TYPE_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 ##### -->
+<!-- ##### FUNCTION gst_value_set_int_range ##### -->
<para>
-Checks if the give GValue contains a DOUBLE_RANGE value.
+
</para>
-@x: the #GValue to check
+@value:
+@start:
+@end:
-<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
+<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
<para>
-Checks if the give GValue contains a LIST value.
+
</para>
-@x: the #GValue to check
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
+<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
<para>
-Checks if the give GValue contains a CAPS value.
+
</para>
-@x: the #GValue to check
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
+
+
+@x:
+
+
+<!-- ##### MACRO GST_TYPE_DOUBLE_RANGE ##### -->
<para>
-Checks if the give GValue contains a FRACTION value.
+
</para>
-@x: the #GValue to check
-<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
+<!-- ##### FUNCTION gst_value_set_double_range ##### -->
<para>
</para>
-@x:
+@value:
+@start:
+@end:
-<!-- ##### MACRO GST_VALUE_HOLDS_MINI_OBJECT ##### -->
+<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
<para>
</para>
@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_LESS_THAN ##### -->
+<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
<para>
-Indicates that the first value provided to a comparison function
-(gst_value_compare()) is lesser than the second one.
+
</para>
+@value:
+@Returns:
-<!-- ##### MACRO GST_VALUE_EQUAL ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
<para>
-Indicates that the first value provided to a comparison function
-(gst_value_compare()) is equal to the second one.
+Checks if the give GValue contains a LIST value.
</para>
+@x: the #GValue to check
-<!-- ##### MACRO GST_VALUE_GREATER_THAN ##### -->
+<!-- ##### MACRO GST_TYPE_LIST ##### -->
<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 ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_ARRAY ##### -->
<para>
-Indicates that the comparison function (gst_value_compare()) can not
-determine a order for the two provided values.
+
</para>
+@x:
-<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
+<!-- ##### MACRO GST_TYPE_ARRAY ##### -->
<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 ##### -->
+<!-- ##### FUNCTION gst_value_list_append_value ##### -->
<para>
</para>
-@value1:
-@Returns:
+@value:
+@append_value:
-<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
<para>
</para>
-@dest:
-@s:
-@Returns:
+@value:
+@prepend_value:
-<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_concat ##### -->
<para>
</para>
@@ -208,68 +212,62 @@ GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
@dest:
@value1:
@value2:
-@Returns:
-<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_get_size ##### -->
<para>
</para>
-@dest:
-@value1:
-@value2:
+@value:
@Returns:
-<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
+<!-- ##### FUNCTION gst_value_list_get_value ##### -->
<para>
</para>
-@dest:
-@minuend:
-@subtrahend:
+@value:
+@index:
@Returns:
-<!-- ##### STRUCT GstValueTable ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_FRACTION ##### -->
<para>
-
+Checks if the give GValue contains a FRACTION value.
</para>
-@type:
-@compare:
-@serialize:
-@deserialize:
+@x: the #GValue to check
-<!-- ##### FUNCTION gst_value_is_fixed ##### -->
+
+<!-- ##### MACRO GST_TYPE_FRACTION ##### -->
<para>
</para>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_register ##### -->
+<!-- ##### FUNCTION gst_value_set_fraction ##### -->
<para>
</para>
-@table:
+@value:
+@numerator:
+@denominator:
-<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
+<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
<para>
</para>
-@dest:
-@src:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_serialize ##### -->
+<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
<para>
</para>
@@ -278,219 +276,234 @@ GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
@Returns:
-<!-- ##### FUNCTION gst_value_deserialize ##### -->
+<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
<para>
</para>
-@dest:
-@src:
+@product:
+@factor1:
+@factor2:
@Returns:
-<!-- ##### FUNCTION gst_value_list_append_value ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<para>
-
+Checks if the give GValue contains a CAPS value.
</para>
-@value:
-@append_value:
+@x: the #GValue to check
-<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
+<!-- ##### FUNCTION gst_value_set_caps ##### -->
<para>
</para>
@value:
-@prepend_value:
+@caps:
+<!-- # Unused Parameters # -->
+@calue:
-<!-- ##### FUNCTION gst_value_list_concat ##### -->
+<!-- ##### FUNCTION gst_value_get_caps ##### -->
<para>
</para>
-@dest:
-@value1:
-@value2:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_list_get_size ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_MINI_OBJECT ##### -->
<para>
</para>
@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_list_get_value ##### -->
+<!-- ##### MACRO GST_VALUE_HOLDS_BUFFER ##### -->
<para>
</para>
-@value:
-@index:
-@Returns:
+@x:
-<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
+<!-- ##### MACRO gst_value_get_buffer ##### -->
<para>
</para>
-@value:
-@fourcc:
+@v:
-<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
+<!-- ##### MACRO gst_value_set_buffer ##### -->
<para>
</para>
-@value:
-@Returns:
+@v:
+@b:
-<!-- ##### FUNCTION gst_value_set_int_range ##### -->
+<!-- ##### MACRO gst_value_take_buffer ##### -->
<para>
</para>
-@value:
-@start:
-@end:
+@v:
+@b:
-<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
+<!-- ##### 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>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
+<!-- ##### 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>
-@value:
-@Returns:
-<!-- ##### FUNCTION gst_value_set_double_range ##### -->
+<!-- ##### USER_FUNCTION GstValueCompareFunc ##### -->
<para>
</para>
-@value:
-@start:
-@end:
+@value1:
+@value2:
+@Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL,
+GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED
-<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
+<!-- ##### USER_FUNCTION GstValueSerializeFunc ##### -->
<para>
</para>
-@value:
+@value1:
@Returns:
-<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
+<!-- ##### USER_FUNCTION GstValueDeserializeFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@s:
@Returns:
-<!-- ##### FUNCTION gst_value_get_caps ##### -->
+<!-- ##### USER_FUNCTION GstValueUnionFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@value1:
+@value2:
@Returns:
-<!-- ##### FUNCTION gst_value_set_caps ##### -->
+<!-- ##### USER_FUNCTION GstValueIntersectFunc ##### -->
<para>
</para>
-@value:
-@caps:
-<!-- # Unused Parameters # -->
-@calue:
+@dest:
+@value1:
+@value2:
+@Returns:
-<!-- ##### FUNCTION gst_value_get_fraction_numerator ##### -->
+<!-- ##### USER_FUNCTION GstValueSubtractFunc ##### -->
<para>
</para>
-@value:
+@dest:
+@minuend:
+@subtrahend:
@Returns:
-<!-- ##### FUNCTION gst_value_get_fraction_denominator ##### -->
+<!-- ##### STRUCT GstValueTable ##### -->
<para>
</para>
-@value:
-@Returns:
-
+@type:
+@compare:
+@serialize:
+@deserialize:
-<!-- ##### FUNCTION gst_value_set_fraction ##### -->
+<!-- ##### FUNCTION gst_value_is_fixed ##### -->
<para>
</para>
@value:
-@numerator:
-@denominator:
+@Returns:
-<!-- ##### MACRO gst_value_get_buffer ##### -->
+<!-- ##### FUNCTION gst_value_register ##### -->
<para>
</para>
-@v:
+@table:
-<!-- ##### MACRO gst_value_set_buffer ##### -->
+<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
<para>
</para>
-@v:
-@b:
+@dest:
+@src:
-<!-- ##### MACRO gst_value_take_buffer ##### -->
+<!-- ##### FUNCTION gst_value_serialize ##### -->
<para>
</para>
-@v:
-@b:
+@value:
+@Returns:
-<!-- ##### FUNCTION gst_value_fraction_multiply ##### -->
+<!-- ##### FUNCTION gst_value_deserialize ##### -->
<para>
</para>
-@product:
-@factor1:
-@factor2:
+@dest:
+@src:
@Returns: