Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...

Original commit message from CVS:
Re- set up the gtk-doc system.  I'd managed to mutilate it a while back,
but now it's fixed.  I'll put a copy of the HTML output somewhere on the
website tonight.

In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs.  (see
http://developer.gnome.org/arch/doc/tools.html)

Notes (I'll codify these some day):

- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file.  However, gtk-doc's merge and CVS's diff are
two entirely separate animals.  We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book.  There'd be another called docs/manual/, and
another docs/plugins/, etc.  If you have any comments as to how these
should be done, gstreamer-devel is the place.
This commit is contained in:
Erik Walthinsen 2000-02-01 09:16:43 +00:00
parent dc38347cee
commit 56a79fbfcc
32 changed files with 5582 additions and 0 deletions

View file

@ -291,6 +291,7 @@ test/cothreads/Makefile
editor/Makefile
tools/Makefile
docs/Makefile
docs/gst/Makefile
stamp.h
gstreamer-config
gstreamer.spec])

View file

@ -1 +1,3 @@
SUBDIRS = gst
#EXTRA_DIST = random slides

6
docs/gst/.gitignore vendored Normal file
View file

@ -0,0 +1,6 @@
Makefile
Makefile.in
html
sgml
gstreamer.signals
gstreamer.html

77
docs/gst/Makefile.am Normal file
View file

