From 27d784dc03e1ad92dd931c9ff4cdb27f23c6299d Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 28 Dec 2001 20:27:59 +0000 Subject: [PATCH] documentation updates Original commit message from CVS: documentation updates --- docs/gst/gstreamer-sections.txt | 72 ++++++++---------- docs/gst/gstreamer.hierarchy | 28 ++++++- docs/gst/gstreamer.types.in | 2 - docs/gst/tmpl/cothreads.sgml | 62 +++++++++++---- docs/gst/tmpl/gstbuffer.sgml | 4 - docs/gst/tmpl/gstelement.sgml | 21 ++++-- docs/gst/tmpl/gstevent.sgml | 3 + docs/gst/tmpl/gstfilesrc.sgml | 10 +-- docs/gst/tmpl/gsthttpsrc.sgml | 11 --- docs/gst/tmpl/gstidentity.sgml | 5 ++ docs/gst/tmpl/gstpad.sgml | 4 +- docs/gst/tmpl/gstqueue.sgml | 5 ++ docs/gst/tmpl/gstreamer-unused.sgml | 146 ++++++++++++++++++++++++++++++++++++ docs/gst/tmpl/gstscheduler.sgml | 84 ++++++++++++++++----- 14 files changed, 352 insertions(+), 105 deletions(-) diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index bf33a18..c37446f 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -212,18 +212,22 @@ cothread_state cothread_context cothread_func COTHREAD_STARTED -cothread_init +COTHREAD_DESTROYED +cothread_context_init +cothread_context_free cothread_create +cothread_free cothread_setfunc +cothread_stop cothread_switch -cothread_getcurrent -cothread_main cothread_set_data cothread_get_data -cothread_unlock -cothread_current_main cothread_lock cothread_trylock +cothread_unlock +cothread_main +cothread_current_main +cothread_current @@ -291,18 +295,23 @@ GST_DISABLE_LOADSAVE_REGISTRY
gstscheduler GstScheduler -GST_SCHED_PARENT +GST_SCHEDULER_PARENT +GST_SCHEDULER_STATE +gst_scheduler_setup +gst_scheduler_reset gst_scheduler_add_element gst_scheduler_remove_element -gst_scheduler_enable_element -gst_scheduler_disable_element +gst_scheduler_state_transition +gst_scheduler_lock_element +gst_scheduler_unlock_element +gst_scheduler_yield +gst_scheduler_interrupt +gst_scheduler_error gst_scheduler_pad_connect gst_scheduler_pad_disconnect gst_scheduler_pad_select gst_scheduler_iterate gst_scheduler_show -gst_scheduler_lock_element -gst_scheduler_unlock_element GstScheduler GstSchedulerClass @@ -355,8 +364,8 @@ gst_bin_get_type GST_TYPE_BIN GST_BIN GST_BIN_CLASS -GST_BIN_FAST -GST_BIN_CLASS_FAST +GST_BIN_CAST +GST_BIN_CLASS_CAST GST_IS_BIN GST_IS_BIN_CLASS gst_bin_details @@ -492,7 +501,7 @@ GST_STATE_PAUSED_TO_PLAYING GST_STATE_READY_TO_NULL GstElementFlags GST_ELEMENT_IS_THREAD_SUGGESTED -GST_ELEMENT_IS_COTHREAD_STOPPING +GST_ELEMENT_IS_DECOUPLED GST_ELEMENT_IS_EOS GST_ELEMENT_IS_EVENT_AWARE GST_ELEMENT_PARENT @@ -529,15 +538,15 @@ gst_element_wait_state_change gst_element_statename gst_element_error gst_element_get_factory -gst_element_signal_eos +gst_element_set_eos gst_element_restore_thyself GstElementClass GST_TYPE_ELEMENT GST_ELEMENT GST_ELEMENT_CLASS -GST_ELEMENT_FAST -GST_ELEMENT_CLASS_FAST +GST_ELEMENT_CAST +GST_ELEMENT_CLASS_CAST GST_IS_ELEMENT GST_IS_ELEMENT_CLASS gst_element_get_type @@ -666,8 +675,8 @@ GST_OBJECT GST_OBJECT_CLASS GST_IS_OBJECT GST_IS_OBJECT_CLASS -GST_OBJECT_FAST -GST_OBJECT_CLASS_FAST +GST_OBJECT_CAST +GST_OBJECT_CLASS_CAST
@@ -779,8 +788,8 @@ GstPadClass GST_TYPE_PAD GST_PAD GST_PAD_CLASS -GST_PAD_FAST -GST_PAD_CLASS_FAST +GST_PAD_CAST +GST_PAD_CLASS_CAST GST_IS_PAD GST_IS_PAD_CLASS GST_IS_PAD_FAST @@ -790,8 +799,8 @@ GstRealPadClass GST_TYPE_REAL_PAD GST_REAL_PAD GST_REAL_PAD_CLASS -GST_REAL_PAD_FAST -GST_REAL_PAD_CLASS_FAST +GST_REAL_PAD_CAST +GST_REAL_PAD_CLASS_CAST GST_IS_REAL_PAD GST_IS_REAL_PAD_CLASS GST_IS_REAL_PAD_FAST @@ -801,8 +810,8 @@ GstGhostPadClass GST_TYPE_GHOST_PAD GST_GHOST_PAD GST_GHOST_PAD_CLASS -GST_GHOST_PAD_FAST -GST_GHOST_PAD_CLASS_FAST +GST_GHOST_PAD_CAST +GST_GHOST_PAD_CLASS_CAST GST_IS_GHOST_PAD GST_IS_GHOST_PAD_CLASS GST_IS_GHOST_PAD_FAST @@ -1253,21 +1262,6 @@ GST_IS_FDSRC_CLASS
-gsthttpsrc -GstHttpSrc - -GstHttpSrc -GstHttpSrcFlags -gst_httpsrc_get_type -GstHttpSrcClass -GST_TYPE_HTTPSRC -GST_HTTPSRC -GST_HTTPSRC_CLASS -GST_IS_HTTPSRC -GST_IS_HTTPSRC_CLASS -
- -
gstidentity GstIdentity diff --git a/docs/gst/gstreamer.hierarchy b/docs/gst/gstreamer.hierarchy index 19d4552..431bef8 100644 --- a/docs/gst/gstreamer.hierarchy +++ b/docs/gst/gstreamer.hierarchy @@ -1,4 +1,31 @@ GtkObject + GtkWidget + GtkRange + GtkScrollbar + GtkVScrollbar + GtkHScrollbar + GtkScale + GtkHScale + GtkVScale + GtkContainer + GtkBin + GtkScrolledWindow + GtkButton + GtkToggleButton + GtkCheckButton + GtkRadioButton + GtkPaned + GtkVPaned + GtkHPaned + GtkBox + GtkHBox + GtkCombo + GtkCList + GtkEditable + GtkEntry + GtkSpinButton + GtkData + GtkAdjustment GObject GstObject GstXml @@ -11,7 +38,6 @@ GtkObject GstFakeSrc GstFakeSink GstFileSrc - GstHttpSrc GstFdSrc GstFdSink GstPipefilter diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in index 93beaa3..dc43670 100644 --- a/docs/gst/gstreamer.types.in +++ b/docs/gst/gstreamer.types.in @@ -21,8 +21,6 @@ gst_fakesrc_get_type gst_fakesink_get_type gst_filesrc_get_type -gst_disksrc_get_type -@GST_HTTPSRC_GET_TYPE@ gst_fdsrc_get_type gst_fdsink_get_type diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index 7bb30e8..dc602cc 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -69,13 +69,29 @@ Indicates the cothread is started. - + +Indicates the cothread is destroyed. + + + + + + + @Returns: + + + + + +@ctx: + + @@ -85,6 +101,14 @@ Indicates the cothread is started. @Returns: + + + + + +@thread: + + @@ -96,6 +120,14 @@ Indicates the cothread is started. @argv: + + + + + +@thread: + + @@ -104,40 +136,40 @@ Indicates the cothread is started. @thread: - + -@Returns: +@thread: +@key: +@data: - + -@ctx: +@thread: +@key: @Returns: - + @thread: -@key: -@data: - + @thread: -@key: @Returns: @@ -149,28 +181,28 @@ Indicates the cothread is started. @thread: - + +@ctx: @Returns: - + -@thread: +@Returns: - + -@thread: @Returns: diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index dcf4c9f..2405f1d 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -253,10 +253,6 @@ The function called when the buffer data has to be freed @GST_BUFFER_READONLY: the buffer is read only @GST_BUFFER_ORIGINAL: this buffer not a copy @GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unref-ed -@GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly -used when data in a stream has been skipped -@GST_BUFFER_EOS: this buffer is the last one in the stream -@GST_BUFFER_DISCONTINUOUS: The buffer has a discontinuity diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index c3716e4..17e7696 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -135,10 +135,10 @@ This enum defines the standard flags that an element may have. @GST_ELEMENT_DECOUPLED: @GST_ELEMENT_THREAD_SUGGESTED: @GST_ELEMENT_NO_SEEK: -@GST_ELEMENT_NO_ENTRY: +@GST_ELEMENT_INFINITE_LOOP: +@GST_ELEMENT_SCHEDULER_PRIVATE1: +@GST_ELEMENT_SCHEDULER_PRIVATE2: @GST_ELEMENT_NEW_LOOPFUNC: -@GST_ELEMENT_COTHREAD_STOPPING: -@GST_ELEMENT_USE_COTHREAD: @GST_ELEMENT_EVENT_AWARE: @GST_ELEMENT_FLAG_LAST: @@ -150,9 +150,9 @@ Queries whether the Element should be placed in a thread. @obj: The element to query - + -Queries whether the cothread holding this element needs to be stopped. +Queries if the Element is decoupled. @obj: The element to query @@ -475,6 +475,7 @@ instead. @element: @error: +@Varargs: @@ -486,7 +487,7 @@ instead. @Returns: - + @@ -538,6 +539,14 @@ Is trigered whenever an error occured @gstelement: the object which received the signal. @arg1: the error message + + + + + +@gstelement: the object which received the signal. +@arg1: + diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 94caeeb..2c417b2 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -38,6 +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: @@ -96,6 +98,7 @@ The event data structure. @data: The parent data type. @type: The event type. @timestamp: The event timestamp. +@src: diff --git a/docs/gst/tmpl/gstfilesrc.sgml b/docs/gst/tmpl/gstfilesrc.sgml index 404552b..2f362d6 100644 --- a/docs/gst/tmpl/gstfilesrc.sgml +++ b/docs/gst/tmpl/gstfilesrc.sgml @@ -14,27 +14,27 @@ GstFileSrc - + - + - + - + - + diff --git a/docs/gst/tmpl/gsthttpsrc.sgml b/docs/gst/tmpl/gsthttpsrc.sgml index f1c74b8..2ba4a00 100644 --- a/docs/gst/tmpl/gsthttpsrc.sgml +++ b/docs/gst/tmpl/gsthttpsrc.sgml @@ -14,14 +14,3 @@ Reads data from a URL. - - -Specify the location of the file. The location must be a fully qualified URL. - - - - -Specify how many bytes to read at a time. - - - diff --git a/docs/gst/tmpl/gstidentity.sgml b/docs/gst/tmpl/gstidentity.sgml index 70e5009..01946e1 100644 --- a/docs/gst/tmpl/gstidentity.sgml +++ b/docs/gst/tmpl/gstidentity.sgml @@ -37,6 +37,11 @@ Pass data without modification. + + + + + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 03b15ad..9c8a95f 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -696,13 +696,13 @@ Destroy the pad. @pad: @caps: @direction: -@threadstate: +@sched: +@sched_private: @peer: @bufpen: @regiontype: @offset: @len: -@sched: @chainfunc: @chainhandler: @getfunc: diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index afac689..a8e74dd 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -41,3 +41,8 @@ Specify the maximum number of buffers in the queue before the queue blocks. + + + + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 3d58560..7698eca 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -137,6 +137,27 @@ Generic connection between elements. GstConnection + + +Asynchonously read buffers from a file. + + + + + + + + + + + +Asynchronous read from a file (disksrc) + + + +GstDiskSrc + + @@ -200,6 +221,26 @@ GstFilter GstGetbits + + +Reads data from a URL. + + + + + + + + + + +Reads data from a URL. (httpsrc) + + + +GstHttpSrc + + The point of the metadata is to provide some context for each buffer. In @@ -770,6 +811,13 @@ to the current function, i.e. "('element')" @klass: + + +Queries whether the cothread holding this element needs to be stopped. + + +@obj: The element to query + Query whether this object has multiple input pads. @@ -1534,6 +1582,14 @@ Fast macro to unlock a given element. @sched: The scheduler. @element: The element to unlock. + + +Get the parent #GstElement of this scheduler. + + + +@sched: the scheduler to query. + @@ -2486,6 +2542,30 @@ The filename to write to. + + +Specify how many bytes to read at a time. + + + + + + + + + + + +Specify the location of the file to read. + + + + + +Get/set the current offset in the file. + + + Get the size of the file. @@ -2498,6 +2578,23 @@ Get the size of the file. + + + + + + +GST_DISKSRC_OPEN +the disksrc is open for reading + + + + + + +@GST_DISKSRC_OPEN: +@GST_DISKSRC_FLAG_LAST: + @@ -2619,6 +2716,19 @@ GstElementDetails struct for the element. + + +Specify how many bytes to read at a time. + + + + + + +Specify the location of the file. The location must be a fully qualified URL. + + + @@ -3078,6 +3188,19 @@ must be defined to activate the tracing functionality. + + + + + +@Returns: + + + + + +@Returns: + @@ -4229,6 +4352,13 @@ must be defined to activate the tracing functionality. @parent: @Returns: + + + + + +@element: + @@ -4996,6 +5126,22 @@ Call the EOS function of the pad @sched: + + + + + +@sched: +@element: + + + + + + +@sched: +@element: + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 132cb46..962d8ea 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -14,13 +14,36 @@ This is a base class for custom schedulers. - + -Get the parent #GstElement of this scheduler. +Get the parent object of this scheduler. + + +@sched: the scheduler to get the parent of. + + + +Get the state of the scheduler. -@sched: the scheduler to query. +@sched: the scheduler to get the state of. + + + + + + + +@sched: + + + + + + + +@sched: @@ -41,16 +64,18 @@ Get the parent #GstElement of this scheduler. @element: - + @sched: @element: +@transition: +@Returns: - + @@ -59,68 +84,87 @@ Get the parent #GstElement of this scheduler. @element: - + @sched: -@srcpad: -@sinkpad: +@element: - + @sched: -@srcpad: -@sinkpad: +@element: - + @sched: -@padlist: +@element: @Returns: - + @sched: -@Returns: +@element: - + @sched: +@srcpad: +@sinkpad: - + @sched: -@element: +@srcpad: +@sinkpad: - + + + + + +@sched: +@padlist: +@Returns: + + + + + + + +@sched: +@Returns: + + + @sched: -@element: -- 2.7.4