API docs updates.
authorWim Taymans <wim.taymans@gmail.com>
Tue, 1 Jan 2002 15:59:05 +0000 (15:59 +0000)
committerWim Taymans <wim.taymans@gmail.com>
Tue, 1 Jan 2002 15:59:05 +0000 (15:59 +0000)
Original commit message from CVS:
API docs updates.

docs/gst/gstreamer-sections.txt
docs/gst/tmpl/gstbin.sgml
docs/gst/tmpl/gstbuffer.sgml
docs/gst/tmpl/gstelement.sgml
docs/gst/tmpl/gstevent.sgml
docs/gst/tmpl/gstidentity.sgml
docs/gst/tmpl/gstscheduler.sgml
docs/gst/tmpl/gstschedulerfactory.sgml
docs/gst/tmpl/gstutils.sgml

index c37446f..e04aa8c 100644 (file)
@@ -24,6 +24,7 @@ G_TYPE_UCHAR
 G_TYPE_BOOLEAN
 G_TYPE_INT
 G_TYPE_UINT
+G_TYPE_INT64
 G_TYPE_LONG
 G_TYPE_ULONG
 G_TYPE_ENUM
@@ -297,6 +298,8 @@ GST_DISABLE_LOADSAVE_REGISTRY
 <TITLE>GstScheduler</TITLE>
 GST_SCHEDULER_PARENT
 GST_SCHEDULER_STATE
+GstSchedulerState
+gst_scheduler_destroy
 gst_scheduler_setup
 gst_scheduler_reset
 gst_scheduler_add_element
@@ -332,6 +335,8 @@ gst_schedulerfactory_find
 gst_schedulerfactory_get_list
 gst_schedulerfactory_make
 gst_schedulerfactory_new
+gst_schedulerfactory_get_default_name
+gst_schedulerfactory_set_default_name
 <SUBSECTION Standard>
 gst_schedulerfactory_get_type
 GST_IS_SCHEDULERFACTORY
@@ -358,6 +363,8 @@ gst_bin_get_by_name_recurse_up
 gst_bin_get_list
 gst_bin_set_state_type
 gst_bin_iterate
+gst_bin_child_state_change
+gst_bin_child_error
 <SUBSECTION Standard>
 GstBinClass
 gst_bin_get_type
@@ -434,7 +441,7 @@ gst_buffer_destroy
 gst_buffer_is_span_fast
 gst_buffer_merge
 gst_buffer_span
-
+gst_buffer_print_stats
 <SUBSECTION Standard>
 GST_TYPE_BUFFER
 </SECTION>
@@ -468,16 +475,19 @@ GST_BUFFER_POOL
 <TITLE>GstEvent</TITLE>
 GstEventType
 GST_EVENT_TYPE
+GST_EVENT_SRC
 GST_EVENT_TIMESTAMP
 GstSeekType
 GST_EVENT_SEEK_TYPE
 GST_EVENT_SEEK_OFFSET
 GST_EVENT_SEEK_FLUSH
+GST_EVENT_INFO_PROPS
 GstEvent
 gst_event_new
 gst_event_free
 gst_event_new_seek
 gst_event_new_flush
+gst_event_new_info
 <SUBSECTION Standard>
 GST_EVENT
 GST_IS_EVENT
@@ -536,10 +546,15 @@ gst_element_set_state
 gst_element_get_state
 gst_element_wait_state_change
 gst_element_statename
+gst_element_info
 gst_element_error
 gst_element_get_factory
 gst_element_set_eos
 gst_element_restore_thyself
+gst_element_install_std_props
+gst_element_send_event
+gst_element_interrupt
+gst_element_yield
 <SUBSECTION Standard>
 GstElementClass
 GST_TYPE_ELEMENT
@@ -1082,7 +1097,9 @@ gst_util_get_float_arg
 gst_util_get_double_arg
 gst_util_get_string_arg
 gst_util_get_pointer_arg
+gst_util_get_int64_arg
 gst_util_dump_mem
+gst_util_has_arg
 gst_print_element_args
 gst_print_pad_caps
 <SUBSECTION Standard>
@@ -1189,6 +1206,7 @@ GST_IS_AGGREGATOR_CLASS
 <FILE>gstfilesrc</FILE>
 <TITLE>GstFileSrc</TITLE>
 <SUBSECTION Standard>
+GstFileSrcFlags
 GstFileSrc
 GstFileSrcClass
 gst_filesrc_get_type
index 1f6e0f5..457df14 100644 (file)
@@ -145,6 +145,26 @@ Free the memory allocated by this bin
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_bin_child_state_change ##### -->
+<para>
+
+</para>
+
+@bin: 
+@oldstate: 
+@newstate: 
+@child: 
+
+
+<!-- ##### FUNCTION gst_bin_child_error ##### -->
+<para>
+
+</para>
+
+@bin: 
+@child: 
+
+
 <!-- ##### SIGNAL GstBin::object-added ##### -->
 <para>
 is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
