mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-08 16:35:40 +00:00
API docs updates
Original commit message from CVS: API docs updates
This commit is contained in:
parent
fcd6ee590b
commit
17f02e233d
8 changed files with 114 additions and 67 deletions
|
@ -64,6 +64,8 @@ GST_DEBUG_FUNCPTR_NAME
|
|||
GST_DEBUG_PAD_NAME
|
||||
GST_ERROR
|
||||
GST_ERROR_OBJECT
|
||||
GST_DEBUG_CHAR_MODE
|
||||
|
||||
gst_default_error_handler
|
||||
GstInfoHandler
|
||||
GstErrorHandler
|
||||
|
@ -147,6 +149,8 @@ GST_BUFFER_PARENT
|
|||
GST_BUFFER_MAXAGE
|
||||
|
||||
|
||||
GstBufferCopyFunc
|
||||
GstBufferFreeFunc
|
||||
GstBufferFlags
|
||||
GstBuffer
|
||||
gst_buffer_new
|
||||
|
@ -158,10 +162,6 @@ gst_buffer_ref
|
|||
gst_buffer_ref_by_count
|
||||
gst_buffer_unref
|
||||
gst_buffer_destroy
|
||||
gst_buffer_add_meta
|
||||
gst_buffer_get_first_meta
|
||||
gst_buffer_get_metas
|
||||
gst_buffer_remove_meta
|
||||
<SUBSECTION Standard>
|
||||
GST_BUFFER
|
||||
</SECTION>
|
||||
|
@ -658,6 +658,8 @@ gst_caps_get_by_name
|
|||
gst_caps_get_fourcc_int
|
||||
gst_caps_get_int
|
||||
gst_caps_get_string
|
||||
gst_caps_get_float
|
||||
|
||||
|
||||
gst_caps_save_thyself
|
||||
gst_caps_load_thyself
|
||||
|
@ -693,6 +695,7 @@ gst_props_get_boolean
|
|||
gst_props_get_fourcc_int
|
||||
gst_props_get_int
|
||||
gst_props_get_string
|
||||
gst_props_get_float
|
||||
gst_props_save_thyself
|
||||
gst_props_load_thyself
|
||||
<SUBSECTION Standard>
|
||||
|
@ -894,6 +897,7 @@ GST_IS_QUEUE_CLASS
|
|||
GstSineSrc
|
||||
GstSineSrcClass
|
||||
gst_sinesrc_get_type
|
||||
gst_sinesrc_factory_init
|
||||
GST_TYPE_SINESRC
|
||||
GST_SINESRC
|
||||
GST_SINESRC_CLASS
|
||||
|
|
|
@ -1,4 +1,7 @@
|
|||
GtkObject
|
||||
GtkWidget
|
||||
GtkRange
|
||||
GtkContainer
|
||||
GstObject
|
||||
GstXML
|
||||
GstElement
|
||||
|
@ -9,7 +12,6 @@ GtkObject
|
|||
GstFakeSrc
|
||||
GstFakeSink
|
||||
GstDiskSrc
|
||||
GstDiskSink
|
||||
GstHttpSrc
|
||||
GstFdSrc
|
||||
GstSineSrc
|
||||
|
|
|
@ -196,6 +196,23 @@ Get the maximun age of a buffer.
|
|||
@buf: GstBuffer to get the maxage of.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferCopyFunc ##### -->
|
||||
<para>
|
||||
This function is used to copy the buffer contents.
|
||||
</para>
|
||||
|
||||
@srcbuf: the src buffer
|
||||
@dstbuf: the destination buffer
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBufferFreeFunc ##### -->
|
||||
<para>
|
||||
The function called when the buffer data has to be freed
|
||||
</para>
|
||||
|
||||
@buf: the buffer to clear the buffer data of.
|
||||
|
||||
|
||||
<!-- ##### ENUM GstBufferFlags ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -221,10 +238,10 @@ used when data in a stream has been skipped
|
|||
@offset:
|
||||
@timestamp:
|
||||
@maxage:
|
||||
@metas:
|
||||
@parent:
|
||||
@pool:
|
||||
@pool_private:
|
||||
@free:
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_new ##### -->
|
||||
<para>
|
||||
|
@ -306,39 +323,3 @@ used when data in a stream has been skipped
|
|||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_add_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@meta:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@meta:
|
||||
|
||||
|
||||
|
|
|
@ -366,6 +366,15 @@ Get the value of the named property as a string.
|
|||
@name: the name of the property to get
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_float ##### -->
|
||||
<para>
|
||||
Get the value of the named property as a float.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -22,15 +22,3 @@ The disksink write to a file. The filename can be given as an argument.
|
|||
@GST_DISKSINK_OPEN:
|
||||
@GST_DISKSINK_FLAG_LAST:
|
||||
|
||||
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
|
||||
<para>
|
||||
Is emited after the buffer has been written to the disk.
|
||||
</para>
|
||||
|
||||
@gstdisksink: the object which received the signal.
|
||||
|
||||
<!-- ##### ARG GstDiskSink:location ##### -->
|
||||
<para>
|
||||
The filename to write to.
|
||||
</para>
|
||||
|
||||
|
|
|
@ -229,6 +229,7 @@ Print out debugging information.
|
|||
|
||||
</para>
|
||||
|
||||
@cat:
|
||||
@format:
|
||||
@args...:
|
||||
|
||||
|
@ -277,6 +278,13 @@ Print out an error condition and abort the application.
|
|||
@args...: printf arguments
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_default_error_handler ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -259,6 +259,16 @@ Create a float range value.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_props_get_float ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@props:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_props_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -313,6 +313,12 @@ the stream.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GstDiskSink:location ##### -->
|
||||
<para>
|
||||
The filename to write to.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_SRC_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -966,6 +972,14 @@ The buffer is sent to the sound card.
|
|||
@pad:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_add_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@meta:
|
||||
|
||||
<!-- ##### FUNCTION gst_elementfactory_can_src_caps_list ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -989,6 +1003,14 @@ The buffer is sent to the sound card.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@meta:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_register_count ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1111,6 +1133,13 @@ The buffer is sent to the sound card.
|
|||
@name:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
|
||||
<para>
|
||||
Is emited after the buffer has been written to the disk.
|
||||
</para>
|
||||
|
||||
@gstdisksink: the object which received the signal.
|
||||
|
||||
<!-- ##### MACRO GST_ESDSINK ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1521,6 +1550,14 @@ Indicates a srcpad for the padfactory.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1784,13 +1821,6 @@ or a video card.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1798,6 +1828,13 @@ or a video card.
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1818,6 +1855,12 @@ Query whether this object has multiple input pads.
|
|||
|
||||
@obj: Element to query for multiple input pads.
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1826,12 +1869,6 @@ Query whether this object has multiple input pads.
|
|||
@format:
|
||||
@args...:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GstAudioSink:frequency ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -2749,6 +2786,14 @@ the offset.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
|
Loading…
Reference in a new issue