@ -0,0 +1,77 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=gstreamer
# The top-level SGML file.
DOC_MAIN_SGML_FILE=gstreamer-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/gst
CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir)
LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.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 \
SCANOBJS_FILES = \
$(DOC_MODULE).signals \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).args
scanobj:
env CC="$(LIBTOOL) --mode=link $(CC)" CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" \
gtkdoc-scanobj --module=$(DOC_MODULE) \
--types=$(srcdir)/$(DOC_MODULE).types
scan:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gsttypefind.h"
tmpl: scan
gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
if ! test -d html ; then mkdir html ; fi
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt
maintainer-clean-local: clean
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
install -d -m 0755 $(TARGET_DIR)
install -m 0644 html/*.html $(TARGET_DIR)
install -m 0644 html/index.sgml $(TARGET_DIR)
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)
.PHONY : html sgml templates scan

2530
docs/gst/gstreamer-decl.txt Normal file

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,105 @@
<!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 GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstFilter SYSTEM "sgml/gstfilter.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.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 gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
]>
<book>
<bookinfo>
<title>GStreamer Library Reference Manual</title>
</bookinfo>
<chapter id="gstreamer">
<title>GStreamer Core Library</title>
<para>libgst.la provides all the core GStreamer services,
including initialization, plugin management, types and metadata, as
well as the object hiarchy that defines elements and bins, along
with some more specialized elements.</para>
&Gst;
&GstObject;
&GstElement;
&GstBin;
&GstPipeline;
&GstFilter;
&GstSink;
&GstSrc;
&GstBuffer;
&GstPad;
&GstPlugin;
&gstreamer-gsttype;
&gstreamer-gstmeta;
&gstreamer-gstutils;
&gstreamer-gsttrace;
</chapter>
<!--
<chapter id="element-types">
<title>GStreamer Element</title>
&gstreamer-gstfakesrc;
&gstreamer-gstdisksrc;
&gstreamer-gstasyncdisksrc;
&gstreamer-gsthttpsrc;
&gstreamer-gstfdsrc;
&gstreamer-gstaudiosink;
&gstreamer-gstesdsink;
&gstreamer-gstfdsink;
&gstreamer-gstfakesink;
&gstreamer-gstfakefilter;
&gstreamer-spectrum;
&gstreamer-audioraw;
&gstreamer-gsttee;
&gstreamer-gsttypeaudio;
</chapter>
-->
<chapter id="gst-index">
<title>Index</title>
<sect1>
<title>Object Hierarchy</title>
&gstreamer-tree-index;
</sect1>
</chapter>
</book>

View file

@ -0,0 +1,577 @@
<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
<SUBSECTION Standard>
gst_object_get_type
GST_TYPE_OBJECT
GST_IS_OBJECT
GST_OBJECT_CLASS
GST_IS_OBJECT_CLASS
</SECTION>
<SECTION>
<FILE>gstbin</FILE>
GST_BIN
<TITLE>GstBin</TITLE>
gst_bin_new
gst_bin_add
gst_bin_remove
gst_bin_get_by_name
gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
gst_bin_create_plan
<SUBSECTION Standard>
GST_TYPE_BIN
GST_IS_BIN
gst_bin_get_type
GST_BIN_CLASS
GST_IS_BIN_CLASS
</SECTION>
<SECTION>
<FILE>gstbuffer</FILE>
GST_BUFFER
GST_BUFFER_FLAGS
GST_BUFFER_FLAG_SET
GST_BUFFER_FLAG_UNSET
GST_BUFFER_TYPE
GST_BUFFER_DATA
GST_BUFFER_SIZE
GST_BUFFER_OFFSET
GST_BUFFER_MAXSIZE
GST_BUFFER_TIMESTAMP
GST_BUFFER_LOCK
GST_BUFFER_TRYLOCK
GST_BUFFER_UNLOCK
GstBufferFlags
GstBuffer
gst_buffer_new
gst_buffer_create_sub
gst_buffer_ref
gst_buffer_ref_by_count
gst_buffer_unref
gst_buffer_destroy
gst_buffer_add_meta
gst_buffer_get_first_meta
gst_buffer_get_metas
gst_buffer_remove_meta
<SUBSECTION Standard>
GST_BUFFER_FLAG_IS_SET
</SECTION>
<SECTION>
<FILE>gstconnection</FILE>
GST_CONNECTION
<TITLE>GstConnection</TITLE>
gst_connection_new
gst_connection_push
<SUBSECTION Standard>
GST_TYPE_CONNECTION
GST_IS_CONNECTION
gst_connection_get_type
GST_CONNECTION_CLASS
GST_IS_CONNECTION_CLASS
</SECTION>
<SECTION>
<FILE>gstelement</FILE>
GstElementState
GST_STATE
GST_STATE_IS_SET
GST_STATE_SET
GST_STATE_UNSET
GST_ELEMENT
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
<SUBSECTION Standard>
GST_TYPE_ELEMENT
GST_IS_ELEMENT
gst_element_get_type
GST_ELEMENT_CLASS
GST_IS_ELEMENT_CLASS
</SECTION>
<SECTION>
<FILE>gstfilter</FILE>
GST_FILTER
<TITLE>GstFilter</TITLE>
gst_filter_new
<SUBSECTION Standard>
GST_TYPE_FILTER
GST_IS_FILTER
gst_filter_get_type
GST_FILTER_CLASS
GST_IS_FILTER_CLASS
</SECTION>
<SECTION>
<FILE>gstmeta</FILE>
GST_META
GST_META_FLAGS
GST_META_FLAG_SET
GST_META_FLAG_UNSET
GstMetaFlags
GstMeta
gst_meta_new_size
gst_meta_new
gst_meta_ref
gst_meta_unref
<SUBSECTION Standard>
GST_META_FLAG_IS_SET
</SECTION>
<SECTION>
<FILE>gstpad</FILE>
GST_PAD
GST_PAD_CONNECTED
GstPadChainFunction
GstPadPushFunction
GstPadDirection
<TITLE>GstPad</TITLE>
gst_pad_new
gst_pad_destroy
gst_pad_get_direction
gst_pad_set_chain_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
gst_pad_get_parent
gst_pad_get_ghost_parents
gst_pad_get_peer
gst_pad_connect
gst_pad_push
gst_pad_pull
gst_pad_save_thyself
<SUBSECTION Standard>
GST_TYPE_PAD
GST_IS_PAD
gst_pad_get_type
GST_PAD_CLASS
GST_IS_PAD_CLASS
</SECTION>
<SECTION>
<FILE>gstpipeline</FILE>
GST_PIPELINE
<TITLE>GstPipeline</TITLE>
gst_pipeline_new
gst_pipeline_destroy
gst_pipeline_iterate
<SUBSECTION Standard>
GST_TYPE_PIPELINE
GST_IS_PIPELINE
gst_pipeline_get_type
GST_PIPELINE_CLASS
GST_IS_PIPELINE_CLASS
</SECTION>
<SECTION>
<FILE>gstsink</FILE>
GST_SINK
<TITLE>GstSink</TITLE>
gst_sink_new
<SUBSECTION Standard>
GST_TYPE_SINK
GST_IS_SINK
gst_sink_get_type
GST_SINK_CLASS
GST_IS_SINK_CLASS
</SECTION>
<SECTION>
<FILE>gstsrc</FILE>
GST_SRC
GstSrcFlags
GST_SRC_FLAGS
GST_SRC_ASYNC
<TITLE>GstSrc</TITLE>
GST_SRC_SET_FLAGS
GST_SRC_UNSET_FLAGS
gst_src_signal_eos
gst_src_push
gst_src_push_region
<SUBSECTION Standard>
GST_TYPE_SRC
GST_IS_SRC
gst_src_get_type
GST_SRC_CLASS
GST_IS_SRC_CLASS
</SECTION>
<SECTION>
<FILE>gsttee</FILE>
GST_TEE
<TITLE>GstTee</TITLE>
gst_tee_new
gst_tee_chain
gst_tee_new_pad
<SUBSECTION Standard>
GST_TYPE_TEE
GST_IS_TEE
gst_tee_get_type
GST_TEE_CLASS
GST_IS_TEE_CLASS
</SECTION>
<SECTION>
<FILE>gstthread</FILE>
GstThreadState
GST_THREAD
<TITLE>GstThread</TITLE>
gst_thread_new
gst_thread_main_loop
gst_thread_iterate
<SUBSECTION Standard>
GST_TYPE_THREAD
GST_IS_THREAD
gst_thread_get_type
GST_THREAD_CLASS
GST_IS_THREAD_CLASS
</SECTION>
<SECTION>
<FILE>gstasyncdisksrc</FILE>
GST_ASYNCDISKSRC
GstAsyncDiskSrcFlags
<TITLE>GstAsyncDiskSrc</TITLE>
<SUBSECTION Standard>
GST_TYPE_ASYNCDISKSRC
GST_IS_ASYNCDISKSRC
gst_asyncdisksrc_get_type
GST_ASYNCDISKSRC_CLASS
GST_IS_ASYNCDISKSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosink</FILE>
GST_AUDIOSINK
<TITLE>GstAudioSink</TITLE>
gst_audiosink_new
gst_audiosink_chain
gst_audiosink_sync_parms
gst_audiosink_set_format
gst_audiosink_set_channels
gst_audiosink_set_frequency
<SUBSECTION Standard>
GST_TYPE_AUDIOSINK
GST_IS_AUDIOSINK
gst_audiosink_get_type
GST_AUDIOSINK_CLASS
GST_IS_AUDIOSINK_CLASS
</SECTION>
<SECTION>
<FILE>gstaudiosrc</FILE>
GST_AUDIOSRC
<TITLE>GstAudioSrc</TITLE>
gst_audiosrc_new
gst_audiosrc_push
<SUBSECTION Standard>
GST_TYPE_AUDIOSRC
GST_IS_AUDIOSRC
gst_audiosrc_get_type
GST_AUDIOSRC_CLASS
GST_IS_AUDIOSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstdisksrc</FILE>
GST_DISKSRC
GstDiskSrcFlags
<TITLE>GstDiskSrc</TITLE>
<SUBSECTION Standard>
GST_TYPE_DISKSRC
GST_IS_DISKSRC
gst_disksrc_get_type
GST_DISKSRC_CLASS
GST_IS_DISKSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstesdsink</FILE>
GST_ESDSINK
<TITLE>GstEsdSink</TITLE>
gst_esdsink_new
gst_esdsink_chain
gst_esdsink_sync_parms
gst_esdsink_set_format
gst_esdsink_set_channels
gst_esdsink_set_frequency
<SUBSECTION Standard>
GST_TYPE_ESDSINK
GST_IS_ESDSINK
gst_esdsink_get_type
GST_ESDSINK_CLASS
GST_IS_ESDSINK_CLASS
</SECTION>
<SECTION>
<FILE>gstfakesink</FILE>
GST_FAKESINK
<TITLE>GstFakeSink</TITLE>
gst_fakesink_new
gst_fakesink_chain
<SUBSECTION Standard>
GST_TYPE_FAKESINK
GST_IS_FAKESINK
gst_fakesink_get_type
GST_FAKESINK_CLASS
GST_IS_FAKESINK_CLASS
</SECTION>
<SECTION>
<FILE>gstfakesrc</FILE>
GST_FAKESRC
<TITLE>GstFakeSrc</TITLE>
gst_fakesrc_new
gst_fakesrc_push
<SUBSECTION Standard>
GST_TYPE_FAKESRC
GST_IS_FAKESRC
gst_fakesrc_get_type
GST_FAKESRC_CLASS
GST_IS_FAKESRC_CLASS
</SECTION>
<SECTION>
<FILE>gstfdsink</FILE>
GST_FDSINK
<TITLE>GstFdSink</TITLE>
gst_fdsink_new
gst_fdsink_new_with_fd
gst_fdsink_chain
<SUBSECTION Standard>
GST_TYPE_FDSINK
GST_IS_FDSINK
gst_fdsink_get_type
GST_FDSINK_CLASS
GST_IS_FDSINK_CLASS
</SECTION>
<SECTION>
<FILE>gstfdsrc</FILE>
GST_FDSRC
<TITLE>GstFdSrc</TITLE>
<SUBSECTION Standard>
GST_TYPE_FDSRC
GST_IS_FDSRC
gst_fdsrc_get_type
GST_FDSRC_CLASS
GST_IS_FDSRC_CLASS
</SECTION>
<SECTION>
<FILE>gsthttpsrc</FILE>
GST_HTTPSRC
<TITLE>GstHttpSrc</TITLE>
<SUBSECTION Standard>
GST_TYPE_HTTPSRC
GST_IS_HTTPSRC
gst_httpsrc_get_type
GST_HTTPSRC_CLASS
GST_IS_HTTPSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstidentity</FILE>
GST_IDENTITY
<TITLE>GstIdentity</TITLE>
gst_identity_new
gst_identity_chain
<SUBSECTION Standard>
GST_TYPE_IDENTITY
GST_IS_IDENTITY
gst_identity_get_type
GST_IDENTITY_CLASS
GST_IS_IDENTITY_CLASS
</SECTION>
<SECTION>
<FILE>gstqueue</FILE>
GST_QUEUE
<TITLE>GstQueue</TITLE>
gst_queue_new
gst_queue_chain
gst_queue_push
<SUBSECTION Standard>
GST_TYPE_QUEUE
GST_IS_QUEUE
gst_queue_get_type
GST_QUEUE_CLASS
GST_IS_QUEUE_CLASS
</SECTION>
<SECTION>
<FILE>gstsinesrc</FILE>
GST_SINESRC
<TITLE>GstSineSrc</TITLE>
gst_sinesrc_new
gst_sinesrc_push
<SUBSECTION Standard>
GST_TYPE_SINESRC
GST_IS_SINESRC
gst_sinesrc_get_type
GST_SINESRC_CLASS
GST_IS_SINESRC_CLASS
</SECTION>
<SECTION>
<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
</SECTION>
<SECTION>
<FILE>gst</FILE>
gst_init
DEBUG
</SECTION>
<SECTION>
<FILE>gstlog</FILE>
GST_SHOW_INFO
gst_info
</SECTION>
<SECTION>
<FILE>gstplugin</FILE>
GstPlugin
GstPluginElement
GstPluginInitFunc
gst_plugin_new
gst_plugin_set_longname
gst_plugin_init
gst_plugin_load_all
gst_plugin_load
gst_plugin_load_absolute
gst_plugin_add_factory
gst_plugin_find
gst_plugin_get_list
gst_plugin_find_elementfactory
</SECTION>
<SECTION>
<FILE>gsttrace</FILE>
gst_trace_read_tsc
GstTrace
GstTraceEntry
gst_trace_new
gst_trace_destroy
gst_trace_flush
gst_trace_get_size
gst_trace_get_offset
gst_trace_get_remaining
gst_trace_set_default
TRACE_ENABLE
gst_trace_add_entry
</SECTION>
<SECTION>
<FILE>gsttype</FILE>
GstTypeFindFunc
GstType
GstTypeFactory
gst_type_initialize
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
</SECTION>
<SECTION>
<FILE>gstutils</FILE>
gst_util_get_int_arg
gst_util_get_long_arg
gst_util_get_float_arg
gst_util_get_double_arg
gst_util_get_string_arg
gst_util_get_pointer_arg
gst_util_get_widget_arg
</SECTION>
<SECTION>
<FILE>gstxml</FILE>
gst_xml_write
</SECTION>
<SECTION>
<FILE>plugin</FILE>
plugin_initialize
plugin_load_all
plugin_load
plugin_load_absolute
</SECTION>
<SECTION>
<FILE>audioraw</FILE>
MetaAudioRaw
</SECTION>
<SECTION>
<FILE>spectrum</FILE>
MetaAudioSpectrum
</SECTION>

View file

@ -0,0 +1,12 @@
GtkObject
GstObject
GstPad
GstElement
GstFilter
GstTee
GstBin
GstPipeline
GstThread
GstConnection
GstSrc
GstSink

14
docs/gst/gstreamer.types Normal file
View file

@ -0,0 +1,14 @@
#include <gtk/gtk.h>
#include <gst/gst.h>
gst_object_get_type
gst_pad_get_type
gst_element_get_type
gst_filter_get_type
gst_bin_get_type
gst_pipeline_get_type
gst_thread_get_type
gst_connection_get_type
gst_src_get_type
gst_sink_get_type
gst_tee_get_type

1
docs/gst/tmpl/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
*.bak

50
docs/gst/tmpl/gst.sgml Normal file
View file

@ -0,0 +1,50 @@
<!-- ##### SECTION Title ##### -->
Gstreamer
<!-- ##### SECTION Short_Description ##### -->
Media library supporting arbitrary formats and filter graphs.
<!-- ##### SECTION Long_Description ##### -->
<para>
GStreamer is a framework for constructing graphs of various filters
(termed elements here) that will handly streaming media. Any discreet
(packetizable) media type is supported, with provisions for automatically
determining source type. Metadata can be passed with all data to provide
formatting/framing information. Plugins are heavily used to provide for
all elements, allowing one to construct plugins outside of the GST
library, even released binary-only if license require (please don't).
</para>
<para>
GStreamer borrows heavily from both the <ulink
url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
Microsoft's DirectShow, hopefully taking the best of both and leaving the
cruft behind. Its interface is still very fluid (I've redesigned the
metadata handling twice already), and thus can be changed to increase the
sanity/noise ratio.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
pipeline</ulink> and Microsoft's DirectShow for some background.
</para>
<!-- ##### FUNCTION gst_init ##### -->
<para>
</para>
@argc:
@argv:
<!-- ##### MACRO DEBUG ##### -->
<para>
</para>
@format:
@args...:

108
docs/gst/tmpl/gstbin.sgml Normal file
View file

@ -0,0 +1,108 @@
<!-- ##### SECTION Title ##### -->
GstBin
<!-- ##### SECTION Short_Description ##### -->
Base container element
<!-- ##### SECTION Long_Description ##### -->
<para>
GstBin is the simplest of the container elements, allowing elements to
beocme children of itself. Pads from the child elements can be ghosted to
the bin, making the bin itself look transparently like any other element,
allowing for deep nesting of predefined sub-pipelines.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_BIN ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_bin_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_bin_add ##### -->
<para>
</para>
@bin:
@element:
<!-- ##### FUNCTION gst_bin_remove ##### -->
<para>
</para>
@bin:
@element:
<!-- ##### FUNCTION gst_bin_get_by_name ##### -->
<para>
</para>
@bin:
@name:
@Returns:
<!-- ##### FUNCTION gst_bin_get_list ##### -->
<para>
</para>
@bin:
@Returns:
<!-- ##### FUNCTION gst_bin_set_state_type ##### -->
<para>
</para>
@bin:
@state:
@type:
@Returns:
<!-- ##### FUNCTION gst_bin_iterate ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
<para>
</para>
@bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
</para>
@gstbin: the object which received the signal.
@arg1:

View file

@ -0,0 +1,241 @@
<!-- ##### SECTION Title ##### -->
GstBuffer
<!-- ##### SECTION Short_Description ##### -->
Data-passing buffer type, supporting sub-buffers and metadata
<!-- ##### SECTION Long_Description ##### -->
<para>
Buffers are the basic unit of data transfer in GST. The GstBuffer type
provides all the state necessary to define a region of memory as part of a
stream. Sub-buffer are also supported, allowing a smaller region of a
buffer to become its own buffer, with mechanisms in place to ensure that
nither memory space goes away. Metadata is supported as a list of
pointers to arbitrary metadata.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_BUFFER ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_FLAGS ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_FLAG_SET ##### -->
<para>
</para>
@buf:
@flag:
<!-- ##### MACRO GST_BUFFER_FLAG_UNSET ##### -->
<para>
</para>
@buf:
@flag:
<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_DATA ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_SIZE ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_OFFSET ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_MAXSIZE ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_TIMESTAMP ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_TRYLOCK ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
<para>
</para>
@buf:
<!-- ##### ENUM GstBufferFlags ##### -->
<para>
</para>
@GST_BUFFER_READONLY:
@GST_BUFFER_EOS:
@GST_BUFFER_ORIGINAL:
@GST_BUFFER_DONTFREE:
<!-- ##### STRUCT GstBuffer ##### -->
<para>
</para>
@lock:
@flags:
@data:
@size:
@maxsize:
@offset:
@timestamp:
@maxage:
@metas:
@parent:
<!-- ##### FUNCTION gst_buffer_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_buffer_create_sub ##### -->
<para>
</para>
@parent:
@offset:
@size:
@Returns:
<!-- ##### FUNCTION gst_buffer_ref ##### -->
<para>
</para>
@buffer:
<!-- ##### FUNCTION gst_buffer_ref_by_count ##### -->
<para>
</para>
@buffer:
@count:
<!-- ##### FUNCTION gst_buffer_unref ##### -->
<para>
</para>
@buffer:
<!-- ##### FUNCTION gst_buffer_destroy ##### -->
<para>
</para>
@buffer:
<!-- ##### FUNCTION gst_buffer_add_meta ##### -->
<para>
</para>
@buffer:
@meta:
<!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
<para>
</para>
@buffer:
@Returns:
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
<para>
</para>
@buffer:
@Returns:
<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
<para>
</para>
@buffer:
@meta:

View file

@ -0,0 +1,41 @@
<!-- ##### SECTION Title ##### -->
GstConnection
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_CONNECTION ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_connection_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_connection_push ##### -->
<para>
</para>
@connection:

View file

@ -0,0 +1,31 @@
<!-- ##### SECTION Title ##### -->
GstDiskSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### ENUM GstDiskSrcFlags ##### -->
<para>
</para>
@GST_DISKSRC_OPEN:

View file

@ -0,0 +1,364 @@
<!-- ##### SECTION Title ##### -->
GstElement
<!-- ##### SECTION Short_Description ##### -->
Base class for all pipeline elements
<!-- ##### SECTION Long_Description ##### -->
<para>
GstElement is the base class needed to construct an element that can be
used in a GST pipeline. As such, it is not a functional entity, and
cannot do anything when placed in a pipeline.
</para>
<para>
All GstElements have a list containing the #GstPad structure for all their
inputs and outputs. These can be added with gst_element_add_pad() or
gst_element_add_ghost_pad(), and retrieved by name with
gst_element_get_pad(), or in a list form by gst_element_get_pad_list().
</para>
<para>
gst_element_connect() is a convenience function provided to make it
simpler to connect pads of two elements together.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstElementState ##### -->
<para>
</para>
@GST_STATE_COMPLETE:
@GST_STATE_RUNNING:
@GST_STATE_DISCOVERY:
@GST_STATE_PREROLL:
@GST_STATE_PLAYING:
@GST_STATE_PAUSED:
@GST_STATE_MAX:
<!-- ##### MACRO GST_STATE ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_IS_SET ##### -->
<para>
</para>
@obj:
@flag:
<!-- ##### MACRO GST_STATE_SET ##### -->
<para>
</para>
@obj:
@flag:
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para>
</para>
@obj:
@flag:
<!-- ##### MACRO GST_ELEMENT ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstElementDetails ##### -->
<para>
</para>
@longname:
@class:
@description:
@version:
@author:
@copyright:
<!-- ##### STRUCT GstElementFactory ##### -->
<para>
</para>
@name:
@type:
@details:
<!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
<para>
</para>
@element:
<!-- ##### FUNCTION gst_element_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_element_set_loop_function ##### -->
<para>
</para>
@element:
@loop:
<!-- ##### FUNCTION gst_element_set_name ##### -->
<para>
</para>
@element:
@name:
<!-- ##### FUNCTION gst_element_get_name ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_set_manager ##### -->
<para>
</para>
@element:
@manager:
<!-- ##### FUNCTION gst_element_get_manager ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_add_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_add_ghost_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_get_pad ##### -->
<para>
</para>
@element:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_get_pad_list ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>
</para>
@src:
@srcpadname:
@dest:
@destpadname:
<!-- # Unused Parameters # -->
@srcpad:
@destpad:
<!-- ##### FUNCTION gst_element_set_state ##### -->
<para>
</para>
@element:
@state:
@Returns:
<!-- ##### FUNCTION gst_element_error ##### -->
<para>
</para>
@element:
@error:
<!-- ##### FUNCTION gst_element_change_state ##### -->
<para>
</para>
@element:
@state:
@Returns:
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
</para>
@element:
<!-- ##### FUNCTION gst_element_save_thyself ##### -->
<para>
</para>
@element:
@parent:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_new ##### -->
<para>
</para>
@name:
@type:
@details:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_register ##### -->
<para>
</para>
@elementfactory:
<!-- ##### FUNCTION gst_elementfactory_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_elementfactory_create ##### -->
<para>
</para>
@factory:
@name:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_make ##### -->
<para>
</para>
@factoryname:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:

View file

@ -0,0 +1,33 @@
<!-- ##### SECTION Title ##### -->
GstFilter
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_FILTER ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_filter_new ##### -->
<para>
</para>
@name:
@Returns:

100
docs/gst/tmpl/gstmeta.sgml Normal file
View file

@ -0,0 +1,100 @@
<!-- ##### SECTION Title ##### -->
gstmeta
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_META ##### -->
<para>
</para>
@meta:
<!-- ##### MACRO GST_META_FLAGS ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO GST_META_FLAG_SET ##### -->
<para>
</para>
@meta:
@flag:
<!-- ##### MACRO GST_META_FLAG_UNSET ##### -->
<para>
</para>
@meta:
@flag:
<!-- ##### ENUM GstMetaFlags ##### -->
<para>
</para>
@GST_META_FREEABLE:
<!-- ##### STRUCT GstMeta ##### -->
<para>
</para>
@lock:
@flags:
@data:
@size:
<!-- ##### FUNCTION gst_meta_new_size ##### -->
<para>
</para>
@size:
@Returns:
<!-- ##### MACRO gst_meta_new ##### -->
<para>
</para>
@type:
<!-- ##### FUNCTION gst_meta_ref ##### -->
<para>
</para>
@meta:
<!-- ##### FUNCTION gst_meta_unref ##### -->
<para>
</para>
@meta:

View file

@ -0,0 +1,172 @@
<!-- ##### SECTION Title ##### -->
GstObject
<!-- ##### SECTION Short_Description ##### -->
Basis for the GST object hierarchy.
<!-- ##### SECTION Long_Description ##### -->
<para>
GstObject provides a root for the object hierarchy tree filed in by the
GST library. It is currently a thin wrapper on top of
<classname>GtkObject</classname>, but eventually will be replaced by a
stripped down version of it. This will remove all the X dependencies from
the GST library, making it much more portably and generally useful.
</para>
<para>
GstObject gives us basic refcounting and parenting functionality, though
it is possible that we could use <classname>GtkObject</classname>'s
equivalent functions. I'll probably use what I have now until I strip
down <classname>GtkObject</classname> to re-parent the hierarchy.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstObject ##### -->
<para>
</para>
<!-- ##### MACRO GST_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
</para>
@obj: Object to return flags for.
<!-- ##### MACRO GST_FLAG_IS_SET ##### -->
<para>
This macro checks to see if the given flag is set.
</para>
@obj: Object to check for flag in.
@flag: Flag to check for, must be a single bit in guint32.
<!-- ##### MACRO GST_FLAG_SET ##### -->
<para>
This macro sets the given bits.
</para>
@obj: Object to set flag in.
@flag: Flag to set, can by any number of bits in guint32.
<!-- ##### MACRO GST_FLAG_UNSET ##### -->
<para>
This macro usets the given bits.
</para>
@obj: Object to unset flag in.
@flag: Flag to set, must be a single bit in guint32.
<!-- ##### MACRO GST_LOCK ##### -->
<para>
This macro will obtain a lock on the object, making serialization
possible.
</para>
@obj: Object to lock.
<!-- ##### MACRO GST_TRYLOCK ##### -->
<para>
This macro will try to obtain a lock on the object, but will return with
FALSE if it can't get it immediately.
</para>
@obj: Object to try to get a lock on.
<!-- ##### MACRO GST_UNLOCK ##### -->
<para>
This macro releases a lock on the object.
</para>
@obj: Object to unlock.
<!-- ##### FUNCTION gst_object_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_object_set_parent ##### -->
<para>
</para>
@object:
@parent:
<!-- ##### FUNCTION gst_object_get_parent ##### -->
<para>
</para>
@object:
@Returns:
<!-- ##### FUNCTION gst_object_unparent ##### -->
<para>
</para>
@object:
<!-- ##### MACRO gst_object_ref ##### -->
<para>
</para>
@obj:
<!-- # Unused Parameters # -->
@object:
<!-- ##### MACRO gst_object_unref ##### -->
<para>
</para>
@obj:
<!-- # Unused Parameters # -->
@object:
<!-- ##### MACRO gst_object_sink ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO gst_object_destroy ##### -->
<para>
</para>
@obj:
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
</para>
@gstobject: the object which received the signal.
@arg1:

230
docs/gst/tmpl/gstpad.sgml Normal file
View file

@ -0,0 +1,230 @@
<!-- ##### SECTION Title ##### -->
GstPad
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_PAD_CONNECTED ##### -->
<para>
</para>
@pad:
<!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
</para>
@pad:
<!-- ##### ENUM GstPadDirection ##### -->
<para>
</para>
@GST_PAD_UNKNOWN:
@GST_PAD_SRC:
@GST_PAD_SINK:
<!-- ##### FUNCTION gst_pad_new ##### -->
<para>
</para>
@name:
@direction:
@Returns:
<!-- ##### FUNCTION gst_pad_destroy ##### -->
<para>
</para>
@pad:
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_chain_function ##### -->
<para>
</para>
@pad:
@chain:
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_type_id ##### -->
<para>
</para>
@pad:
@id:
<!-- ##### FUNCTION gst_pad_set_name ##### -->
<para>
</para>
@pad:
@name:
<!-- ##### FUNCTION gst_pad_get_name ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_directory ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_parent ##### -->
<para>
</para>
@pad:
@parent:
<!-- ##### FUNCTION gst_pad_add_ghost_parent ##### -->
<para>
</para>
@pad:
@parent:
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
</para>
@pad:
@parent:
<!-- ##### FUNCTION gst_pad_get_parent ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_ghost_parents ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_peer ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_connect ##### -->
<para>
</para>
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_pad_push ##### -->
<para>
</para>
@pad:
@buffer:
<!-- ##### FUNCTION gst_pad_pull ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_save_thyself ##### -->
<para>
</para>
@pad:
@parent:
@Returns:

View file

@ -0,0 +1,49 @@
<!-- ##### SECTION Title ##### -->
GstPipeline
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_PIPELINE ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_pipeline_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### MACRO gst_pipeline_destroy ##### -->
<para>
</para>
@pipeline:
<!-- ##### FUNCTION gst_pipeline_iterate ##### -->
<para>
</para>
@pipeline:

View file

@ -0,0 +1,128 @@
<!-- ##### SECTION Title ##### -->
gstplugin
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstPlugin ##### -->
<para>
</para>
@name:
@longname:
@filename:
@types:
@elements:
@identifiers:
<!-- ##### STRUCT GstPluginElement ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
</para>
@module:
@Returns:
<!-- ##### FUNCTION gst_plugin_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_set_longname ##### -->
<para>
</para>
@plugin:
@longname:
<!-- ##### FUNCTION gst_plugin_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_plugin_load_all ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_plugin_load ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
<para>
</para>
@plugin:
@factory:
<!-- ##### FUNCTION gst_plugin_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_get_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_plugin_find_elementfactory ##### -->
<para>
</para>
@name:
@Returns:

View file

@ -0,0 +1,50 @@
<!-- ##### SECTION Title ##### -->
GstQueue
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_QUEUE ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_queue_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_queue_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_queue_push ##### -->
<para>
</para>
@connection:

View file

@ -0,0 +1,33 @@
<!-- ##### SECTION Title ##### -->
GstSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_SINK ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_sink_new ##### -->
<para>
</para>
@name:
@Returns:

99
docs/gst/tmpl/gstsrc.sgml Normal file
View file

@ -0,0 +1,99 @@
<!-- ##### SECTION Title ##### -->
GstSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_SRC ##### -->
<para>
</para>
@obj:
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
</para>
@GST_SRC_ASYNC:
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SRC_ASYNC ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_SRC_SET_FLAGS ##### -->
<para>
</para>
@src:
@flag:
<!-- ##### MACRO GST_SRC_UNSET_FLAGS ##### -->
<para>
</para>
@src:
@flag:
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
<para>
</para>
@src:
<!-- ##### FUNCTION gst_src_push ##### -->
<para>
</para>
@src:
<!-- ##### FUNCTION gst_src_push_region ##### -->
<para>
</para>
@src:
@offset:
@size:
<!-- ##### SIGNAL GstSrc::eos ##### -->
<para>
</para>
@gstsrc: the object which received the signal.
@arg1:

51
docs/gst/tmpl/gsttee.sgml Normal file
View file

@ -0,0 +1,51 @@
<!-- ##### SECTION Title ##### -->
GstTee
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_TEE ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_tee_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_tee_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_tee_new_pad ##### -->
<para>
</para>
@tee:
@Returns:

View file

@ -0,0 +1,63 @@
<!-- ##### SECTION Title ##### -->
GstThread
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstThreadState ##### -->
<para>
</para>
@GST_THREAD_CREATE:
@GST_THREAD_STATE_SPINNING:
@GST_THREAD_STATE_REAPING:
<!-- ##### MACRO GST_THREAD ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_thread_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_thread_main_loop ##### -->
<para>
</para>
@arg:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
</para>

121
docs/gst/tmpl/gsttrace.sgml Normal file
View file

@ -0,0 +1,121 @@
<!-- ##### SECTION Title ##### -->
gsttrace
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_trace_read_tsc ##### -->
<para>
</para>
@dst:
<!-- ##### STRUCT GstTrace ##### -->
<para>
</para>
@filename:
@fd:
@buf:
@bufsize:
@bufoffset:
<!-- ##### STRUCT GstTraceEntry ##### -->
<para>
</para>
@timestamp:
@sequence:
@data:
@message:
<!-- ##### FUNCTION gst_trace_new ##### -->
<para>
</para>
@filename:
@size:
@Returns:
<!-- ##### FUNCTION gst_trace_destroy ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_flush ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_size ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_offset ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_remaining ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_set_default ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO TRACE_ENABLE ##### -->
<para>
</para>
<!-- ##### MACRO gst_trace_add_entry ##### -->
<para>
</para>
@trace:
@seq:
@data:
@msg:

134
docs/gst/tmpl/gsttype.sgml Normal file
View file

@ -0,0 +1,134 @@
<!-- ##### SECTION Title ##### -->
gsttype
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstTypeFindFunc ##### -->
<para>
</para>
@buf:
@private:
@Returns:
<!-- ##### STRUCT GstType ##### -->
<para>
</para>
@id:
@mime:
@exts:
@typefindfunc:
@srcs:
@sinks:
<!-- ##### STRUCT GstTypeFactory ##### -->
<para>
</para>
@mime:
@exts:
@typefindfunc:
<!-- ##### FUNCTION gst_type_initialize ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_register ##### -->
<para>
</para>
@factory:
@Returns:
<!-- ##### FUNCTION gst_type_find_by_mime ##### -->
<para>
</para>
@mime:
@Returns:
<!-- ##### FUNCTION gst_type_find_by_ext ##### -->
<para>
</para>
@ext:
@Returns:
<!-- ##### FUNCTION gst_type_add_src ##### -->
<para>
</para>
@id:
@src:
<!-- ##### FUNCTION gst_type_add_sink ##### -->
<para>
</para>
@id:
@sink:
<!-- ##### FUNCTION gst_type_get_srcs ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_type_get_sinks ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_type_find_by_id ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_type_get_list ##### -->
<para>
</para>
@Returns:

View file

@ -0,0 +1,86 @@
<!-- ##### SECTION Title ##### -->
gstutils
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_float_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_double_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_string_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_pointer_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:

25
docs/gst/tmpl/gstxml.sgml Normal file
View file

@ -0,0 +1,25 @@
<!-- ##### SECTION Title ##### -->
gstxml
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_xml_write ##### -->
<para>
</para>
@element:
@Returns:

48
docs/gst/tmpl/plugin.sgml Normal file
View file

@ -0,0 +1,48 @@
<!-- ##### SECTION Title ##### -->
plugin
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION plugin_initialize ##### -->
<para>
</para>
<!-- ##### FUNCTION plugin_load_all ##### -->
<para>
</para>
<!-- ##### FUNCTION plugin_load ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION plugin_load_absolute ##### -->
<para>
</para>
@name:
@Returns: