mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-16 19:25:18 +00:00
Code Issues 1 Projects Releases Wiki Activity

make sure all API gets built sync .c with .h

Browse source 
Original commit message from CVS:
make sure all API gets built
sync .c with .h
This commit is contained in:
Thomas Vander Stichele 2004-01-30 19:06:13 +00:00
parent e1c557047f
commit cdda2aa934
16 changed files with 1954 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
ChangeLog
View file

@ -1,3 +1,24 @@
2004-01-30 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/README:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gsterror.sgml:
* docs/gst/tmpl/gstinterface.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gststructure.sgml:
* docs/gst/tmpl/gsttag.sgml:
* docs/gst/tmpl/gsttaginterface.sgml:
* docs/gst/tmpl/gstvalue.sgml:
make sure all API ends up in the built docs
* gst/gstinterface.c:
* gst/gststructure.c: (gst_structure_id_set_value),
(gst_structure_set_value), (gst_structure_id_get_value):
* gst/gststructure.h:
* gst/gstvalue.h:
sync .h with .c declarations
2004-01-30 Julien Moutte <julien@moutte.net>
* libs/gst/bytestream/bytestream.c: Reverting my event handling patch.

4
docs/README
View file

@ -96,6 +96,10 @@ GTK-DOC NOTES
- tmpl/
(FIXME: describe what each of these files do)
* what to do when adding a new piece of API:
- add both an entity and use the entity in gstreamer-docs.sgml
- add a new section to gstreamer-sections.txt
- add all documented symbols to gstreamer-sections.txt in the proper section
* checklist:
- make sure -sections.txt has a <TITLE> set for each <FILE>

37
docs/gst/gstreamer-docs.sgml
View file

@ -4,42 +4,50 @@
<!ENTITY Gst SYSTEM "xml/gst.xml">
<!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstBufferPool SYSTEM "xml/gstbuffer.xml">
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
<!ENTITY GstInterface SYSTEM "xml/gstinterface.xml">
<!ENTITY GstLog SYSTEM "xml/gstlog.xml">
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml">
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
<!-- not commented properly yet
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
-->
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
-->
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
<!ENTITY cothreads SYSTEM "xml/cothreads.xml">
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
@ -81,10 +89,13 @@ with some more specialized elements.</para>
&GstCpu;
&GstData;
&GstElement;
&GstElementFactory;
&GstError;
&GstEvent;
&GstFormat;
&GstIndex;
&GstInfo;
&GstInterface;
&GstObject;
&GstPad;
&GstParse;
@ -98,12 +109,18 @@ with some more specialized elements.</para>
&GstRegistry;
&GstRegistryPool;
&GstScheduler;
&GstStructure;
&GstSystemClock;
&GstTag;
&GstTagInterface;
&GstThread;
&GstTypeFind;
&GstTypeFindFactory;
&GstUri;
&GstUtils;
<!-- not commented properly yet
&GstValue;
-->
&GstXML;
</chapter>

131
docs/gst/gstreamer-sections.txt
View file

@ -543,6 +543,137 @@ GST_ELEMENT_FACTORY_CLASS
GST_IS_ELEMENT_FACTORY_CLASS
</SECTION>
<SECTION>
<FILE>gsterror</FILE>
<TITLE>GstError</TITLE>
GstCoreError
</SECTION>
<SECTION>
<FILE>gstinterface</FILE>
<TITLE>GstInterface</TITLE>
gst_element_implements_interface
gst_implements_interface_cast
gst_implements_interface_check
</SECTION>
<SECTION>
<FILE>gststructure</FILE>
<TITLE>GstStructure</TITLE>
gst_structure_empty_new
gst_structure_id_empty_new
gst_structure_new
gst_structure_new_valist
gst_structure_copy
gst_structure_free
gst_structure_get_name
gst_structure_set_name
gst_structure_id_set_value
gst_structure_set_value
gst_structure_set
gst_structure_set_valist
gst_structure_id_get_value
gst_structure_get_value
gst_structure_remove_field
gst_structure_remove_fields
gst_structure_remove_fields_valist
gst_structure_remove_all_fields
gst_structure_get_field_type
gst_structure_foreach
gst_structure_n_fields
gst_structure_has_field
gst_structure_has_field_typed
gst_structure_get_boolean
gst_structure_get_int
gst_structure_get_fourcc
gst_structure_get_double
gst_structure_get_string
gst_structure_to_string
gst_structure_from_string
</SECTION>
<SECTION>
<FILE>gsttag</FILE>
<TITLE>GstTag</TITLE>
GstTagMergeMode
GstTagFlag
gst_tag_register
gst_tag_merge_use_first
gst_tag_merge_strings_with_comma
gst_tag_initialize
gst_tag_register
gst_tag_merge_use_first
gst_tag_merge_strings_with_comma
gst_tag_exists
gst_tag_get_type
gst_tag_get_nick
gst_tag_get_description
gst_tag_is_fixed
gst_tag_list_new
gst_tag_list_copy
gst_tag_list_insert
gst_tag_list_merge
gst_tag_list_free
gst_tag_list_get_tag_size
gst_tag_list_add
gst_tag_list_add_values
gst_tag_list_add_valist
gst_tag_list_add_valist_values
gst_tag_list_remove_tag
gst_tag_list_foreach
gst_tag_list_get_value_index
gst_tag_list_copy_value
gst_tag_list_get_char
gst_tag_list_get_char_index
gst_tag_list_get_uchar
gst_tag_list_get_uchar_index
gst_tag_list_get_boolean
gst_tag_list_get_boolean_index
gst_tag_list_get_int
gst_tag_list_get_int_index
gst_tag_list_get_uint
gst_tag_list_get_uint_index
gst_tag_list_get_long
gst_tag_list_get_long_index
gst_tag_list_get_ulong
gst_tag_list_get_ulong_index
gst_tag_list_get_int64
gst_tag_list_get_int64_index
gst_tag_list_get_uint64
gst_tag_list_get_uint64_index
gst_tag_list_get_float
gst_tag_list_get_float_index
gst_tag_list_get_double
gst_tag_list_get_double_index
gst_tag_list_get_string
gst_tag_list_get_string_index
gst_tag_list_get_pointer
gst_tag_list_get_pointer_index
</SECTION>
<SECTION>
<FILE>gsttaginterface</FILE>
<TITLE>GstTagInterface</TITLE>
gst_tag_setter_get_type
gst_tag_setter_merge
gst_tag_setter_add
gst_tag_setter_add_values
gst_tag_setter_add_valist
gst_tag_setter_add_valist_values
gst_tag_setter_get_list
gst_tag_setter_set_merge_mode
gst_tag_setter_get_merge_mode
</SECTION>
<SECTION>
<FILE>gstclock</FILE>

6
docs/gst/tmpl/gstelement.sgml
View file

@ -982,6 +982,12 @@ Is triggered whenever an error occured.
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
<!-- ##### SIGNAL GstElement::found-tag ##### -->

35
docs/gst/tmpl/gsterror.sgml Normal file
View file

@ -0,0 +1,35 @@
<!-- ##### SECTION Title ##### -->
GstError
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstCoreError ##### -->
<para>
</para>
@GST_CORE_ERROR_FAILED:
@GST_CORE_ERROR_TOO_LAZY:
@GST_CORE_ERROR_NOT_IMPLEMENTED:
@GST_CORE_ERROR_STATE_CHANGE:
@GST_CORE_ERROR_PAD:
@GST_CORE_ERROR_THREAD:
@GST_CORE_ERROR_SCHEDULER:
@GST_CORE_ERROR_NEGOTIATION:
@GST_CORE_ERROR_EVENT:
@GST_CORE_ERROR_SEEK:
@GST_CORE_ERROR_CAPS:
@GST_CORE_ERROR_TAG:
@GST_CORE_ERROR_NUM_ERRORS:

46
docs/gst/tmpl/gstinterface.sgml Normal file
View file

@ -0,0 +1,46 @@
<!-- ##### SECTION Title ##### -->
GstInterface
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_implements_interface ##### -->
<para>
</para>
@element:
@iface_type:
@Returns:
<!-- ##### FUNCTION gst_implements_interface_cast ##### -->
<para>
</para>
@from:
@type:
@Returns:
<!-- ##### FUNCTION gst_implements_interface_check ##### -->
<para>
</para>
@from:
@type:
@Returns:

286
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -1254,6 +1254,26 @@ GstTimeCache
gsttypes
<!-- ##### SECTION ./tmpl/gstvalue.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstvalue.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstvalue.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstvalue.sgml:Title ##### -->
GstValue
<!-- ##### SECTION ./tmpl/gstversion.sgml:Long_Description ##### -->
<para>
@ -3873,6 +3893,41 @@ A type that can be used to indicate a filename.
</para>
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GType ##### -->
<para>
@ -10680,6 +10735,237 @@ Destroy the scheduler
@arg_type:
@Returns:
<!-- ##### FUNCTION gst_value_can_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_union ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_deserialize ##### -->
<para>
</para>
@dest:
@src:
@Returns:
<!-- ##### FUNCTION gst_value_get_caps ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_double_range_max ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_double_range_min ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_fourcc ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_int_range_max ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_get_int_range_min ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_init_and_copy ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### FUNCTION gst_value_intersect ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_list_append_value ##### -->
<para>
</para>
@value:
@append_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_list_prepend_value ##### -->
<para>
</para>
@value:
@prepend_value:
<!-- ##### FUNCTION gst_value_register ##### -->
<para>
</para>
@table:
<!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
<para>
</para>
@type1:
@type2:
@func:
<!-- ##### FUNCTION gst_value_register_union_func ##### -->
<para>
</para>
@type1:
@type2:
@func:
<!-- ##### FUNCTION gst_value_serialize ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_set_caps ##### -->
<para>
</para>
@value:
@caps:
@calue:
<!-- ##### FUNCTION gst_value_set_double_range ##### -->
<para>
</para>
@value:
@start:
@end:
<!-- ##### FUNCTION gst_value_set_fourcc ##### -->
<para>
</para>
@value:
@fourcc:
<!-- ##### FUNCTION gst_value_set_int_range ##### -->
<para>
</para>
@value:
@start:
@end:
<!-- ##### FUNCTION gst_value_union ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_xml_new_from_memory ##### -->
<para>

343
docs/gst/tmpl/gststructure.sgml Normal file
View file

@ -0,0 +1,343 @@
<!-- ##### SECTION Title ##### -->
GstStructure
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_structure_empty_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_structure_id_empty_new ##### -->
<para>
</para>
@quark:
@Returns:
<!-- ##### FUNCTION gst_structure_new ##### -->
<para>
</para>
@name:
@firstfield:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_structure_new_valist ##### -->
<para>
</para>
@name:
@firstfield:
@varargs:
@Returns:
<!-- ##### FUNCTION gst_structure_copy ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_free ##### -->
<para>
</para>
@structure:
<!-- ##### FUNCTION gst_structure_get_name ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_set_name ##### -->
<para>
</para>
@structure:
@name:
<!-- ##### FUNCTION gst_structure_id_set_value ##### -->
<para>
</para>
@structure:
@field:
@value:
<!-- ##### FUNCTION gst_structure_set_value ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_set ##### -->
<para>
</para>
@structure:
@fieldname:
@Varargs:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_set_valist ##### -->
<para>
</para>
@structure:
@fieldname:
@varargs:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_id_get_value ##### -->
<para>
</para>
@structure:
@field:
@Returns:
<!-- ##### FUNCTION gst_structure_get_value ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_remove_field ##### -->
<para>
</para>
@structure:
@fieldname:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_remove_fields ##### -->
<para>
</para>
@structure:
@fieldname:
@Varargs:
<!-- # Unused Parameters # -->
@fieldnamename:
<!-- ##### FUNCTION gst_structure_remove_fields_valist ##### -->
<para>
</para>
@structure:
@fieldname:
@varargs:
<!-- # Unused Parameters # -->
@fieldnamename:
<!-- ##### FUNCTION gst_structure_remove_all_fields ##### -->
<para>
</para>
@structure:
<!-- ##### FUNCTION gst_structure_get_field_type ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_foreach ##### -->
<para>
</para>
@structure:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_structure_n_fields ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_has_field ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_has_field_typed ##### -->
<para>
</para>
@structure:
@fieldname:
@type:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_boolean ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_int ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_fourcc ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_get_double ##### -->
<para>
</para>
@structure:
@fieldname:
@value:
@Returns:
<!-- # Unused Parameters # -->
@fieldnamename:
@field:
<!-- ##### FUNCTION gst_structure_get_string ##### -->
<para>
</para>
@structure:
@fieldname:
@Returns:
<!-- # Unused Parameters # -->
@field:
<!-- ##### FUNCTION gst_structure_to_string ##### -->
<para>
</para>
@structure:
@Returns:
<!-- ##### FUNCTION gst_structure_from_string ##### -->
<para>
</para>
@string:
@end:
@Returns:

