Small documentation updates

Original commit message from CVS:
Small documentation updates
This commit is contained in:
Wim Taymans 2003-02-11 20:38:41 +00:00
parent 9e1ed8d760
commit 532658584d
4 changed files with 42 additions and 3 deletions

View file

@ -218,6 +218,7 @@ gst_bin_destroy
gst_bin_add gst_bin_add
gst_bin_add_many gst_bin_add_many
gst_bin_remove gst_bin_remove
gst_bin_remove_many
gst_bin_get_by_name gst_bin_get_by_name
gst_bin_get_by_name_recurse_up gst_bin_get_by_name_recurse_up
gst_bin_get_list gst_bin_get_list

View file

@ -127,6 +127,16 @@ Free the memory allocated by this bin
@element: @element:
<!-- ##### FUNCTION gst_bin_remove_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:
<!-- ##### FUNCTION gst_bin_get_by_name ##### --> <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
<para> <para>

View file

@ -24,7 +24,7 @@ gst_event_new_flush() creates a new flush event.
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
#GstPad #GstPad, #GstElement
</para> </para>
<!-- ##### ENUM GstEventType ##### --> <!-- ##### ENUM GstEventType ##### -->
@ -46,7 +46,8 @@ The different major types of events.
@GST_EVENT_RATE: adjust the output rate of an element @GST_EVENT_RATE: adjust the output rate of an element
@GST_EVENT_FILLER: a dummy event that should be ignored by plugins @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_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.
<!-- ##### MACRO GST_EVENT_TYPE ##### --> <!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para> <para>
@ -82,7 +83,30 @@ Event flags are used when querying for supported events
<!-- ##### ENUM GstSeekType ##### --> <!-- ##### ENUM GstSeekType ##### -->
<para> <para>
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().
<informalexample>
Following example illustrates how to insert a seek event (1 second in the stream)
in a pipeline.
<programlisting>
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");
}
</programlisting>
</informalexample>
</para> </para>
@GST_SEEK_METHOD_CUR: Seek to an relative position @GST_SEEK_METHOD_CUR: Seek to an relative position

View file

@ -110,6 +110,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para> </para>
@:
@:
@:
@gstxml: the object which received the signal. @gstxml: the object which received the signal.
@arg1: @arg1:
@arg2: @arg2: