[gst-cvs] CVS: gstreamer/docs/gst/tmpl gstautoplug.sgml,1.6,1.7 gstbuffer.sgml,1.13,1.14 gstbufferpool.sgml,1.6,1.7 gstdisksrc.sgml,1.10,1.11 gstelement.sgml,1.24,1.25 gstfakesink.sgml,1.9,1.10 gstfakesrc.sgml,1.9,1.10 gstidentity.sgml,1.9,1.10 gstobject.sgml,1.11,1.12 gstpad.sgml,1.26,1.27 gstplugin.sgml,1.14,1.15 gstqueue.sgml,1.10,1.11 gstreamer-unused.sgml,1.45,1.46 gsttee.sgml,1.4,1.5 gstthread.sgml,1.9,1.10 gsttype.sgml,1.8,1.9
Erik Walthinsen
omegahacker at users.sourceforge.net
Wed Oct 17 03:23:03 PDT 2001
Update of /cvsroot/gstreamer/gstreamer/docs/gst/tmpl
In directory usw-pr-cvs1:/tmp/cvs-serv21419/docs/gst/tmpl
Modified Files:
gstautoplug.sgml gstbuffer.sgml gstbufferpool.sgml
gstdisksrc.sgml gstelement.sgml gstfakesink.sgml
gstfakesrc.sgml gstidentity.sgml gstobject.sgml gstpad.sgml
gstplugin.sgml gstqueue.sgml gstreamer-unused.sgml gsttee.sgml
gstthread.sgml gsttype.sgml
Log Message:
merge from EVENTS1 on 20011016
Index: gstautoplug.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstautoplug.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- gstautoplug.sgml 2001/04/17 21:14:55 1.6
+++ gstautoplug.sgml 2001/10/17 10:21:23 1.7
@@ -116,7 +116,7 @@
</para>
- at name:
+ at feature:
@longdesc:
@type:
@@ -204,25 +204,6 @@
</para>
@name:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_autoplugfactory_save_thyself ##### -->
-<para>
-
-</para>
-
- at factory:
- at parent:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_autoplugfactory_load_thyself ##### -->
-<para>
-
-</para>
-
- at parent:
@Returns:
Index: gstbuffer.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstbuffer.sgml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- gstbuffer.sgml 2001/07/07 10:55:58 1.13
+++ gstbuffer.sgml 2001/10/17 10:21:23 1.14
@@ -239,6 +239,7 @@
</para>
+ at data_type:
@lock:
@data:
@size:
@@ -265,6 +266,8 @@
</para>
@pool:
+ at location:
+ at size:
@Returns:
@@ -293,9 +296,12 @@
</para>
+ at buf:
+ at buf2:
+ at Returns:
+<!-- # Unused Parameters # -->
@buffer:
@append:
- at Returns:
<!-- ##### FUNCTION gst_buffer_ref ##### -->
Index: gstbufferpool.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstbufferpool.sgml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- gstbufferpool.sgml 2001/07/20 21:26:34 1.6
+++ gstbufferpool.sgml 2001/10/17 10:21:23 1.7
@@ -52,30 +52,10 @@
</para>
@lock:
- at new_user_data:
- at destroy_user_data:
- at destroy_buffer:
-
-<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
-<para>
-The function called when a buffer has to be created for this pool.
-</para>
-
- at pool: the pool from which to create the buffer
- at user_data: any user data
- at Returns: a new buffer from the pool
-
-
-<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
-<para>
-This function will be called when the given buffer has to be returned to
-the pool.
-</para>
-
- at pool: the pool to return the buffer to
- at buffer: the buffer to return
- at user_data: any user data
-
+ at buffer_free:
+ at buffer_copy:
+ at destroy_hook:
+ at user_data:
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
<para>
@@ -85,24 +65,6 @@
@Returns:
-<!-- ##### FUNCTION gst_buffer_pool_new_buffer ##### -->
-<para>
-
-</para>
-
- at pool:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_buffer_pool_destroy_buffer ##### -->
-<para>
-
-</para>
-
- at pool:
- at buffer:
-
-
<!-- ##### FUNCTION gst_buffer_pool_ref ##### -->
<para>
@@ -130,26 +92,6 @@
@pool:
-<!-- ##### FUNCTION gst_buffer_pool_set_create_function ##### -->
-<para>
-
-</para>
-
- at pool:
- at create:
- at user_data:
-
-
-<!-- ##### FUNCTION gst_buffer_pool_set_destroy_function ##### -->
-<para>
-
-</para>
-
- at pool:
- at destroy:
- at user_data:
-
-
<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
<para>
@@ -163,9 +105,10 @@
</para>
- at oldpool:
@buffer_size:
@pool_size:
@Returns:
+<!-- # Unused Parameters # -->
+ at oldpool:
Index: gstdisksrc.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstdisksrc.sgml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- gstdisksrc.sgml 2001/02/22 23:18:51 1.10
+++ gstdisksrc.sgml 2001/10/17 10:21:23 1.11
@@ -47,8 +47,8 @@
Get/set the current offset in the file.
</para>
-<!-- ##### ARG GstDiskSrc:size ##### -->
+<!-- ##### ARG GstDiskSrc:filesize ##### -->
<para>
-Get the size of the file.
+
</para>
Index: gstelement.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstelement.sgml,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -d -r1.24 -r1.25
--- gstelement.sgml 2001/07/07 10:55:58 1.24
+++ gstelement.sgml 2001/10/17 10:21:23 1.25
@@ -225,7 +225,7 @@
GstElementDetails struct for the element.
</para>
- at name:
+ at feature:
@type:
@details:
@padtemplates:
@@ -241,14 +241,6 @@
@element: The element in question.
-<!-- ##### FUNCTION gst_element_new ##### -->
-<para>
-
-</para>
-
- at Returns:
-
-
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
@@ -503,14 +495,6 @@
@Returns:
-<!-- ##### FUNCTION gst_elementfactory_destroy ##### -->
-<para>
-
-</para>
-
- at elementfactory:
-
-
<!-- ##### FUNCTION gst_elementfactory_add_padtemplate ##### -->
<para>
@@ -577,25 +561,6 @@
@factoryname:
@name:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_elementfactory_save_thyself ##### -->
-<para>
-
-</para>
-
- at factory:
- at parent:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_elementfactory_load_thyself ##### -->
-<para>
-
-</para>
-
- at parent:
@Returns:
Index: gstfakesink.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstfakesink.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- gstfakesink.sgml 2001/07/20 21:26:34 1.9
+++ gstfakesink.sgml 2001/10/17 10:21:23 1.10
@@ -24,7 +24,7 @@
@gstfakesink: the object which received the signal.
@arg1:
-<!-- ##### ARG GstFakeSink:num_sinks ##### -->
+<!-- ##### ARG GstFakeSink:num-sinks ##### -->
<para>
</para>
Index: gstfakesrc.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstfakesrc.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- gstfakesrc.sgml 2001/05/27 14:33:30 1.9
+++ gstfakesrc.sgml 2001/10/17 10:21:23 1.10
@@ -22,12 +22,12 @@
@gstfakesrc: the object which received the signal.
@arg1:
-<!-- ##### ARG GstFakeSrc:num_sources ##### -->
+<!-- ##### ARG GstFakeSrc:num-sources ##### -->
<para>
</para>
-<!-- ##### ARG GstFakeSrc:loop_based ##### -->
+<!-- ##### ARG GstFakeSrc:loop-based ##### -->
<para>
</para>
@@ -42,7 +42,7 @@
</para>
-<!-- ##### ARG GstFakeSrc:num_buffers ##### -->
+<!-- ##### ARG GstFakeSrc:num-buffers ##### -->
<para>
</para>
Index: gstidentity.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstidentity.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- gstidentity.sgml 2001/07/20 21:26:34 1.9
+++ gstidentity.sgml 2001/10/17 10:21:23 1.10
@@ -22,12 +22,12 @@
@gstidentity: the object which received the signal.
@arg1:
-<!-- ##### ARG GstIdentity:loop_based ##### -->
+<!-- ##### ARG GstIdentity:loop-based ##### -->
<para>
</para>
-<!-- ##### ARG GstIdentity:sleep_time ##### -->
+<!-- ##### ARG GstIdentity:sleep-time ##### -->
<para>
</para>
Index: gstobject.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstobject.sgml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- gstobject.sgml 2001/05/27 14:33:30 1.11
+++ gstobject.sgml 2001/10/17 10:21:23 1.12
@@ -141,14 +141,6 @@
@obj: The Object to check
-<!-- ##### FUNCTION gst_object_new ##### -->
-<para>
-
-</para>
-
- at Returns:
-
-
<!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
<para>
Index: gstpad.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstpad.sgml,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -d -r1.26 -r1.27
--- gstpad.sgml 2001/07/07 10:55:58 1.26
+++ gstpad.sgml 2001/10/17 10:21:23 1.27
@@ -189,24 +189,6 @@
@size: the size of the region to get
-<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
-<para>
-The function that will be called when a QoS message is sent.
-</para>
-
- at pad: the pad that sent the QoS message
- at qos_message: the message
-
-
-<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
-<para>
-The function that will be called in an EOS case.
-</para>
-
- at pad: the pad that needs to be set to EOS state
- at Returns: TRUE if EOS was successful, FALSE otherwise
-
-
<!-- ##### USER_FUNCTION GstPadNewCapsFunction ##### -->
<para>
The function that will be called when the caps of the pad has
@@ -247,25 +229,6 @@
@Returns: The result of the negotiation process
-<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
-<para>
-
-The function that will be called when pushing a buffers.
-</para>
-
- at pad: the pad to push
- at buf: a GstBuffer to push
-
-
-<!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
-<para>
-The function that will be called when pulling buffers.
-</para>
-
- at pad: the pad to pull
- at Returns: a GstBuffer
-
-
<!-- ##### ENUM GstRegionType ##### -->
<para>
the region types for #gst_pad_pullregion.
@@ -383,24 +346,6 @@
@nego:
-<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
-<para>
-
-</para>
-
- at pad:
- at qos:
-
-
-<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
-<para>
-
-</para>
-
- at pad:
- at eos:
-
-
<!-- ##### FUNCTION gst_pad_set_newcaps_function ##### -->
<para>
@@ -627,32 +572,6 @@
@Returns:
-<!-- ##### FUNCTION gst_pad_set_eos ##### -->
-<para>
-
-</para>
-
- at pad:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
-<para>
-
-</para>
-
- at pad:
- at qos_message:
-
-
-<!-- ##### MACRO gst_pad_eos ##### -->
-<para>
-Call the EOS function of the pad
-</para>
-
- at pad: the pad to call the eos function of.
-
-
<!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
<para>
@@ -706,15 +625,6 @@
@Returns:
-<!-- ##### FUNCTION gst_pad_eos_func ##### -->
-<para>
-
-</para>
-
- at pad:
- at Returns:
-
-
<!-- ##### STRUCT GstRealPad ##### -->
<para>
@@ -731,12 +641,12 @@
@len:
@sched:
@chainfunc:
+ at chainhandler:
@getfunc:
+ at gethandler:
+ at eventfunc:
+ at eventhandler:
@getregionfunc:
- at qosfunc:
- at eosfunc:
- at pushfunc:
- at pullfunc:
@pullregionfunc:
@negotiatefunc:
@newcapsfunc:
@@ -831,41 +741,9 @@
@pad: the real pad to query.
-<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
-<para>
-Get the pushfunction of the real pad.
-</para>
-
- at pad: the real pad to query.
-
-
-<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
-<para>
-Get the pullfunction of the real pad.
-</para>
-
- at pad: the real pad to query.
-
-
<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
<para>
Get the pullregion function of the real pad.
-</para>
-
- at pad: the real pad to query.
-
-
-<!-- ##### MACRO GST_RPAD_QOSFUNC ##### -->
-<para>
-Get the QoS function of the real pad.
-</para>
-
- at pad: the real pad to query.
-
-
-<!-- ##### MACRO GST_RPAD_EOSFUNC ##### -->
-<para>
-Get the EOS function of the real pad.
</para>
@pad: the real pad to query.
Index: gstplugin.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstplugin.sgml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- gstplugin.sgml 2001/07/07 10:55:58 1.14
+++ gstplugin.sgml 2001/10/17 10:21:23 1.15
@@ -63,11 +63,9 @@
@name:
@longname:
@filename:
- at types:
- at numtypes:
- at elements:
- at numelements:
- at numautopluggers:
+ at features:
+ at numfeatures:
+ at module:
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
@@ -198,33 +196,6 @@
@Returns:
-<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
-<para>
-
-</para>
-
- at plugin:
- at factory:
-
-
-<!-- ##### FUNCTION gst_plugin_add_type ##### -->
-<para>
-
-</para>
-
- at plugin:
- at factory:
-
-
-<!-- ##### FUNCTION gst_plugin_add_autoplugger ##### -->
-<para>
-
-</para>
-
- at plugin:
- at factory:
-
-
<!-- ##### FUNCTION gst_plugin_find ##### -->
<para>
@@ -239,59 +210,6 @@
</para>
- at Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_get_factory_list ##### -->
-<para>
-
-</para>
-
- at plugin:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
-<para>
-
-</para>
-
- at plugin:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
-<para>
-
-</para>
-
- at plugin:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
-<para>
-
-</para>
-
- at name:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_plugin_load_typefactory ##### -->
-<para>
-
-</para>
-
- at mime:
-
-
-<!-- ##### FUNCTION gst_plugin_load_autoplugfactory ##### -->
-<para>
-
-</para>
-
- at name:
@Returns:
Index: gstqueue.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstqueue.sgml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- gstqueue.sgml 2001/05/27 14:33:30 1.10
+++ gstqueue.sgml 2001/10/17 10:21:23 1.11
@@ -35,7 +35,7 @@
Get the number of buffers in the queue.
</para>
-<!-- ##### ARG GstQueue:max_level ##### -->
+<!-- ##### ARG GstQueue:max-level ##### -->
<para>
Specify the maximum number of buffers in the queue before the queue
blocks.
Index: gstreamer-unused.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstreamer-unused.sgml,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -d -r1.45 -r1.46
--- gstreamer-unused.sgml 2001/07/20 21:26:34 1.45
+++ gstreamer-unused.sgml 2001/10/17 10:21:23 1.46
@@ -1,410 +1,489 @@
-<!-- ##### FUNCTION gst_fakesink_chain ##### -->
+<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para>
</para>
- at pad:
- at buf:
-<!-- ##### ARG GstTypeFind:type ##### -->
+<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
[...4628 lines suppressed...]
+ at name:
+ at Returns:
-<!-- ##### STRUCT GstTee ##### -->
+<!-- ##### FUNCTION plugin_load_absolute ##### -->
<para>
</para>
+ at name:
+ at Returns:
-<!-- ##### SECTION ./tmpl/gstsrc.sgml:Long_Description ##### -->
+<!-- ##### FUNCTION plugin_load_all ##### -->
<para>
-A GstSrc is the start of a filter graph. It typically is a file or an
-audio source. It provides data for the next element in the graph.
</para>
Index: gsttee.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gsttee.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- gsttee.sgml 2001/07/20 21:26:34 1.4
+++ gsttee.sgml 2001/10/17 10:21:23 1.5
@@ -14,7 +14,7 @@
</para>
-<!-- ##### ARG GstTee:num_pads ##### -->
+<!-- ##### ARG GstTee:num-pads ##### -->
<para>
</para>
Index: gstthread.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gstthread.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- gstthread.sgml 2001/05/25 21:00:05 1.9
+++ gstthread.sgml 2001/10/17 10:21:23 1.10
@@ -45,7 +45,7 @@
@Returns:
-<!-- ##### ARG GstThread:create_thread ##### -->
+<!-- ##### ARG GstThread:create-thread ##### -->
<para>
TRUE if the thread should be created.
Index: gsttype.sgml
===================================================================
RCS file: /cvsroot/gstreamer/gstreamer/docs/gst/tmpl/gsttype.sgml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- gsttype.sgml 2001/01/06 22:05:15 1.8
+++ gsttype.sgml 2001/10/17 10:21:23 1.9
@@ -71,13 +71,14 @@
@id:
@mime:
@exts:
- at typefindfuncs:
+ at factories:
<!-- ##### STRUCT GstTypeFactory ##### -->
<para>
The struct with the typefactory information.
</para>
+ at feature:
@mime:
@exts:
@typefindfunc:
@@ -123,25 +124,6 @@
</para>
- at Returns:
-
-
-<!-- ##### FUNCTION gst_typefactory_load_thyself ##### -->
-<para>
-
-</para>
-
- at parent:
- at Returns:
-
-
-<!-- ##### FUNCTION gst_typefactory_save_thyself ##### -->
-<para>
-
-</para>
-
- at factory:
- at parent:
@Returns:
More information about the Gstreamer-commits
mailing list