588
docs/gst/tmpl/gsttag.sgml Normal file
View file

@ -0,0 +1,588 @@
<!-- ##### SECTION Title ##### -->
GstTag
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstTagMergeMode ##### -->
<para>
</para>
@GST_TAG_MERGE_UNDEFINED:
@GST_TAG_MERGE_REPLACE_ALL:
@GST_TAG_MERGE_REPLACE:
@GST_TAG_MERGE_APPEND:
@GST_TAG_MERGE_PREPEND:
@GST_TAG_MERGE_KEEP:
@GST_TAG_MERGE_KEEP_ALL:
@GST_TAG_MERGE_COUNT:
<!-- ##### ENUM GstTagFlag ##### -->
<para>
</para>
@GST_TAG_FLAG_UNDEFINED:
@GST_TAG_FLAG_META:
@GST_TAG_FLAG_ENCODED:
@GST_TAG_FLAG_DECODED:
@GST_TAG_FLAG_COUNT:
<!-- ##### FUNCTION gst_tag_register ##### -->
<para>
</para>
@name:
@flag:
@type:
@nick:
@blurb:
@func:
<!-- ##### FUNCTION gst_tag_merge_use_first ##### -->
<para>
</para>
@dest:
@values:
<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
<para>
</para>
@dest:
@values:
<!-- ##### FUNCTION gst_tag_register ##### -->
<para>
</para>
@name:
@flag:
@type:
@nick:
@blurb:
@func:
<!-- ##### FUNCTION gst_tag_merge_use_first ##### -->
<para>
</para>
@dest:
@values:
<!-- ##### FUNCTION gst_tag_merge_strings_with_comma ##### -->
<para>
</para>
@dest:
@values:
<!-- ##### FUNCTION gst_tag_exists ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_type ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_nick ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_get_description ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_is_fixed ##### -->
<para>
</para>
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_tag_list_copy ##### -->
<para>
</para>
@list:
@Returns:
<!-- ##### FUNCTION gst_tag_list_insert ##### -->
<para>
</para>
@into:
@from:
@mode:
<!-- ##### FUNCTION gst_tag_list_merge ##### -->
<para>
</para>
@list1:
@list2:
@mode:
@Returns:
<!-- ##### FUNCTION gst_tag_list_free ##### -->
<para>
</para>
@list:
<!-- ##### FUNCTION gst_tag_list_get_tag_size ##### -->
<para>
</para>
@list:
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_add ##### -->
<para>
</para>
@list:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_list_add_values ##### -->
<para>
</para>
@list:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_list_add_valist ##### -->
<para>
</para>
@list:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_list_add_valist_values ##### -->
<para>
</para>
@list:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_list_remove_tag ##### -->
<para>
</para>
@list:
@tag:
<!-- ##### FUNCTION gst_tag_list_foreach ##### -->
<para>
</para>
@list:
@func:
@user_data:
<!-- ##### FUNCTION gst_tag_list_get_value_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@Returns:
<!-- ##### FUNCTION gst_tag_list_copy_value ##### -->
<para>
</para>
@dest:
@list:
@tag:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_char ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_char_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uchar ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uchar_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_boolean ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_boolean_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_long ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_long_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_ulong ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_ulong_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int64 ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_int64_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint64 ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_uint64_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_float ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_float_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_double ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_double_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_string ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_string_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_pointer ##### -->
<para>
</para>
@list:
@tag:
@value:
@Returns:
<!-- ##### FUNCTION gst_tag_list_get_pointer_index ##### -->
<para>
</para>
@list:
@tag:
@index:
@value:
@Returns:

105
docs/gst/tmpl/gsttaginterface.sgml Normal file
View file

@ -0,0 +1,105 @@
<!-- ##### SECTION Title ##### -->
GstTagInterface
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_tag_setter_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_tag_setter_merge ##### -->
<para>
</para>
@setter:
@list:
@mode:
<!-- ##### FUNCTION gst_tag_setter_add ##### -->
<para>
</para>
@setter:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_setter_add_values ##### -->
<para>
</para>
@setter:
@mode:
@tag:
@Varargs:
<!-- ##### FUNCTION gst_tag_setter_add_valist ##### -->
<para>
</para>
@setter:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_setter_add_valist_values ##### -->
<para>
</para>
@setter:
@mode:
@tag:
@var_args:
<!-- ##### FUNCTION gst_tag_setter_get_list ##### -->
<para>
</para>
@setter:
@Returns:
<!-- ##### FUNCTION gst_tag_setter_set_merge_mode ##### -->
<para>
</para>
@setter:
@mode:
<!-- ##### FUNCTION gst_tag_setter_get_merge_mode ##### -->
<para>
</para>
@setter:
@Returns:

315
docs/gst/tmpl/gstvalue.sgml Normal file
View file

@ -0,0 +1,315 @@
<!-- ##### SECTION Title ##### -->
GstValue
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_value_list_prepend_value ##### -->
<para>
</para>
@value:
@prepend_value:
<!-- ##### FUNCTION gst_value_list_append_value ##### -->
<para>
</para>
@value:
@append_value:
<!-- ##### FUNCTION gst_value_list_get_size ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION gst_value_list_get_value ##### -->
<para>
</para>
@value:
@index:
@Returns:
<!-- ##### FUNCTION gst_value_list_concat ##### -->
<para>
</para>
@dest:
@value1:
@value2:
<!-- ##### 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_can_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_compare ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_can_union ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_union ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_register_union_func ##### -->
<para>
</para>
@type1:
@type2:
@func:
<!-- ##### FUNCTION gst_value_can_intersect ##### -->
<para>
</para>
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_intersect ##### -->
<para>
</para>
@dest:
@value1:
@value2:
@Returns:
<!-- ##### FUNCTION gst_value_register_intersect_func ##### -->
<para>
</para>
@type1:
@type2:
@func:
<!-- ##### 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:
<!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_INT_RANGE ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_DOUBLE_RANGE ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_LIST ##### -->
<para>
</para>
@x:
<!-- ##### MACRO GST_VALUE_HOLDS_CAPS ##### -->
<para>
</para>
@x:

8
gst/gstinterface.c
View file

