Commit bf8c785f authored by Wim Taymans's avatar Wim Taymans
Browse files

Documentation updates. All standard library objects and standard elements are...

Documentation updates. All standard library objects and standard elements are documented. Modified some of the elemen...

Original commit message from CVS:
Documentation updates. All standard library objects and standard
elements are documented. Modified some of the elements to more
accuratly report about their arguments so the documentation builds
more reasonable output.
Added aviencoder and jpegencoder elements (not working yet)
parent 53b9cea3
SUBDIRS =
if HAVE_GTK_DOC
SUBDIRS += gst manual
SUBDIRS += gst
endif
DIST_SUBDIRS = gst manual
DIST_SUBDIRS = gst
#EXTRA_DIST = random slides
EXTRA_DIST = random slides
......@@ -10,34 +10,51 @@ DOC_MAIN_SGML_FILE=gstreamer-docs.sgml
DOC_SOURCE_DIR=$(top_srcdir)/gst
CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir)
LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la
LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la $(top_srcdir)/gst/elements/libgstelements.la
HTML_DIR=$(datadir)/gstreamer/gst/html
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \
tmpl/gst.sgml \
tmpl/gstbin.sgml \
tmpl/gstbuffer.sgml \
tmpl/gstconnection.sgml \
tmpl/gstelement.sgml \
tmpl/gstfilter.sgml \
tmpl/gstmeta.sgml \
tmpl/gstobject.sgml \
tmpl/gstpad.sgml \
tmpl/gstpipeline.sgml \
tmpl/gstplugin.sgml \
tmpl/gstqueue.sgml \
tmpl/gstsink.sgml \
tmpl/gstsrc.sgml \
tmpl/gsttee.sgml \
tmpl/gstthread.sgml \
tmpl/gsttrace.sgml \
tmpl/gsttype.sgml \
tmpl/gstutils.sgml \
tmpl/gstxml.sgml \
tmpl/plugin.sgml
tmpl/audioraw.sgml \
tmpl/cothreads.sgml \
tmpl/gst.sgml \
tmpl/gstasyncdisksrc.sgml \
tmpl/gstaudiosink.sgml \
tmpl/gstaudiosrc.sgml \
tmpl/gstbin.sgml \
tmpl/gstbuffer.sgml \
tmpl/gstconnection.sgml \
tmpl/gstdisksrc.sgml \
tmpl/gstelement.sgml \
tmpl/gstesdsink.sgml \
tmpl/gstfakesink.sgml \
tmpl/gstfakesrc.sgml \
tmpl/gstfdsink.sgml \
tmpl/gstfdsrc.sgml \
tmpl/gstfilter.sgml \
tmpl/gsthttpsrc.sgml \
tmpl/gstidentity.sgml \
tmpl/gstlog.sgml \
tmpl/gstmeta.sgml \
tmpl/gstobject.sgml \
tmpl/gstpad.sgml \
tmpl/gstpipeline.sgml \
tmpl/gstplugin.sgml \
tmpl/gstqueue.sgml \
tmpl/gstreamer-unused.sgml \
tmpl/gstsinesrc.sgml \
tmpl/gstsink.sgml \
tmpl/gstsrc.sgml \
tmpl/gsttee.sgml \
tmpl/gstthread.sgml \
tmpl/gsttrace.sgml \
tmpl/gsttype.sgml \
tmpl/gstutils.sgml \
tmpl/gstxml.sgml \
tmpl/spectrum.sgml \
tmpl/videoraw.sgml
gstreamer_docdir = $(HTML_DIR)
gstreamer_doc_DATA = \
......@@ -65,6 +82,9 @@ html/book1.html: sgml/gstreamer-doc.bottom
sgml/gstreamer-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
gstreamer-decl.txt:
$(MAKE) scan
scanobj:
env CC="$(LIBTOOL) --mode=link $(CC)" CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" \
gtkdoc-scanobj --module=$(DOC_MODULE) \
......@@ -73,10 +93,10 @@ scanobj:
scan:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gsttypefind.h"
tmpl: scan
tmpl: scanobj scan
gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
sgml: tmpl
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
......@@ -84,7 +104,7 @@ html:
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *.signals *-unused.txt
rm -f *~ *.bak *.signals *-unused.txt *.args
maintainer-clean-local: clean
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
......
This diff is collapsed.
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
<!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstConnection SYSTEM "sgml/gstconnection.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstFilter SYSTEM "sgml/gstfilter.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
<!entity GstMeta SYSTEM "sgml/gstmeta.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstSrc SYSTEM "sgml/gstsrc.sgml">
<!entity GstSink SYSTEM "sgml/gstsink.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity gstreamer-gsttype SYSTEM "sgml/gsttype.sgml">
<!entity gstreamer-gstmeta SYSTEM "sgml/gstmeta.sgml">
<!entity gstreamer-gstutils SYSTEM "sgml/gstutils.sgml">
<!entity gstreamer-gsttrace SYSTEM "sgml/gsttrace.sgml">
<!--
<!entity gstreamer-gstasyncdisksrc SYSTEM "sgml/gstasyncdisksrc.sgml">
<!entity gstreamer-gstaudiosink SYSTEM "sgml/gstaudiosink.sgml">
<!entity gstreamer-gstdisksrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity gstreamer-gstesdsink SYSTEM "sgml/gstesdsink.sgml">
<!entity gstreamer-gstfakefilter SYSTEM "sgml/gstfakefilter.sgml">
<!entity gstreamer-gstfakesink SYSTEM "sgml/gstfakesink.sgml">
<!entity gstreamer-gstfakesrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity gstreamer-gstfdsink SYSTEM "sgml/gstfdsink.sgml">
<!entity gstreamer-gstfdsrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity gstreamer-gsthttpsrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity gstreamer-gsttee SYSTEM "sgml/gsttee.sgml">
<!entity gstreamer-spectrum SYSTEM "sgml/spectrum.sgml">
<!entity gstreamer-audioraw SYSTEM "sgml/audioraw.sgml">
-->
<!entity GstSink SYSTEM "sgml/gstsink.sgml">
<!entity GstSrc SYSTEM "sgml/gstsrc.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">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity GstAsyncDiskSrc SYSTEM "sgml/gstasyncdisksrc.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
<!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml">
<!entity GstEsdSink SYSTEM "sgml/gstesdsink.sgml">
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
<!entity videoraw SYSTEM "sgml/videoraw.sgml">
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
]>
......@@ -61,38 +69,85 @@ with some more specialized elements.</para>
&GstSrc;
&GstBuffer;
&GstPad;
&GstConnection;
&GstPlugin;
&gstreamer-gsttype;
&gstreamer-gstmeta;
&gstreamer-gstutils;
&gstreamer-gsttrace;
&GstThread;
&GstTee;
&GstType;
&GstMeta;
&GstUtils;
&GstTrace;
&GstXml;
</chapter>
<!--
<chapter id="element-types">
<title>GStreamer Element</title>
<title>GStreamer Standard Elements</title>
<para>
libgstelements.la provide some basic elements like a disk source
and sink. The use of these elements is strictly though the gtk_object_get() and
gtk_object_set() functions and the GStreamer Core Library functions.
</para>
<para>
Use the gst_elementfactory_find() and gst_elementfactory_create() functions
to create these elements.
</para>
<para>
The following code example shows you how to create a GstDiskSrc element.
</para>
<para>
<programlisting role="C">
#include &lt;gst/gst.h&gt;
GstElement *src;
GstElementFactory *srcfactory;
gst_init(&amp;argc,&amp;argv);
srcfactory = gst_elementfactory_find("disksrc");
g_return_if_fail(srcfactory != NULL);
src = gst_elementfactory_create(srcfactory,"src");
g_return_if_fail(src != NULL);
...
</programlisting>
</para>
&GstFakeSrc;
&GstFakeSink;
&GstDiskSrc;
&GstAsyncDiskSrc;
&GstHttpSrc;
&GstFdSrc;
&GstAudioSrc;
&GstSineSrc;
&GstAudioSink;
&GstFdSink;
&GstIdentity;
&GstQueue;
</chapter>
<chapter id="metatdata-types">
<title>GStreamer MetaData Types</title>
<para>MetaData is used to specify the content of buffers. See <classname>GstMeta</classname>. </para>
&spectrum;
&audioraw;
&videoraw;
</chapter>
&gstreamer-gstfakesrc;
&gstreamer-gstdisksrc;
&gstreamer-gstasyncdisksrc;
&gstreamer-gsthttpsrc;
&gstreamer-gstfdsrc;
<chapter id="plugins">
<title>GStreamer Multimedia Plugins</title>
&gstreamer-gstaudiosink;
&gstreamer-gstesdsink;
&gstreamer-gstfdsink;
&gstreamer-gstfakesink;
<para>GStreamer has some advanced multimedia plugins. </para>
&gstreamer-gstfakefilter;
&gstreamer-spectrum;
&gstreamer-audioraw;
&gstreamer-gsttee;
&gstreamer-gsttypeaudio;
</chapter>
-->
<chapter id="gst-index">
<title>Index</title>
......
<INCLUDE>gst/gst.h</INCLUDE>
<SECTION>
<FILE>gstobject</FILE>
GstObject
<TITLE>GstObject</TITLE>
GST_FLAGS
GST_FLAG_IS_SET
GST_FLAG_SET
GST_FLAG_UNSET
GST_LOCK
GST_TRYLOCK
GST_UNLOCK
gst_object_new
gst_object_set_parent
gst_object_get_parent
gst_object_unparent
gst_object_ref
gst_object_unref
gst_object_sink
gst_object_destroy
<FILE>cothreads</FILE>
COTHREAD_STACKSIZE
COTHREAD_MAXTHREADS
STACK_SIZE
CURRENT_STACK_FRAME
cothread_state
cothread_context
cothread_func
COTHREAD_STARTED
cothread_init
cothread_create
cothread_setfunc
cothread_switch
cothread_main
<SUBSECTION Standard>
gst_object_get_type
GST_TYPE_OBJECT
GST_IS_OBJECT
GST_OBJECT_CLASS
GST_IS_OBJECT_CLASS
</SECTION>
<SECTION>
<FILE>gstelement</FILE>
GstElement
GstElementState
GST_STATE
GST_STATE_IS_SET
GST_STATE_SET
GST_STATE_UNSET
GstElementDetails
GstElementFactory
GstElementLoopFunction
<TITLE>GstElement</TITLE>
gst_element_new
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_connect
gst_element_set_state
gst_element_error
gst_element_change_state
gst_element_destroy
gst_element_save_thyself
gst_elementfactory_new
gst_elementfactory_register
gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_create
gst_elementfactory_make
gst_element_loopfunc_wrapper
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
gst_init
DEBUG
<SUBSECTION Standard>
gst_element_get_type
GST_TYPE_ELEMENT
GST_IS_ELEMENT
GST_ELEMENT_CLASS
GST_IS_ELEMENT_CLASS
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
GST_BIN
<TITLE>GstBin</TITLE>
GstBin
gst_bin_new
gst_bin_add
gst_bin_remove
......@@ -81,17 +39,20 @@ gst_bin_set_state_type
gst_bin_iterate
gst_bin_create_plan
<SUBSECTION Standard>
GST_TYPE_BIN
GST_IS_BIN
GstBinClass
gst_bin_get_type
GST_TYPE_BIN
GST_BIN
GST_BIN_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
</SECTION>
<SECTION>
<FILE>gstbuffer</FILE>
GST_BUFFER
<TITLE>GstBuffer</TITLE>
GST_BUFFER_FLAGS
GST_BUFFER_FLAG_IS_SET
GST_BUFFER_FLAG_SET
GST_BUFFER_FLAG_UNSET
GST_BUFFER_TYPE
......@@ -116,40 +77,96 @@ gst_buffer_get_first_meta
gst_buffer_get_metas
gst_buffer_remove_meta
<SUBSECTION Standard>
GST_BUFFER_FLAG_IS_SET
GST_BUFFER
</SECTION>
<SECTION>
<FILE>gstconnection</FILE>
GST_CONNECTION
<TITLE>GstConnection</TITLE>
GstConnection
gst_connection_new
gst_connection_push
<SUBSECTION Standard>
GST_TYPE_CONNECTION
GST_IS_CONNECTION
gst_connection_get_type
GST_CONNECTION
GST_CONNECTION_CLASS
GST_IS_CONNECTION
GST_IS_CONNECTION_CLASS
GstConnectionClass
</SECTION>
<SECTION>
<FILE>gstelement</FILE>
<TITLE>GstElement</TITLE>
GstElementState
GST_STATE
GST_STATE_IS_SET
GST_STATE_SET
GST_STATE_UNSET
GstElement
GstElementDetails
GstElementFactory
GstElementLoopFunction
gst_element_new
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_connect
gst_element_set_state
gst_element_error
gst_element_change_state
gst_element_destroy
gst_element_save_thyself
gst_elementfactory_new
gst_elementfactory_register
gst_elementfactory_find
gst_elementfactory_get_list
gst_elementfactory_create
gst_elementfactory_make
gst_element_loopfunc_wrapper
<SUBSECTION Standard>
GstElementClass
GST_TYPE_ELEMENT
GST_ELEMENT
GST_ELEMENT_CLASS
GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
</SECTION>
<SECTION>
<FILE>gstfilter</FILE>
GST_FILTER
<TITLE>GstFilter</TITLE>
GstFilter
gst_filter_new
<SUBSECTION Standard>
GST_TYPE_FILTER
GST_IS_FILTER
GstFilterClass
gst_filter_get_type
GST_TYPE_FILTER
GST_FILTER
GST_FILTER_CLASS
GST_IS_FILTER
GST_IS_FILTER_CLASS
</SECTION>
<SECTION>
<FILE>gstlog</FILE>
GST_SHOW_INFO
gst_info
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstmeta</FILE>
GST_META
GST_META_FLAGS
GST_META_FLAG_IS_SET
GST_META_FLAG_SET
GST_META_FLAG_UNSET
GstMetaFlags
......@@ -159,26 +176,57 @@ gst_meta_new
gst_meta_ref
gst_meta_unref
<SUBSECTION Standard>
GST_META_FLAG_IS_SET
GST_META
</SECTION>
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GstObject
GST_FLAGS
GST_FLAG_IS_SET
GST_FLAG_SET
GST_FLAG_UNSET
GST_LOCK
GST_TRYLOCK
GST_UNLOCK
gst_object_new
gst_object_set_parent
gst_object_get_parent
gst_object_unparent
gst_object_ref
gst_object_unref
gst_object_sink
gst_object_destroy
<SUBSECTION Standard>
gst_object_get_type
GstObjectClass
GST_TYPE_OBJECT
GST_OBJECT
GST_OBJECT_CLASS
GST_IS_OBJECT
GST_IS_OBJECT_CLASS
</SECTION>
<SECTION>
<FILE>gstpad</FILE>
GST_PAD
<TITLE>GstPad</TITLE>
GST_PAD_CONNECTED
GST_PAD_CAN_PULL
GstPad
GstPadChainFunction
GstPadPullFunction
GstPadPushFunction
GstPadDirection
<TITLE>GstPad</TITLE>
gst_pad_new
gst_pad_destroy
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_name
gst_pad_get_name
gst_pad_get_directory
gst_pad_set_parent
gst_pad_add_ghost_parent
gst_pad_remove_ghost_parent
......@@ -190,381 +238,362 @@ gst_pad_push
gst_pad_pull
gst_pad_save_thyself
<SUBSECTION Standard>
GstPadClass
GST_TYPE_PAD
GST_IS_PAD
gst_pad_get_type
GST_PAD
GST_PAD_CLASS
GST_IS_PAD
GST_IS_PAD_CLASS
gst_pad_get_type
</SECTION>
<SECTION>
<FILE>gstpipeline</FILE>
GstPipeline
<TITLE>GstPipeline</TITLE>
GstPipeline
gst_pipeline_new
gst_pipeline_destroy
gst_pipeline_iterate
<SUBSECTION Standard>
GstPipelineClass
gst_pipeline_get_type
GST_TYPE_PIPELINE
GST_IS_PIPELINE
GST_PIPELINE
GST_PIPELINE_CLASS
GST_IS_PIPELINE
GST_IS_PIPELINE_CLASS
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
<TITLE>GstPlugin</TITLE>
GstPlugin
GstPluginElement
GstPluginInitFunc
gst_plugin_new
gst_plugin_set_longname
gst_plugin_load_all
gst_plugin_load
gst_library_load
gst_plugin_load_absolute
gst_plugin_add_factory
gst_plugin_find
gst_plugin_get_list
gst_plugin_find_elementfactory
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstsink</FILE>
GST_SINK
<TITLE>GstSink</TITLE>
GstSink
gst_sink_new
<SUBSECTION Standard>
GST_TYPE_SINK
GST_IS_SINK