Skip to content

GitLab

Commit 9b3f1277 authored by Wim Taymans's avatar Wim Taymans
Browse files
Options

API docs updates 

Original commit message from CVS:
API docs updates
parent 74f80508
Hide whitespace changes
Inline Side-by-side
Showing with 573 additions and 126 deletions
docs/gst/Makefile.am
View file @ 9b3f1277
......@@ -13,6 +13,9 @@ EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt $
HTML_DIR=$(datadir)/gstreamer/html
GST_LIBS += ../../gst/elements/libgstelements.la
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \
......@@ -85,7 +88,9 @@ gstreamer-decl.txt:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
scanobj: $(srcdir)/$(DOC_MODULE).types
-CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE)
rm gstreamer-scan.o; ln -s gstreamer-scan.lo gstreamer-scan.o
env CC="$(LIBTOOL) $(CC)" CFLAGS="$(GST_CFLAGS) $(GLIB_CFLAGS) $(XML_CFLAGS) -I../../" LDFLAGS="$(GST_LIBS)"\
gtkdoc-scanobj --module=$(DOC_MODULE)
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
tmpl: scanobj gstreamer-decl.txt
......
docs/gst/gstreamer-docs.sgml
View file @ 9b3f1277
......@@ -15,7 +15,6 @@
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml">
......@@ -23,6 +22,8 @@
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
......@@ -37,8 +38,7 @@
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
......@@ -72,7 +72,8 @@ with some more specialized elements.</para>
&GstPad;
&GstPlugin;
&GstThread;
&GstTee;
&GstQueue;
&GstTypeFind;
&GstType;
&GstCaps;
......@@ -136,9 +137,8 @@ with some more specialized elements.</para>
&GstPipefilter;
&GstIdentity;
&GstQueue;
&GstTypeFind;
&GstTee;
</chapter>
<chapter id="metatdata-types">
......
docs/gst/gstreamer-sections.txt
View file @ 9b3f1277
......@@ -19,10 +19,6 @@ cothread_main
cothread_set_data
cothread_get_data
<SUBSECTION Standard>
SETUP_STACK
GET_SP
JUMP
SET_SP
</SECTION>
<SECTION>
......@@ -36,7 +32,7 @@ gst_main_quit
<SECTION>
<FILE>gstinfo</FILE>
<TITLE>gstinfo</TITLE>
<TITLE>GstInfo</TITLE>
gst_get_category_name
gst_info_get_categories
gst_info_set_categories
......@@ -109,9 +105,24 @@ GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
gst_bin_use_cothreads
gst_bin_remove_eos_provider
gst_bin_add_eos_provider
_GstBinChain
</SECTION>
<SECTION>
<FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
gst_parse_launch
</SECTION>
<SECTION>
<FILE>gstarch</FILE>
GST_ARCH_CALL
GST_ARCH_SET_SP
GST_ARCH_SETUP_STACK
</SECTION>
<SECTION>
<FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
......@@ -193,8 +204,11 @@ gst_element_add_pad
gst_element_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
gst_element_get_padtemplate_by_name
gst_element_add_ghost_pad
gst_element_remove_ghost_pad
gst_element_request_pad
gst_element_request_pad_by_name
gst_element_connect
gst_element_disconnect
gst_element_set_state
......@@ -224,6 +238,7 @@ GST_ELEMENT_CLASS
GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
gst_element_announce_eos
</SECTION>
<SECTION>
......@@ -298,8 +313,17 @@ GST_IS_OBJECT_CLASS
<SECTION>
<FILE>gstpad</FILE>
<TITLE>GstPad</TITLE>
GST_PAD_NAME
GST_PAD_ELEMENT_PRIVATE
GST_PAD_PARENT
GST_PAD_PADTEMPLATE
GST_PAD_REALIZE
GST_PAD_DIRECTION
GST_PAD_CAPS
GST_PAD_PEER
GST_PAD_CONNECTED
GST_PAD_CAN_PULL
GstPad
GstPadChainFunction
GstPadGetFunction
......@@ -328,6 +352,8 @@ gst_pad_get_caps_by_name
gst_pad_check_compatibility
gst_pad_set_name
gst_pad_get_name
gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_set_parent
gst_pad_get_parent
gst_pad_add_ghost_parent
......@@ -348,15 +374,32 @@ gst_pad_eos
gst_pad_save_thyself
gst_pad_load_and_connect
GstRealPad
GST_RPAD_DIRECTION
GST_RPAD_CAPS
GST_RPAD_PEER
GST_RPAD_BUFPEN
GST_RPAD_CHAINFUNC
GST_RPAD_GETFUNC
GST_RPAD_GETREGIONFUNC
GST_RPAD_PUSHFUNC
GST_RPAD_PULLFUNC
GST_RPAD_PULLREGIONFUNC
GST_RPAD_QOSFUNC
GST_RPAD_EOSFUNC
GST_GPAD_REALPAD
GstGhostPad
GstPadFactoryEntry
GstPadFactory[]
GST_PAD_FACTORY_SOMETIMES
GST_PAD_FACTORY_ALWAYS
GST_PAD_FACTORY_REQUEST
GST_PAD_FACTORY_SINK
GST_PAD_FACTORY_SRC
GST_PAD_FACTORY_CAPS
GstPadPresence
GstPadTemplate
gst_padtemplate_new
......@@ -373,6 +416,22 @@ GST_IS_PAD
GST_IS_PAD_CLASS
gst_pad_get_type
GstRealPadClass
GST_TYPE_REAL_PAD
GST_REAL_PAD
GST_REAL_PAD_CLASS
GST_IS_REAL_PAD
GST_IS_REAL_PAD_CLASS
gst_real_pad_get_type
GstGhostPadClass
GST_TYPE_GHOST_PAD
GST_GHOST_PAD
GST_GHOST_PAD_CLASS
GST_IS_GHOST_PAD
GST_IS_GHOST_PAD_CLASS
gst_ghost_pad_get_type
GstPadTemplateClass
GST_TYPE_PADTEMPLATE
GST_PADTEMPLATE
......@@ -456,12 +515,11 @@ gst_plugin_save_thyself
<SECTION>
<FILE>gsttee</FILE>
<TITLE>GstTee</TITLE>
GstTee
gst_tee_new
gst_tee_chain
gst_tee_new_pad
<SUBSECTION Standard>
gst_tee_factory_init
GstTee
gst_tee_get_type
gst_tee_details
GstTeeClass
GST_TYPE_TEE
GST_TEE
......@@ -609,6 +667,8 @@ GST_IS_XML_CLASS
GST_TYPE_XML
GST_XML_CLASS
GstXMLClass
xmlChildrenNode
xmlRootNode
</SECTION>
<SECTION>
......
docs/gst/tmpl/gstarch.sgml 0 → 100644
View file @ 9b3f1277
<!-- ##### SECTION Title ##### -->
gstarch
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_ARCH_CALL ##### -->
<para>
</para>
@target:
<!-- ##### MACRO GST_ARCH_SET_SP ##### -->
<para>
</para>
@stackpointer:
<!-- ##### MACRO GST_ARCH_SETUP_STACK ##### -->
<para>
</para>
@sp:
docs/gst/tmpl/gstelement.sgml
View file @ 9b3f1277
......@@ -289,6 +289,16 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_get_padtemplate_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para>
......@@ -307,6 +317,28 @@ circumstances.
@pad:
<!-- ##### FUNCTION gst_element_request_pad ##### -->
<para>
</para>
@element:
@templ:
@Returns:
<!-- # Unused Parameters # -->
@temp:
<!-- ##### FUNCTION gst_element_request_pad_by_name ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>
......@@ -410,8 +442,9 @@ circumstances.
</para>
@elementfactory:
@temp:
@templ:
<!-- # Unused Parameters # -->
@temp:
@pad:
......
docs/gst/tmpl/gstfakesrc.sgml
View file @ 9b3f1277
......@@ -36,7 +36,7 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### ARG GstFakeSrc:patern ##### -->
<!-- ##### ARG GstFakeSrc:pattern ##### -->
<para>
</para>
......
docs/gst/tmpl/gstidentity.sgml
View file @ 9b3f1277
......@@ -19,3 +19,8 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:sleep_time ##### -->
<para>
</para>
docs/gst/tmpl/gstpad.sgml
View file @ 9b3f1277
......@@ -16,6 +16,71 @@ connections.
</para>
<!-- ##### MACRO GST_PAD_NAME ##### -->
<para>
Get the name of the pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_ELEMENT_PRIVATE ##### -->
<para>
Get the private data set by the element that owns the pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PARENT ##### -->
<para>
Get the parent element of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PADTEMPLATE ##### -->
<para>
Get the padtemplate that was used to create this pad. NULL if no padtemplate
was used.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_REALIZE ##### -->
<para>
Return the real pad of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_DIRECTION ##### -->
<para>
Get the pad direction.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_CAPS ##### -->
<para>
Get the capabilities of a pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_PEER ##### -->
<para>
Get the peerpad of this pad.
</para>
@pad: the pad to query
<!-- ##### MACRO GST_PAD_CONNECTED ##### -->
<para>
Is this pad connected.
......@@ -156,9 +221,11 @@ Destroy the pad.
</para>
@temp:
@templ:
@name:
@Returns:
<!-- # Unused Parameters # -->
@temp:
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
......@@ -271,6 +338,24 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_set_element_private ##### -->
<para>
</para>
@pad:
@priv:
<!-- ##### FUNCTION gst_pad_get_element_private ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_parent ##### -->
<para>
......@@ -447,6 +532,139 @@ Destroy the pad.
@elements:
<!-- ##### STRUCT GstRealPad ##### -->
<para>
</para>
@pad:
@caps:
@direction:
@threadstate:
@peer:
@bufpen:
@chainfunc:
@getfunc:
@getregionfunc:
@qosfunc:
@eosfunc:
@pushfunc:
@pullfunc:
@pullregionfunc:
@ghostparents:
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
<para>
Get the direction of the real pad.
</para>
@pad: the realpad to query.
<!-- ##### MACRO GST_RPAD_CAPS ##### -->
<para>
Get the caps of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PEER ##### -->
<para>
Get the peer element of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_BUFPEN ##### -->
<para>
Get the bufpen of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_CHAINFUNC ##### -->
<para>
Get the chain function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
<para>
Get get getfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_GETREGIONFUNC ##### -->
<para>
Get the getregion function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PUSHFUNC ##### -->
<para>
Get the pushfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PULLFUNC ##### -->
<para>
Get the pullfunction of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_PULLREGIONFUNC ##### -->
<para>
Get the pullregion function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_QOSFUNC ##### -->
<para>
Get the QoS function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_EOSFUNC ##### -->
<para>
Get the EOS function of the real pad.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
<para>
Get the real pad of this ghost pad.
</para>
@pad: the real pad to query.
<!-- ##### STRUCT GstGhostPad ##### -->
<para>
</para>
@pad:
@realpad:
<!-- ##### TYPEDEF GstPadFactoryEntry ##### -->
<para>
Defines an entry for a padfactory.
......@@ -475,6 +693,14 @@ Use this in the factory definition.
<!-- ##### MACRO GST_PAD_FACTORY_REQUEST ##### -->
<para>
Indicates that this pad will be available on request. Use
this in the factory definition.
</para>
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para>
Indicates a sinkpad for the padfactory.
......@@ -504,6 +730,7 @@ Indicates when this pad will become available.
@GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
@GST_PAD_REQUEST:
<!-- ##### STRUCT GstPadTemplate ##### -->
<para>
......@@ -551,13 +778,10 @@ Indicates when this pad will become available.
</para>
@pad:
@templ:
@parent:
@Returns:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>
docs/gst/tmpl/gstparse.sgml 0 → 100644
View file @ 9b3f1277
<!-- ##### SECTION Title ##### -->
GstParse
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>