@ -87,6 +87,8 @@ gst_implements_interface_supported_default (GstImplementsInterface *interface,
*
* Test whether the given element implements a certain interface of type
* iface_type, and test whether it is supported for this specific instance.
*
* Returns: whether or not the element implements the interface.
*/
gboolean
@ -118,6 +120,8 @@ gst_element_implements_interface (GstElement *element,
*
* cast a given object to an interface type, and check whether this
* interface is supported for this specific instance.
*
* Returns: a gpointer to the interface type
*/
gpointer
@ -144,12 +148,14 @@ gst_implements_interface_cast (gpointer from,
}
/**
* gst_implements_interface_cast:
* gst_implements_interface_check:
* @from: the object (any sort) from which to check from for the interface
* @type: the interface type to check for
*
* check a given object for an interface implementation, and check
* whether this interface is supported for this specific instance.
*
* Returns: whether or not the object implements the given interface
*/
gboolean

49
gst/gststructure.c
View file

@ -44,7 +44,7 @@ static void gst_structure_set_field (GstStructure *structure,
static GstStructureField *gst_structure_get_field(const GstStructure *structure,
const gchar *fieldname);
static GstStructureField *gst_structure_id_get_field(const GstStructure *structure,
GQuark fieldname);
GQuark field);
static void _gst_structure_transform_to_string(const GValue *src_value,
GValue *dest_value);
@ -99,7 +99,7 @@ void _gst_structure_initialize(void)
/**
* gst_structure_id_empty_new:
* @name: name of new structure
* @quark: name of new structure
*
* Creates a new, empty #GstStructure with the given name.
*
@ -173,7 +173,7 @@ GstStructure *gst_structure_new(const gchar *name,
* gst_structure_new_valist:
* @name: name of new structure
* @firstfield: name of first field to set
* @varags: variable argument list
* @varargs: variable argument list
*
* Creates a new #GstStructure with the given name. Structure fields
* are set according to the varargs in a manner similar to
@ -288,14 +288,14 @@ void gst_structure_set_name(GstStructure *structure, const gchar *name)
/**
* gst_structure_id_set_value:
* @structure: a #GstStructure
* @field_id: a #GQuark representing a field
* @field: a #GQuark representing a field
* @value: the new value of the field
*
* Sets the field with the given ID to the provided value. If the field
* does not exist, it is created. If the field exists, the previous
* value is freed.
*/
void gst_structure_id_set_value(GstStructure *structure, GQuark fieldname,
void gst_structure_id_set_value(GstStructure *structure, GQuark field,
const GValue *value)
{
GstStructureField field = { 0, { 0, } };
@ -312,14 +312,14 @@ void gst_structure_id_set_value(GstStructure *structure, GQuark fieldname,
/**
* gst_structure_set_value:
* @structure: a #GstStructure
* @field: the name of the field to set
* @fieldname: the name of the field to set
* @value: the new value of the field
*
* Sets the field with the given name to the provided value. If the field
* does not exist, it is created. If the field exists, the previous
* value is freed.
*/
void gst_structure_set_value(GstStructure *structure, const gchar *field,
void gst_structure_set_value(GstStructure *structure, const gchar *fieldname,
const GValue *value)
{
g_return_if_fail(structure != NULL);
@ -332,7 +332,7 @@ void gst_structure_set_value(GstStructure *structure, const gchar *field,
/**
* gst_structure_set:
* @structure: a #GstStructure
* @field: the name of the field to set
* @fieldname: the name of the field to set
* @...: variable arguments
*
* Parses the variable arguments and sets fields accordingly.
@ -355,7 +355,7 @@ void gst_structure_set(GstStructure *structure, const gchar *field, ...)
/**
* gst_structure_set_valist:
* @structure: a #GstStructure
* @field: the name of the field to set
* @fieldname: the name of the field to set
* @varargs: variable arguments
*
* va_list form of #gst_structure_set.
@ -459,7 +459,7 @@ static void gst_structure_set_field(GstStructure *structure, GstStructureField *
g_array_append_val(structure->fields, *field);
}
/**
/* FIXME: is this private ? if so remove gtk-doc
* gst_structure_id_get_field:
* @structure: a #GstStructure
* @field_id: the GQuark of the field to get
@ -532,7 +532,7 @@ gst_structure_get_value(const GstStructure *structure, const gchar *fieldname)
/**
* gst_structure_id_get_value:
* @structure: a #GstStructure
* @id: the #GQuark of the field to get
* @field: the #GQuark of the field to get
*
* Accessor function.
*
@ -540,7 +540,7 @@ gst_structure_get_value(const GstStructure *structure, const gchar *fieldname)
* identifier.
*/
const GValue *
gst_structure_id_get_value(const GstStructure *structure, GQuark id)
gst_structure_id_get_value(const GstStructure *structure, GQuark field)
{
GstStructureField *field;
@ -704,6 +704,9 @@ gst_structure_n_fields(const GstStructure *structure)
* @user_data: private data
*
* Calls the provided function once for each field in the #GstStructure.
*
* Returns: TRUE if the supplied function returns TRUE For each of the fields,
* FALSE otherwise.
*/
gboolean
gst_structure_foreach (GstStructure *structure,
@ -746,7 +749,7 @@ gst_structure_has_field(const GstStructure *structure, const gchar *fieldname)
}
/**
* gst_structure_has_field:
* gst_structure_has_field_typed:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @type: the type of a value
@ -777,9 +780,9 @@ gst_structure_has_field_typed(const GstStructure *structure, const gchar *fieldn
* gst_structure_get_boolean:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @ptr: a pointer to a #gboolean to set
* @value: a pointer to a #gboolean to set
*
* Sets the boolean pointed to by @ptr corresponding to the value of the
* Sets the boolean pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
@ -808,9 +811,9 @@ gst_structure_get_boolean(const GstStructure *structure, const gchar *fieldname,
* gst_structure_get_int:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @ptr: a pointer to an int to set
* @value: a pointer to an int to set
*
* Sets the int pointed to by @ptr corresponding to the value of the
* Sets the int pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
@ -840,9 +843,9 @@ gst_structure_get_int(const GstStructure *structure, const gchar *fieldname,
* gst_structure_get_fourcc:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @ptr: a pointer to a #GstFourcc to set
* @value: a pointer to a #GstFourcc to set
*
* Sets the #GstFourcc pointed to by @ptr corresponding to the value of the
* Sets the #GstFourcc pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
@ -872,9 +875,9 @@ gst_structure_get_fourcc(const GstStructure *structure, const gchar *fieldname,
* gst_structure_get_double:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @ptr: a pointer to a #GstFourcc to set
* @value: a pointer to a #GstFourcc to set
*
* Sets the double pointed to by @ptr corresponding to the value of the
* Sets the double pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
@ -903,7 +906,6 @@ gboolean gst_structure_get_double(const GstStructure *structure,
* gst_structure_get_string:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @ptr: a pointer to a #GstFourcc to set
*
* Finds the field corresponding to @fieldname, and returns the string
* contained in the field's value. Caller is responsible for making
@ -1320,7 +1322,8 @@ _gst_structure_parse_value (gchar *str, gchar **after, GValue *value,
/**
* gst_structure_from_string:
* @structure: a #GstStructure
* @string: a string representation of a #GstStructure.
* @end: FIXME, deduce from code
*
* Creates a #GstStructure from a string representation.
*

26
gst/gststructure.h
View file

@ -57,16 +57,16 @@ void gst_structure_set_name(GstStructure *structure, const gchar *name);
void gst_structure_id_set_value(GstStructure *structure, GQuark field,
const GValue *value);
void gst_structure_set_value(GstStructure *structure, const gchar *field,
void gst_structure_set_value(GstStructure *structure, const gchar *fieldname,
const GValue *value);
void gst_structure_set(GstStructure *structure, const gchar *field, ...);
void gst_structure_set_valist(GstStructure *structure, const gchar *field,
void gst_structure_set(GstStructure *structure, const gchar *fieldname, ...);
void gst_structure_set_valist(GstStructure *structure, const gchar *fieldname,
va_list varargs);
G_CONST_RETURN GValue *gst_structure_id_get_value(const GstStructure *structure,
GQuark field);
G_CONST_RETURN GValue *gst_structure_get_value(const GstStructure *structure,
const gchar *field);
void gst_structure_remove_field(GstStructure *structure, const gchar *field);
const gchar *fieldname);
void gst_structure_remove_field(GstStructure *structure, const gchar *fieldname);
void gst_structure_remove_fields(GstStructure *structure,
const gchar *fieldname, ...);
void gst_structure_remove_fields_valist(GstStructure *structure,
@ -74,26 +74,26 @@ void gst_structure_remove_fields_valist(GstStructure *structure,
void gst_structure_remove_all_fields(GstStructure *structure);
GType gst_structure_get_field_type(const GstStructure *structure,
const gchar *field);
const gchar *fieldname);
gboolean gst_structure_foreach (GstStructure *structure,
GstStructureForeachFunc func, gpointer user_data);
gint gst_structure_n_fields(const GstStructure *structure);
gboolean gst_structure_has_field(const GstStructure *structure, const gchar *field);
gboolean gst_structure_has_field(const GstStructure *structure, const gchar *fieldname);
gboolean gst_structure_has_field_typed(const GstStructure *structure,
const gchar *field, GType type);
const gchar *fieldname, GType type);
/* utility functions */
gboolean gst_structure_get_boolean(const GstStructure *structure, const gchar *field,
gboolean gst_structure_get_boolean(const GstStructure *structure, const gchar *fieldname,
gboolean *value);
gboolean gst_structure_get_int(const GstStructure *structure, const gchar *field,
gboolean gst_structure_get_int(const GstStructure *structure, const gchar *fieldname,
gint *value);
gboolean gst_structure_get_fourcc(const GstStructure *structure, const gchar *field,
gboolean gst_structure_get_fourcc(const GstStructure *structure, const gchar *fieldname,
guint32 *value);
gboolean gst_structure_get_double(const GstStructure *structure, const gchar *field,
gboolean gst_structure_get_double(const GstStructure *structure, const gchar *fieldname,
gdouble *value);
G_CONST_RETURN gchar *gst_structure_get_string(const GstStructure *structure,
const gchar *field);
const gchar *fieldname);
gchar * gst_structure_to_string(const GstStructure *structure);
GstStructure * gst_structure_from_string (const gchar *string, gchar **end);

2
gst/gstvalue.h
View file

@ -104,7 +104,7 @@ double gst_value_get_double_range_max (const GValue *value);
/* caps */
G_CONST_RETURN GstCaps *gst_value_get_caps (const GValue *value);
void gst_value_set_caps (GValue *calue, const GstCaps *caps);
void gst_value_set_caps (GValue *value, const GstCaps *caps);
/* compare */