From 532658584d7ff05f83642e08ab0a383fc4eb855b Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Tue, 11 Feb 2003 20:38:41 +0000 Subject: [PATCH] Small documentation updates Original commit message from CVS: Small documentation updates --- docs/gst/gstreamer-sections.txt | 1 + docs/gst/tmpl/gstbin.sgml | 10 ++++++++++ docs/gst/tmpl/gstevent.sgml | 30 +++++++++++++++++++++++++++--- docs/gst/tmpl/gstxml.sgml | 4 ++++ 4 files changed, 42 insertions(+), 3 deletions(-) diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index e8c5a82ac0..200f071246 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -218,6 +218,7 @@ gst_bin_destroy gst_bin_add gst_bin_add_many gst_bin_remove +gst_bin_remove_many gst_bin_get_by_name gst_bin_get_by_name_recurse_up gst_bin_get_list diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index b6eda534c4..96f7b179f7 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -127,6 +127,16 @@ Free the memory allocated by this bin @element: + + + + + +@bin: +@element_1: +@Varargs: + + diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index edcd883c35..421c7631cc 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -24,7 +24,7 @@ gst_event_new_flush() creates a new flush event. -#GstPad +#GstPad, #GstElement @@ -46,7 +46,8 @@ The different major types of events. @GST_EVENT_RATE: adjust the output rate of an element @GST_EVENT_FILLER: a dummy event that should be ignored by plugins @GST_EVENT_TS_OFFSET: an event to set the time offset on buffers -@GST_EVENT_INTERRUPT: +@GST_EVENT_INTERRUPT: mainly used by _get based elements when they were interrupted + while waiting for a buffer. @@ -82,7 +83,30 @@ Event flags are used when querying for supported events -The different types of seek events. +The different types of seek events. When constructing a seek event a format, +a seek method and optional flags are OR-ed together. The seek event is then +inserted into the graph with #gst_pad_send_event() or #gst_element_send_event(). + + + Following example illustrates how to insert a seek event (1 second in the stream) + in a pipeline. + + + gboolean res; + GstEvent *event; + + event = gst_event_new_seek ( + GST_FORMAT_TIME | /* seek on time */ + GST_SEEK_METHOD_SET | /* set the absolute position */ + GST_SEEK_FLAG_FLUSH, /* flush any pending data */ + 1 * GST_SECOND); /* the seek offset (1 second) */ + + res = gst_element_send_event (GST_ELEMENT (osssink), event); + if (!res) { + g_warning ("seek failed"); + } + + @GST_SEEK_METHOD_CUR: Seek to an relative position diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 32d00bc1f9..73bfbd51f8 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -110,6 +110,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded +@: +@: +@: + @gstxml: the object which received the signal. @arg1: @arg2: