Commit 892f4b32 authored by Wim Taymans's avatar Wim Taymans

API docs updates.

Original commit message from CVS:
API docs updates.
Properly implemented the disksink.
Fixed a compile problem with alsa.
Added bufferpool handling to dvdec
Some compiler warning fixes
parent 610e9e82
......@@ -32,6 +32,7 @@
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
......@@ -122,6 +123,8 @@ with some more specialized elements.</para>
&GstFakeSink;
&GstDiskSrc;
&GstDiskSink;
&GstHttpSrc;
&GstSineSrc;
......
......@@ -133,7 +133,6 @@ GST_BUFFER_FLAGS
GST_BUFFER_FLAG_IS_SET
GST_BUFFER_FLAG_SET
GST_BUFFER_FLAG_UNSET
GST_BUFFER_TYPE
GST_BUFFER_DATA
GST_BUFFER_SIZE
GST_BUFFER_OFFSET
......@@ -144,12 +143,15 @@ GST_BUFFER_POOL_PRIVATE
GST_BUFFER_LOCK
GST_BUFFER_TRYLOCK
GST_BUFFER_UNLOCK
GST_BUFFER_PARENT
GST_BUFFER_MAXAGE
GstBufferFlags
GstBuffer
gst_buffer_new
gst_buffer_new_from_pool
gst_buffer_copy
gst_buffer_create_sub
gst_buffer_append
gst_buffer_ref
......@@ -524,8 +526,8 @@ gst_pipeline_details
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
GstPlugin
GstPluginElement
GstPluginInitFunc
GstPluginDesc
gst_plugin_new
gst_plugin_set_name
gst_plugin_get_name
......@@ -668,6 +670,7 @@ GST_CAPS
<TITLE>GstProps</TITLE>
GstProps
GST_MAKE_FOURCC
GST_STR_FOURCC
GST_PROPS_LIST
GST_PROPS_INT
GST_PROPS_INT_RANGE
......@@ -927,6 +930,20 @@ GST_IS_TYPEFIND
GST_IS_TYPEFIND_CLASS
</SECTION>
<SECTION>
<FILE>gstdisksink</FILE>
<TITLE>GstDiskSink</TITLE>
GstDiskSinkFlags
<SUBSECTION Standard>
GstDiskSink
GST_DISKSINK
GST_IS_DISKSINK
GST_TYPE_DISKSINK
gst_disksink_get_type
GST_DISKSINK_CLASS
GST_IS_DISKSINK_CLASS
</SECTION>
<SECTION>
<FILE>gstmultidisksrc</FILE>
<TITLE>GstMultiDiskSrc</TITLE>
......
......@@ -9,6 +9,7 @@ GtkObject
GstFakeSrc
GstFakeSink
GstDiskSrc
GstDiskSink
GstHttpSrc
GstFdSrc
GstSineSrc
......
......@@ -95,14 +95,6 @@ Clear a flag in a buffer.
@flag: the flag to clear
<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
<para>
Retrieves the type id of the data in the buffer.
</para>
@buf: GstBuffer
<!-- ##### MACRO GST_BUFFER_DATA ##### -->
<para>
Retrieves a pointer to the data element of this buffer
......@@ -188,6 +180,22 @@ This macro releases a lock on the object.
@buf: GstBuffer to unlock.
<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
<para>
Get the parent of this buffer. The parent is set on subbuffers.
</para>
@buf: GstBuffer to get the parent of.
<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
<para>
Get the maximun age of a buffer.
</para>
@buf: GstBuffer to get the maxage of.
<!-- ##### ENUM GstBufferFlags ##### -->
<para>
......@@ -207,7 +215,6 @@ used when data in a stream has been skipped
</para>
@lock:
@flags:
@data:
@size:
@maxsize:
......@@ -236,6 +243,15 @@ used when data in a stream has been skipped
@Returns:
<!-- ##### FUNCTION gst_buffer_copy ##### -->
<para>
</para>
@buffer:
@Returns:
<!-- ##### FUNCTION gst_buffer_create_sub ##### -->
<para>
......
......@@ -24,3 +24,8 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:silent ##### -->
<para>
</para>
......@@ -69,12 +69,6 @@ to bring it into memory.
@numautopluggers:
@loaded:
<!-- ##### STRUCT GstPluginElement ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
A plugin should implement this function called plugin_init. It will be called
......@@ -82,15 +76,28 @@ by the loader at statup.
</para>
@module: The <classname>GModule</classname> it was loaded from
@plugin:
@Returns: The plugin or NULL is an error was detected.
<!-- ##### STRUCT GstPluginDesc ##### -->
<para>
</para>
@major_version:
@minor_version:
@name:
@plugin_init:
<!-- ##### FUNCTION gst_plugin_new ##### -->
<para>
</para>
@name:
@major:
@minor:
@Returns:
......
......@@ -28,6 +28,11 @@ are usually used in conjunction with GstCaps.
<para>
Create a FOURCC value that can easily be used to construct
a fourcc property.
<programlisting>
...
"format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('Y','U','Y','2')),
...
</programlisting>
</para>
@a: first fourcc byte
......@@ -36,6 +41,19 @@ a fourcc property.
@d: fourth fourcc byte
<!-- ##### MACRO GST_STR_FOURCC ##### -->
<para>
Create a FOURCC value from a string. example:
<programlisting>
...
"format", GST_PROPS_FOURCC (GST_STR_FOURCC ("YUY2")),
...
</programlisting>
</para>
@f: the string describing the fourcc value.
<!-- ##### MACRO GST_PROPS_LIST ##### -->
<para>
Create a list of properties.
......
......@@ -67,21 +67,21 @@ Query the element for the current mime type
</para>
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
</para>
@pad:
@parent:
@buf:
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
</para>
@pad:
@buf:
@parent:
<!-- ##### FUNCTION gst_identity_chain ##### -->
<para>
......@@ -91,20 +91,20 @@ Query the element for the current mime type
@pad:
@buf:
<!-- ##### FUNCTION gst_connection_get_type ##### -->
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<para>
</para>
@Returns:
@pad:
@buf:
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<!-- ##### FUNCTION gst_connection_get_type ##### -->
<para>
</para>
@pad:
@buf:
@Returns:
<!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
<para>
......@@ -200,18 +200,18 @@ the stream.
@gstsrc: the object which received the signal.
@arg1: the object which received the signal
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<!-- ##### FUNCTION gst_disksrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_disksrc_get_type ##### -->
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
<para>
......@@ -366,16 +366,16 @@ subclass use this to start their flag enumeration
@audiosink:
@channels:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstSinkClass ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstFilterClass ##### -->
<para>
......@@ -655,13 +655,13 @@ Specify the current offset in the file.
@sheight:
@bytes_per_line:
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:format ##### -->
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para>
</para>
......@@ -695,32 +695,32 @@ Specify the current offset in the file.
@name:
@Returns:
<!-- ##### STRUCT GstConnection ##### -->
<!-- ##### STRUCT GstQueueClass ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### -->
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<!-- ##### FUNCTION gst_type_add_sink ##### -->
<para>
</para>
@src:
@id:
@sink:
<!-- ##### FUNCTION gst_type_add_sink ##### -->
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@id:
@sink:
@src:
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
<para>
......@@ -1135,19 +1135,19 @@ GstFilter
@obj:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@obj:
@Returns:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para>
</para>
@Returns:
@obj:
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
......@@ -1157,13 +1157,6 @@ GstFilter
@pad:
@Returns:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### STRUCT OverlayClip ##### -->
<para>
......@@ -1174,6 +1167,13 @@ GstFilter
@y1:
@y2:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
Flags for the GstSrc element
......@@ -1249,19 +1249,19 @@ Defines an entry for a padfactory.
@obj:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@Returns:
@klass:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para>
</para>
@klass:
@Returns:
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para>
......@@ -1298,19 +1298,19 @@ Indicates a sinkpad for the padfactory.
@pad:
@Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<!-- ##### FUNCTION gst_esdsink_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_esdsink_new ##### -->
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_element_request_pad ##### -->
<para>
......@@ -1421,12 +1421,12 @@ This macro sets the given flags.
@flag: Flag to set, can by any number of bits in guint32.
@obj: GstSrc to set flag in.
<!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
<para>
Retrieves the type id of the data in the buffer.
</para>
@a:
@buf: GstBuffer
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
......@@ -1434,6 +1434,13 @@ This macro sets the given flags.
</para>
<!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
<para>
</para>
@a:
<!-- ##### FUNCTION gst_filter_get_type ##### -->
<para>
......@@ -1455,16 +1462,16 @@ This macro sets the given flags.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_object_get_type ##### -->
<para>
......@@ -1508,6 +1515,12 @@ Indicates a srcpad for the padfactory.
</para>
<!-- ##### ARG GstDiskSink:closed ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_SINK_CLASS ##### -->
<para>
......@@ -1771,19 +1784,19 @@ or a video card.
</para>
<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<para>
</para>
@obj:
@Returns:
<!-- ##### FUNCTION gst_esdsink_get_type ##### -->
<!-- ##### MACRO GST_IS_BIN_CLASS ##### -->
<para>
</para>
@Returns:
@obj:
<!-- ##### SECTION ./tmpl/GstElement.sgml:See_Also ##### -->
<para>
......@@ -1805,19 +1818,19 @@ Query whether this object has multiple input pads.
@obj: Element to query for multiple input pads.
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_NOPREFIX ##### -->
<!-- ##### SECTION ./tmpl/gstfilter.sgml:See_Also ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### ARG GstAudioSink:frequency ##### -->
<para>
......@@ -2236,13 +2249,6 @@ this in the factory definition.
@audiosink:
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para>
This macro unsets the given state on the element.
......@@ -2251,6 +2257,13 @@ This macro unsets the given state on the element.
@obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
......@@ -2323,22 +2336,22 @@ The number of bytes per read.
@obj:
<!-- ##### MACRO ERROR_OBJECT ##### -->
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@element:
@object:
@format:
@args...:
@Returns:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<!-- ##### MACRO ERROR_OBJECT ##### -->
<para>
</para>
@Returns:
@element:
@object:
@format:
@args...:
<!-- ##### MACRO GST_IS_IDENTITY ##### -->
<para>
......@@ -2444,9 +2457,14 @@ This macro sets the given state on the element.
@obj:
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
Information about video buffers.
<!-- ##### FUNCTION gst_src_push_region ##### -->
<para>
</para>
@src:
@offset:
@size: