Commit 13ef4f42 authored by Thomas Vander Stichele's avatar Thomas Vander Stichele
Browse files

sync latest api changes

Original commit message from CVS:
sync latest api changes
parent 022fa081
2004-01-20 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/gst.sgml:
* docs/gst/tmpl/gstbuffer.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstreamer-unused.sgml:
* docs/gst/tmpl/gstxml.sgml:
sync latest API changes to docs
2004-01-20 Thomas Vander Stichele <thomas at apestaart dot org> 2004-01-20 Thomas Vander Stichele <thomas at apestaart dot org>
* gst/gstpluginfeature.c: * gst/gstpluginfeature.c:
......
...@@ -361,8 +361,6 @@ GST_BUFFER_SIZE ...@@ -361,8 +361,6 @@ GST_BUFFER_SIZE
GST_BUFFER_MAXSIZE GST_BUFFER_MAXSIZE
GST_BUFFER_TIMESTAMP GST_BUFFER_TIMESTAMP
GST_BUFFER_OFFSET GST_BUFFER_OFFSET
GST_BUFFER_BUFFERPOOL
GST_BUFFER_POOL_PRIVATE
GstBufferFlag GstBufferFlag
GstBuffer GstBuffer
gst_buffer_new gst_buffer_new
......
...@@ -90,14 +90,6 @@ pipeline</ulink> and Microsoft's DirectShow for some background. ...@@ -90,14 +90,6 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
@argv: @argv:
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_init_with_popt_table ##### --> <!-- ##### FUNCTION gst_init_with_popt_table ##### -->
<para> <para>
......
...@@ -214,23 +214,6 @@ Gets the offset in the source file of this buffer. ...@@ -214,23 +214,6 @@ Gets the offset in the source file of this buffer.
@buf: a #GstBuffer to get offset of. @buf: a #GstBuffer to get offset of.
<!-- ##### MACRO GST_BUFFER_BUFFERPOOL ##### -->
<para>
Gets the bufferpool for this buffer.
</para>
@buf: a #GstBuffer to get the bufferpool of.
@Returns: the #GstBufferPool of this buffer.
<!-- ##### MACRO GST_BUFFER_POOL_PRIVATE ##### -->
<para>
Gets the bufferpool private data.
</para>
@buf: a #GstBuffer to get bufferpool's private data of.
<!-- ##### ENUM GstBufferFlag ##### --> <!-- ##### ENUM GstBufferFlag ##### -->
<para> <para>
A set of buffer flags used to describe properties of a #GstBuffer. A set of buffer flags used to describe properties of a #GstBuffer.
...@@ -242,12 +225,9 @@ A set of buffer flags used to describe properties of a #GstBuffer. ...@@ -242,12 +225,9 @@ A set of buffer flags used to describe properties of a #GstBuffer.
@GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer. @GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer.
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is @GST_BUFFER_DONTFREE: do not try to free the data when this buffer is
unreferenced. unreferenced.
@GST_BUFFER_DISCONTINUOUS: the buffer is the first one after a discontinuity
in the stream.
@GST_BUFFER_KEY_UNIT: the buffer holds a key unit, a unit that can be @GST_BUFFER_KEY_UNIT: the buffer holds a key unit, a unit that can be
decoded independently of other buffers. decoded independently of other buffers.
@GST_BUFFER_PREROLL: the buffer should be decoded but not rendered, it is @GST_BUFFER_DONTKEEP:
mainly used to resynchronise the stream.
@GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag. @GST_BUFFER_FLAG_LAST: additional flags can be added starting from this flag.
<!-- ##### STRUCT GstBuffer ##### --> <!-- ##### STRUCT GstBuffer ##### -->
...@@ -263,8 +243,8 @@ The basic structure of a buffer. ...@@ -263,8 +243,8 @@ The basic structure of a buffer.
@duration: @duration:
@offset: @offset:
@offset_end: @offset_end:
@pool: @free_data:
@pool_private: @buffer_private:
@_gst_reserved: @_gst_reserved:
<!-- ##### FUNCTION gst_buffer_new ##### --> <!-- ##### FUNCTION gst_buffer_new ##### -->
......
...@@ -402,6 +402,11 @@ The GstClock object ...@@ -402,6 +402,11 @@ The GstClock object
@id: @id:
<!-- ##### ARG GstClock:event-diff ##### -->
<para>
</para>
<!-- ##### ARG GstClock:max-diff ##### --> <!-- ##### ARG GstClock:max-diff ##### -->
<para> <para>
Maximum allowed diff for clock sync requests against the real time. Maximum allowed diff for clock sync requests against the real time.
......
...@@ -379,11 +379,17 @@ Sets the name of the element, getting rid of the old name if there was one. ...@@ -379,11 +379,17 @@ Sets the name of the element, getting rid of the old name if there was one.
@element: @element:
<!-- ##### FUNCTION gst_element_error ##### --> <!-- ##### MACRO gst_element_error ##### -->
<para> <para>
</para> </para>
@el:
@domain:
@code:
@message:
@debug:
<!-- # Unused Parameters # -->
@element: @element:
@error: @error:
@Varargs: @Varargs:
...@@ -746,6 +752,7 @@ notifications to stdout. ...@@ -746,6 +752,7 @@ notifications to stdout.
@object: @object:
@orig: @orig:
@error: @error:
@debug:
<!-- ##### ENUM GstElementState ##### --> <!-- ##### ENUM GstElementState ##### -->
...@@ -980,6 +987,7 @@ Is triggered whenever an error occured. ...@@ -980,6 +987,7 @@ Is triggered whenever an error occured.
@gstelement: the object which received the signal. @gstelement: the object which received the signal.
@arg1: the error message @arg1: the error message
@arg2: @arg2:
@:
<!-- ##### SIGNAL GstElement::found-tag ##### --> <!-- ##### SIGNAL GstElement::found-tag ##### -->
<para> <para>
......
...@@ -1757,6 +1757,14 @@ Get the value of a #GstAtomicSwap ...@@ -1757,6 +1757,14 @@ Get the value of a #GstAtomicSwap
@klass: @klass:
<!-- ##### MACRO GST_BUFFER_BUFFERPOOL ##### -->
<para>
Gets the bufferpool for this buffer.
</para>
@buf: a #GstBuffer to get the bufferpool of.
@Returns: the #GstBufferPool of this buffer.
<!-- ##### MACRO GST_BUFFER_LOCK ##### --> <!-- ##### MACRO GST_BUFFER_LOCK ##### -->
<para> <para>
Obtains a lock on the object, making serialization possible. Obtains a lock on the object, making serialization possible.
...@@ -1785,6 +1793,13 @@ Unlock the given bufferpool. ...@@ -1785,6 +1793,13 @@ Unlock the given bufferpool.
@pool: the bufferpool to unlock. @pool: the bufferpool to unlock.
<!-- ##### MACRO GST_BUFFER_POOL_PRIVATE ##### -->
<para>
Gets the bufferpool private data.
</para>
@buf: a #GstBuffer to get bufferpool's private data of.
<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### --> <!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
<para> <para>
Lock the given bufferpool. Lock the given bufferpool.
...@@ -8918,6 +8933,13 @@ of an element he doesn't need anymore. ...@@ -8918,6 +8933,13 @@ of an element he doesn't need anymore.
@format: @format:
@args...: @args...:
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_link_get_type ##### --> <!-- ##### FUNCTION gst_link_get_type ##### -->
<para> <para>
......
...@@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded ...@@ -110,10 +110,6 @@ 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:
...@@ -123,7 +119,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded ...@@ -123,7 +119,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para> </para>
@gstxml: the object which received the signal. @:
@arg1: @:
@arg2: @:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment