mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-11 01:45:33 +00:00
Docs updates
Original commit message from CVS: Docs updates
This commit is contained in:
Wim Taymans
parent
dd067c0000
commit
feab2e15e5
1 changed files with 145 additions and 145 deletions
|
|
@ -67,14 +67,6 @@ Query the element for the current mime type
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@parent:
|
||||
|
||||
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -83,6 +75,14 @@ Query the element for the current mime type
|
|||
@pad:
|
||||
@buf:
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@parent:
|
||||
|
||||
<!-- ##### FUNCTION gst_identity_chain ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -91,6 +91,14 @@ Query the element for the current mime type
|
|||
@pad:
|
||||
@buf:
|
||||
|
||||
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@buf:
|
||||
|
||||
<!-- ##### FUNCTION gst_connection_get_type ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -98,14 +106,6 @@ Query the element for the current mime type
|
|||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@buf:
|
||||
|
||||
<!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -200,12 +200,6 @@ the stream.
|
|||
@gstsrc: the object which received the signal.
|
||||
@arg1: the object which received the signal
|
||||
|
||||
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_disksrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -213,6 +207,12 @@ the stream.
|
|||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -372,16 +372,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>
|
||||
|
||||
|
|
@ -686,13 +686,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>
|
||||
|
|
@ -726,24 +726,17 @@ Specify the current offset in the file.
|
|||
@name:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### STRUCT GstConnection ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstQueueClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
|
||||
<!-- ##### STRUCT GstConnection ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src:
|
||||
|
||||
<!-- ##### FUNCTION gst_type_add_sink ##### -->
|
||||
<para>
|
||||
|
|
@ -753,6 +746,13 @@ Specify the current offset in the file.
|
|||
@id:
|
||||
@sink:
|
||||
|
||||
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@src:
|
||||
|
||||
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1158,13 +1158,6 @@ The buffer is sent to the sound card.
|
|||
|
||||
@connection:
|
||||
|
||||
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
|
||||
<para>
|
||||
Is emited after the buffer has been written to the disk.
|
||||
</para>
|
||||
|
||||
@gstdisksink: the object which received the signal.
|
||||
|
||||
<!-- ##### FUNCTION gst_audiosink_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1173,6 +1166,13 @@ Is emited after the buffer has been written to the disk.
|
|||
@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.
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_set_element_manager ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1205,13 +1205,6 @@ GstFilter
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1219,6 +1212,13 @@ GstFilter
|
|||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@obj:
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1227,13 +1227,6 @@ GstFilter
|
|||
@pad:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_iterate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@thread:
|
||||
|
||||
<!-- ##### STRUCT OverlayClip ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1244,6 +1237,13 @@ GstFilter
|
|||
@y1:
|
||||
@y2:
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_iterate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@thread:
|
||||
|
||||
<!-- ##### ENUM GstSrcFlags ##### -->
|
||||
<para>
|
||||
Flags for the GstSrc element
|
||||
|
|
@ -1325,13 +1325,6 @@ subclasses can use this value to start the enumeration of their flags
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1339,6 +1332,13 @@ subclasses can use this value to start the enumeration of their flags
|
|||
|
||||
@klass:
|
||||
|
||||
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
|
||||
<para>
|
||||
Indicates a sinkpad for the padfactory.
|
||||
|
|
@ -1374,12 +1374,6 @@ Indicates a sinkpad for the padfactory.
|
|||
@pad:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_esdsink_new ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1388,6 +1382,12 @@ Indicates a sinkpad for the padfactory.
|
|||
@name:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_element_request_pad ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1504,6 +1504,12 @@ Retrieves the type id of the data in the buffer.
|
|||
|
||||
@buf: GstBuffer
|
||||
|
||||
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1511,12 +1517,6 @@ Retrieves the type id of the data in the buffer.
|
|||
|
||||
@a:
|
||||
|
||||
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_filter_get_type ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -1538,16 +1538,16 @@ Retrieves the type id of the data in the buffer.
|
|||
</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>
|
||||
|
||||
|
|
@ -2294,13 +2294,6 @@ The start point of a filter graph
|
|||
|
||||
@src:
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
|
||||
<!-- ##### FUNCTION gst_props_register_count ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2310,6 +2303,13 @@ The start point of a filter graph
|
|||
@counter:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bin:
|
||||
|
||||
<!-- ##### MACRO GST_PROPS_FLOAT_RANGE_STRING ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2331,18 +2331,18 @@ The start point of a filter graph
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
|
||||
<para>
|
||||
The default stack size of a cothread.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
|
||||
<para>
|
||||
The default stack size of a cothread.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstBinClass ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2397,13 +2397,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.
|
||||
|
|
@ -2412,6 +2405,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>
|
||||
|
||||
|
|
@ -2484,6 +2484,13 @@ The number of bytes per read.
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO ERROR_OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2494,13 +2501,6 @@ The number of bytes per read.
|
|||
@format:
|
||||
@args...:
|
||||
|
||||
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_IDENTITY ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2605,17 +2605,6 @@ This macro sets the given state on the element.
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
|
||||
Information about video buffers.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_src_push_region ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2625,6 +2614,17 @@ Information about video buffers.
|
|||
@offset:
|
||||
@size:
|
||||
|
||||
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
|
||||
Information about video buffers.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstPipelineClass ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2696,13 +2696,13 @@ This macro checks to see if the GST_SRC_ASYNC flag is set.
|
|||
|
||||
@obj: GstSrc to check for flag in.
|
||||
|
||||
<!-- ##### STRUCT GstPluginElement ##### -->
|
||||
<!-- ##### MACRO GST_TYPE_SINESRC ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_TYPE_SINESRC ##### -->
|
||||
<!-- ##### STRUCT GstPluginElement ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -2733,13 +2733,13 @@ A flag indicating that SSE instructions are supported.
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
|
||||
<!-- ##### STRUCT GstDiskSrcClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstDiskSrcClass ##### -->
|
||||
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
|
@ -2761,6 +2761,12 @@ to the current function, i.e. "('element')"
|
|||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### STRUCT GstElementClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bin_remove_managed_element ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2769,12 +2775,6 @@ to the current function, i.e. "('element')"
|
|||
@bin:
|
||||
@element:
|
||||
|
||||
<!-- ##### STRUCT GstElementClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_IS_SRC ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2837,12 +2837,6 @@ Information about audio buffers.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION plugin_initialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_register ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2851,6 +2845,12 @@ Information about audio buffers.
|
|||
@factory:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION plugin_initialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
|
||||
<para>
|
||||
Specify the location of the file to read.
|
||||
|
|
@ -2914,12 +2914,12 @@ the offset.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_sinesrc_new ##### -->
|
||||
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
|
||||
|
|
@ -2929,12 +2929,12 @@ the offset.
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
|
||||
<!-- ##### FUNCTION gst_sinesrc_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### ARG GstAudioSrc:curoffset ##### -->
|
||||
|
|
@ -2985,13 +2985,6 @@ plugin
|
|||
|
||||
@klass:
|
||||
|
||||
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
|
||||
<para>
|
||||
|
||||
|
|
@ -2999,6 +2992,13 @@ plugin
|
|||
|
||||
@obj:
|
||||
|
||||
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
|
||||
<!-- ##### ARG GstPad:active ##### -->
|
||||
<para>
|
||||
Indicates this pad is active
|
||||
|
|
|
|||
Loading…
Reference in a new issue