Commit 9655c3b5 authored by Wim Taymans's avatar Wim Taymans

Updated the API docs.

Original commit message from CVS:
Updated the API docs.
parent c706b661
......@@ -102,7 +102,7 @@ tmpl: scanobj scan
sgml: tmpl
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
html: sgml
if ! test -d html ; then mkdir html ; fi
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
......
This diff is collapsed.
......@@ -14,6 +14,7 @@
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstSink SYSTEM "sgml/gstsink.sgml">
<!entity GstSrc SYSTEM "sgml/gstsrc.sgml">
......@@ -21,6 +22,8 @@
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml">
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
......@@ -66,6 +69,7 @@ with some more specialized elements.</para>
&GstElement;
&GstBin;
&GstPipeline;
&GstAutoplug;
&GstFilter;
&GstSink;
&GstSrc;
......@@ -78,6 +82,8 @@ with some more specialized elements.</para>
&GstTee;
&GstType;
&GstCaps;
&GstProps;
&GstMeta;
&GstUtils;
&GstCpu;
......
......@@ -14,6 +14,7 @@ cothread_init
cothread_create
cothread_setfunc
cothread_switch
cothread_getcurrent
cothread_main
cothread_set_data
cothread_get_data
......@@ -48,11 +49,19 @@ gst_extra_get_filename_type
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstscheduler</FILE>
<TITLE>GstScheduler</TITLE>
gst_bin_schedule_func
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
<TITLE>GstBin</TITLE>
GstBinFlags
GstBin
gst_bin_new
gst_bin_destroy
gst_bin_add
gst_bin_remove
gst_bin_get_by_name
......@@ -60,6 +69,7 @@ gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
gst_bin_create_plan
gst_bin_schedule
<SUBSECTION Standard>
GstBinClass
gst_bin_get_type
......@@ -69,8 +79,8 @@ GST_BIN_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
gst_bin_destroy
gst_bin_use_cothreads
_GstBinChain
</SECTION>
<SECTION>
......@@ -145,41 +155,49 @@ GstElementState
GstElementStateReturn
GST_STATE
GST_STATE_PENDING
GST_STATE_TRANSITION
GST_STATE_NULL_TO_READY
GST_STATE_READY_TO_PLAYING
GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_PLAYING
GST_STATE_PLAYING_TO_READY
GST_STATE_READY_TO_NULL
GstElementFlags
GST_ELEMENT_IS_MULTI_IN
GST_ELEMENT_IS_THREAD_SUGGESTED
GST_ELEMENT_IS_COTHREAD_STOPPING
GstElement
GstElementDetails
GstElementFactory
GstElementLoopFunction
gst_element_new
gst_element_destroy
gst_element_set_loop_function
gst_element_set_name
gst_element_get_name
gst_element_set_manager
gst_element_get_manager
gst_element_add_pad
gst_element_add_ghost_pad
gst_element_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
gst_element_add_ghost_pad
gst_element_connect
gst_element_set_state
gst_element_error
gst_element_get_factory
gst_element_destroy
gst_element_save_thyself
gst_element_load_thyself
gst_elementfactory_new
gst_elementfactory_register
gst_elementfactory_add_sink
gst_elementfactory_add_src
gst_elementfactory_destroy
gst_elementfactory_add_padtemplate
gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_can_src_caps
gst_elementfactory_can_sink_caps
gst_elementfactory_create
gst_elementfactory_make
gst_elementfactory_save_thyself
gst_elementfactory_load_thyself
gst_element_loopfunc_wrapper
<SUBSECTION Standard>
GstElementClass
GST_TYPE_ELEMENT
......@@ -194,6 +212,7 @@ gst_element_get_type
<FILE>gstfilter</FILE>
<TITLE>GstFilter</TITLE>
GstFilter
GST_FILTER_FLAG_LAST
gst_filter_new
<SUBSECTION Standard>
GstFilterClass
......@@ -246,6 +265,7 @@ GST_META
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GST_OBJECT_FLAG_LAST
GstObject
GST_FLAGS
GST_FLAG_IS_SET
......@@ -279,24 +299,32 @@ GST_PAD_CONNECTED
GST_PAD_CAN_PULL
GstPad
GstPadChainFunction
GstPadGetFunction
GstPadGetRegionFunction
GstPadQoSFunction
GstPadPushFunction
GstPadPullFunction
GstPadPullRegionFunction
GstPadPushFunction
GstPadQoSFunction
GstPadDirection
GstPadFlags
gst_pad_new
gst_pad_destroy
gst_pad_new_from_template
gst_pad_get_direction
gst_pad_set_chain_function
gst_pad_set_pull_function
gst_pad_get_type_id
gst_pad_set_type_id
gst_pad_set_get_function
gst_pad_set_getregion_function
gst_pad_set_qos_function
gst_pad_set_caps
gst_pad_get_caps
gst_pad_set_name
gst_pad_get_name
gst_pad_set_parent
gst_pad_get_parent
gst_pad_add_ghost_parent
gst_pad_remove_ghost_parent
gst_pad_get_parent
gst_pad_get_ghost_parents
gst_pad_get_peer
gst_pad_connect
......@@ -304,10 +332,25 @@ gst_pad_disconnect
gst_pad_push
gst_pad_pull
gst_pad_pull_region
gst_pad_set_qos_function
gst_pad_pullregion
gst_pad_handle_qos
gst_pad_save_thyself
gst_pad_load_and_connect
GstPadFactoryEntry
GstPadFactory[]
GST_PAD_FACTORY_SOMETIMES
GST_PAD_FACTORY_ALWAYS
GST_PAD_FACTORY_SINK
GST_PAD_FACTORY_SRC
GstPadPresence
GstPadTemplate
gst_padtemplate_new
gst_padtemplate_create
gst_padtemplate_load_thyself
gst_padtemplate_save_thyself
<SUBSECTION Standard>
GstPadClass
GST_TYPE_PAD
......@@ -316,6 +359,14 @@ GST_PAD_CLASS
GST_IS_PAD
GST_IS_PAD_CLASS
gst_pad_get_type
GstPadTemplateClass
GST_TYPE_PADTEMPLATE
GST_PADTEMPLATE
GST_PADTEMPLATE_CLASS
GST_IS_PADTEMPLATE
GST_IS_PADTEMPLATE_CLASS
gst_padtemplate_get_type
</SECTION>
<SECTION>
......@@ -339,6 +390,23 @@ GST_IS_PIPELINE_CLASS
gst_pipeline_details
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
GST_AUTOPLUG_MAX_COST
GstAutoplugCostFunction
GstAutoplugListFunction
gst_autoplug_caps
<SUBSECTION Standard>
GstAutoplug
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
gst_autoplug_get_type
GST_AUTOPLUG_CLASS
GST_IS_AUTOPLUG_CLASS
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
......@@ -349,10 +417,10 @@ gst_plugin_new
gst_plugin_set_longname
gst_plugin_load_all
gst_plugin_load
gst_plugin_add_type
gst_library_load
gst_plugin_load_absolute
gst_library_load
gst_plugin_add_factory
gst_plugin_add_type
gst_plugin_find
gst_plugin_get_list
gst_plugin_find_elementfactory
......@@ -367,6 +435,7 @@ gst_plugin_save_thyself
<FILE>gstsink</FILE>
<TITLE>GstSink</TITLE>
GstSink
GST_SINK_FLAG_LAST
gst_sink_new
<SUBSECTION Standard>
GstSinkClass
......@@ -382,14 +451,9 @@ GST_IS_SINK_CLASS
<FILE>gstsrc</FILE>
<TITLE>GstSrc</TITLE>
GstSrcFlags
GST_SRC_FLAGS
GST_SRC_ASYNC
GST_SRC_SET_FLAGS
GST_SRC_UNSET_FLAGS
GST_SRC_IS_ASYNC
GstSrc
gst_src_signal_eos
gst_src_push
gst_src_push_region
<SUBSECTION Standard>
gst_src_get_type
GstSrcClass
......@@ -461,25 +525,64 @@ GstTypeFactory
gst_type_register
gst_type_find_by_mime
gst_type_find_by_ext
gst_type_add_src
gst_type_add_sink
gst_type_get_srcs
gst_type_get_sinks
gst_type_find_by_id
gst_type_get_list
gst_type_save_thyself
gst_type_get_sink_to_src
gst_type_dump
gst_type_load_thyself
gst_typefactory_load_thyself
gst_typefactory_save_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GstCaps
GstCapsFactoryEntry
GstCapsFactory[]
gst_caps_new
gst_caps_new_with_props
gst_caps_register
gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
gst_caps_save_thyself
gst_caps_load_thyself
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstprops</FILE>
<TITLE>GstProps</TITLE>
GstProps
GstPropsFactoryEntry
GstPropsFactory[]
GST_PROPS_LIST
GST_PROPS_INT
GST_PROPS_INT_RANGE
GST_PROPS_FOURCC
GST_PROPS_FOURCC_INT
GST_PROPS_BOOLEAN
gst_props_register
gst_props_new
gst_props_merge
gst_props_check_compatibility
gst_props_save_thyself
gst_props_load_thyself
<SUBSECTION Standard>
GstPropsEntry
GstPropsListFactory[]
GstPropsId
GST_PROPS_LIST_ID
GST_PROPS_INT_ID
GST_PROPS_INT_RANGE_ID
GST_PROPS_FOURCC_ID
GST_PROPS_BOOL_ID
</SECTION>
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_get_int_arg
gst_util_get_bool_arg
gst_util_get_long_arg
gst_util_get_float_arg
gst_util_get_double_arg
......@@ -497,6 +600,7 @@ GstXML
gst_xml_new
gst_xml_write
gst_xml_get_element
gst_xml_get_topelements
<SUBSECTION Standard>
gst_xml_get_type
GST_XML
......@@ -609,6 +713,7 @@ GST_IS_FAKESINK_CLASS
<TITLE>GstFakeSrc</TITLE>
<SUBSECTION Standard>
GstFakeSrc
GstFakeSrcOutputType
gst_fakesrc_get_type
GstFakeSrcClass
GST_TYPE_FAKESRC
......
......@@ -129,6 +129,14 @@ Indicates the cothread is started
@thread:
<!-- ##### FUNCTION cothread_getcurrent ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cothread_main ##### -->
<para>
......
......@@ -65,3 +65,51 @@ g_print messages.
@args...: arguments
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_SET_STRING ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_ENTER_STRING ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_ENTER ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG_LEAVE ##### -->
<para>
</para>
@format:
@args...:
......@@ -30,6 +30,7 @@ the offset.
</para>
@GST_ASYNCDISKSRC_OPEN:
@GST_ASYNCDISKSRC_FLAG_LAST:
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>
......
......@@ -17,6 +17,15 @@ allowing for deep nesting of predefined sub-pipelines.
</para>
<!-- ##### ENUM GstBinFlags ##### -->
<para>
Flags for a bin
</para>
@GST_BIN_FLAG_MANAGER:
@GST_BIN_FLAG_PREFER_COTHREADS:
@GST_BIN_FLAG_LAST:
<!-- ##### STRUCT GstBin ##### -->
<para>
......@@ -32,6 +41,14 @@ allowing for deep nesting of predefined sub-pipelines.
@Returns:
<!-- ##### MACRO gst_bin_destroy ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_bin_add ##### -->
<para>
......@@ -96,6 +113,14 @@ allowing for deep nesting of predefined sub-pipelines.
@bin:
<!-- ##### FUNCTION gst_bin_schedule ##### -->
<para>
</para>
@bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
......
......@@ -167,11 +167,12 @@ used when data in a stream has been skipped</entry>
</para>
@GST_BUFFER_READONLY:
@GST_BUFFER_EOS:
@GST_BUFFER_ORIGINAL:
@GST_BUFFER_DONTFREE:
@GST_BUFFER_FLUSH:
@GST_BUFFER_READONLY: the buffer is read only
@GST_BUFFER_ORIGINAL: this buffer not a copy
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unref-ed
@GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly
used when data in a stream has been skipped
@GST_BUFFER_EOS: this buffer is the last one in the stream
<!-- ##### STRUCT GstBuffer ##### -->
<para>
......
......@@ -31,6 +31,7 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
</para>
@GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>
......
......@@ -33,79 +33,25 @@ simpler to connect pads of two elements together.
This enum defines the standard states an element may be in. You will normally
use gst_element_set_state() to change the state of an element.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_STATE_NONE_PENDING</entry>
<entry>The element is in the desired state.</entry>
</row>
<row>
<entry>GST_STATE_NULL</entry>
<entry>Reset the state of an element.</entry>
</row>
<row>
<entry>GST_STATE_READY</entry>
<entry>will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
</entry>
</row>
<row>
<entry>GST_STATE_PLAYING</entry>
<entry>means there really is data flowing through the graph.
</entry>
</row>
<row>
<entry>GST_STATE_PAUSED</entry>
<entry>means there really is data flowing
temporary stops the data flow.
</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_STATE_NONE_PENDING:
@GST_STATE_NULL:
@GST_STATE_READY:
@GST_STATE_PLAYING:
@GST_STATE_PAUSED:
@GST_STATE_NONE_PENDING: The element is in the desired state.
@GST_STATE_NULL: Reset the state of an element.
@GST_STATE_READY: will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
@GST_STATE_PLAYING: means there really is data flowing through the graph.
@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
This enum defines the standard return values that an element
can return after a state change.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_STATE_FAILURE</entry>
<entry>the element could not perform the state change</entry>
</row>
<row>
<entry>GST_STATE_SUCCESS</entry>
<entry>the element successfully changed its state</entry>
</row>
<row>
<entry>GST_STATE_ASYNC</entry>
<entry>the element will asynchronously change its state as soon as possible
</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GST_STATE_FAILURE:
@GST_STATE_SUCCESS:
@GST_STATE_ASYNC:
@GST_STATE_FAILURE: the element could not perform the state change
@GST_STATE_SUCCESS: the element successfully changed its state
@GST_STATE_ASYNC: the element will asynchronously change its state as soon as possible
<!-- ##### MACRO GST_STATE ##### -->
<para>
......@@ -123,44 +69,85 @@ This macro returns the currently pending state of the element.
@obj: Element to return the pending state for.
<!-- ##### ENUM GstElementFlags ##### -->
<!-- ##### MACRO GST_STATE_TRANSITION ##### -->
<para>
This enum defines the standard flags that an element
may have.
Returns the state transition this object is going through
</para>
@obj: the Element to return the tate transition for
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_ELEMENT_MULTI_IN</entry>
<entry>the element has multiple input pads</entry>
</row>
<!-- ##### MACRO GST_STATE_NULL_TO_READY ##### -->
<para>
The Element is going from the NULL state to the READY state
</para>
</tbody></tgroup></informaltable>
<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
<para>
The Element is going from the READY state to the PLAYING state
</para>
@GST_ELEMENT_MULTI_IN:
<!-- ##### MACRO GST_STATE_PLAYING_TO_PAUSED ##### -->
<para>
The Element is going from the PLAYING state to the PAUSED state
</para>
<!-- ##### MACRO GST_STATE_PAUSED_TO_PLAYING ##### -->
<para>
The Element is going from the PAUSED state to the PLAYING state
</para>
<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
<para>
The Element is going from the PLAYING state to the READY state
</para>
<!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
<para>
The Element is going from the READY state to the NULL state
</para>
<!-- ##### ENUM GstElementFlags ##### -->
<para>
This enum defines the standard flags that an element
may have.
</para>
@GST_ELEMENT_COMPLEX:
@GST_ELEMENT_DECOUPLED:
@GST_ELEMENT_THREAD_SUGGESTED:
@GST_ELEMENT_NO_SEEK:
@GST_ELEMENT_NEW_LOOPFUNC:
@GST_ELEMENT_COTHREAD_STOPPING:
@GST_ELEMENT_USE_COTHREAD:
@GST_ELEMENT_FLAG_LAST:
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<para>
Query whether this object has multiple input pads.
Queries whether the Element should be placed in a thread
</para>
@obj: Element to query for multiple input pads.
@obj: The element to query
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
<para>