index 2405f1d..3669daa 100644 (file)
@@ -392,3 +392,10 @@ The function called when the buffer data has to be freed
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_buffer_print_stats ##### -->
+<para>
+
+</para>
+
+
+
index 17e7696..c062ffe 100644 (file)
@@ -468,6 +468,16 @@ instead.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_element_info ##### -->
+<para>
+
+</para>
+
+@element: 
+@info: 
+@Varargs: 
+
+
 <!-- ##### FUNCTION gst_element_error ##### -->
 <para>
 
@@ -505,6 +515,42 @@ instead.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_element_install_std_props ##### -->
+<para>
+
+</para>
+
+@klass: 
+@first_name: 
+@Varargs: 
+
+
+<!-- ##### FUNCTION gst_element_send_event ##### -->
+<para>
+
+</para>
+
+@element: 
+@event: 
+
+
+<!-- ##### FUNCTION gst_element_interrupt ##### -->
+<para>
+
+</para>
+
+@element: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_element_yield ##### -->
+<para>
+
+</para>
+
+@element: 
+
+
 <!-- ##### SIGNAL GstElement::state-change ##### -->
 <para>
 Is trigered whenever the state of an element changes
index 2c417b2..c58ca09 100644 (file)
@@ -38,8 +38,8 @@ The different major types of events.
 @GST_EVENT_EMPTY: an empty event.
 @GST_EVENT_SEEK: a seek event.
 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
-@GST_EVENT_INFO: 
-@GST_EVENT_ERROR: 
+@GST_EVENT_INFO: an informational event
+@GST_EVENT_ERROR: an error event
 
 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
 <para>
@@ -49,6 +49,14 @@ Get the event type.
 @event: The event to query.
 
 
+<!-- ##### MACRO GST_EVENT_SRC ##### -->
+<para>
+The source object that generated this event
+</para>
+
+@event: The event to query
+
+
 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
 <para>
 Get the timestamp of the event.
@@ -90,6 +98,14 @@ Qeury wether the seek event also needs a flush.
 @event: The event to query.
 
 
+<!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
+<para>
+The properties of the info event
+</para>
+
+@event: The event to query
+
+
 <!-- ##### STRUCT GstEvent ##### -->
 <para>
 The event data structure.
@@ -135,3 +151,13 @@ Create a new flush event.
 
 
 
+<!-- ##### FUNCTION gst_event_new_info ##### -->
+<para>
+
+</para>
+
+@firstname: 
+@Varargs: 
+@Returns: 
+
+
index 01946e1..defd51e 100644 (file)
@@ -42,6 +42,11 @@ Pass data without modification.
 
 </para>
 
+<!-- ##### ARG GstIdentity:drop-probability ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GstIdentity:silent ##### -->
 <para>
 
index 962d8ea..006a7d9 100644 (file)
@@ -30,6 +30,24 @@ Get the state of the scheduler.
 @sched: the scheduler to get the state of.
 
 
+<!-- ##### ENUM GstSchedulerState ##### -->
+<para>
+
+</para>
+
+@GST_SCHEDULER_STATE_NONE: 
+@GST_SCHEDULER_STATE_RUNNING: 
+@GST_SCHEDULER_STATE_STOPPED: 
+@GST_SCHEDULER_STATE_ERROR: 
+
+<!-- ##### MACRO gst_scheduler_destroy ##### -->
+<para>
+Destroy the scheduler
+</para>
+
+@sched: The scheduler to destroy.
+
+
 <!-- ##### FUNCTION gst_scheduler_setup ##### -->
 <para>
 
index 7a02fb8..17376bf 100644 (file)
@@ -87,3 +87,19 @@ Use gst_schedulerfactory_destroy() to remove the factory from the global list.
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_schedulerfactory_get_default_name ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_schedulerfactory_set_default_name ##### -->
+<para>
+
+</para>
+
+@name: 
+
+
index ab95593..c359b52 100644 (file)
@@ -94,6 +94,16 @@ Some convenience functions
 @Returns: 
 
 
+<!-- ##### FUNCTION gst_util_get_int64_arg ##### -->
+<para>
+
+</para>
+
+@object: 
+@argname: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_util_dump_mem ##### -->
 <para>
 
@@ -103,6 +113,17 @@ Some convenience functions
 @size: 
 
 
+<!-- ##### FUNCTION gst_util_has_arg ##### -->
+<para>
+
+</para>
+
+@object: 
+@argname: 
+@arg_type: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gst_print_element_args ##### -->
 <para>