2003-05-18 15:04:26 +00:00
|
|
|
<?xml version="1.0"?>
|
2008-10-30 15:29:51 +00:00
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
2004-05-20 12:40:31 +00:00
|
|
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
2004-02-12 17:23:37 +00:00
|
|
|
%version-entities;
|
2008-10-30 15:29:51 +00:00
|
|
|
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
2003-06-29 14:05:49 +00:00
|
|
|
<!ENTITY hash "#">
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
]>
|
2008-10-30 15:29:51 +00:00
|
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
<bookinfo>
|
2012-04-04 11:13:52 +00:00
|
|
|
<title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
|
2007-08-10 17:35:30 +00:00
|
|
|
<releaseinfo>
|
2012-04-04 11:13:52 +00:00
|
|
|
for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
|
2007-08-10 17:35:30 +00:00
|
|
|
The latest version of this documentation can be found on-line at
|
|
|
|
|
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
|
|
|
|
|
</releaseinfo>
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
</bookinfo>
|
2002-12-14 16:22:01 +00:00
|
|
|
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
<chapter id="gstreamer">
|
2005-10-08 11:12:26 +00:00
|
|
|
|
|
|
|
|
<title>GStreamer Overview</title>
|
|
|
|
|
<para>
|
|
|
|
|
GStreamer is a streaming media framework.
|
|
|
|
|
It uses graphs of elements which operate on data.
|
|
|
|
|
The functionality to process media is provided by plug-ins which provide
|
|
|
|
|
features like elements, typefinding, and so on.
|
|
|
|
|
This allows new functionality to be added simply by installing new plug-ins.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
GStreamer is cross-platform and works on most UNIX-like platforms as well as
|
|
|
|
|
Windows. It is released under the GNU Library General Public License
|
|
|
|
|
(GNU LGPL).
|
|
|
|
|
</para>
|
2010-03-25 08:35:13 +00:00
|
|
|
|
|
|
|
|
<mediaobject>
|
|
|
|
|
<imageobject>
|
|
|
|
|
<imagedata fileref="gst-universe.svg" format="SVG"/>
|
|
|
|
|
</imageobject>
|
|
|
|
|
<caption>
|
|
|
|
|
<para>Relation between gstreamer core objects.</para>
|
|
|
|
|
</caption>
|
|
|
|
|
</mediaobject>
|
2005-10-08 11:12:26 +00:00
|
|
|
|
2009-03-25 09:03:22 +00:00
|
|
|
<xi:include href="building.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="running.xml" />
|
2005-10-08 11:12:26 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="libgstreamer">
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
<title>GStreamer Core Library</title>
|
|
|
|
|
|
2004-07-21 11:32:09 +00:00
|
|
|
<para>
|
2012-04-04 11:13:52 +00:00
|
|
|
libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
|
2004-07-21 11:32:09 +00:00
|
|
|
including initialization, plugin management and types,
|
|
|
|
|
as well as the object hierarchy that defines elements and bins,
|
|
|
|
|
along with some more specialized elements.
|
|
|
|
|
</para>
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gst.xml" />
|
2012-08-11 21:19:32 +00:00
|
|
|
<xi:include href="xml/gstallocator.xml" />
|
2011-02-16 15:19:46 +00:00
|
|
|
<xi:include href="xml/gstatomicqueue.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstbin.xml" />
|
|
|
|
|
<xi:include href="xml/gstbuffer.xml" />
|
2009-05-12 10:08:56 +00:00
|
|
|
<xi:include href="xml/gstbufferlist.xml" />
|
2011-02-22 10:05:09 +00:00
|
|
|
<xi:include href="xml/gstbufferpool.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstbus.xml" />
|
|
|
|
|
<xi:include href="xml/gstcaps.xml" />
|
2012-01-03 14:03:38 +00:00
|
|
|
<xi:include href="xml/gstsample.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstchildproxy.xml" />
|
|
|
|
|
<xi:include href="xml/gstclock.xml" />
|
|
|
|
|
<xi:include href="xml/gstconfig.xml" />
|
2011-12-20 21:36:18 +00:00
|
|
|
<xi:include href="xml/gstcontrolbinding.xml" />
|
2011-11-04 10:39:25 +00:00
|
|
|
<xi:include href="xml/gstcontrolsource.xml" />
|
2010-12-02 12:03:57 +00:00
|
|
|
<xi:include href="xml/gstdatetime.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstelement.xml" />
|
|
|
|
|
<xi:include href="xml/gstelementfactory.xml" />
|
|
|
|
|
<xi:include href="xml/gsterror.xml" />
|
|
|
|
|
<xi:include href="xml/gstevent.xml" />
|
|
|
|
|
<xi:include href="xml/gstformat.xml" />
|
|
|
|
|
<xi:include href="xml/gstghostpad.xml" />
|
|
|
|
|
<xi:include href="xml/gstiterator.xml" />
|
2011-03-30 16:45:08 +00:00
|
|
|
<xi:include href="xml/gstmemory.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstmessage.xml" />
|
2011-02-25 12:15:25 +00:00
|
|
|
<xi:include href="xml/gstmeta.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstminiobject.xml" />
|
|
|
|
|
<xi:include href="xml/gstobject.xml" />
|
|
|
|
|
<xi:include href="xml/gstpad.xml" />
|
|
|
|
|
<xi:include href="xml/gstpadtemplate.xml" />
|
|
|
|
|
<xi:include href="xml/gstparamspec.xml" />
|
|
|
|
|
<xi:include href="xml/gstparse.xml" />
|
|
|
|
|
<xi:include href="xml/gstpipeline.xml" />
|
|
|
|
|
<xi:include href="xml/gstplugin.xml" />
|
|
|
|
|
<xi:include href="xml/gstpluginfeature.xml" />
|
|
|
|
|
<xi:include href="xml/gstpoll.xml" />
|
|
|
|
|
<xi:include href="xml/gstpreset.xml" />
|
|
|
|
|
<xi:include href="xml/gstquery.xml" />
|
|
|
|
|
<xi:include href="xml/gstregistry.xml" />
|
|
|
|
|
<xi:include href="xml/gstsegment.xml" />
|
|
|
|
|
<xi:include href="xml/gststructure.xml" />
|
|
|
|
|
<xi:include href="xml/gstsystemclock.xml" />
|
|
|
|
|
<xi:include href="xml/gsttaglist.xml" />
|
|
|
|
|
<xi:include href="xml/gsttagsetter.xml" />
|
|
|
|
|
<xi:include href="xml/gsttask.xml" />
|
2009-04-23 13:44:13 +00:00
|
|
|
<xi:include href="xml/gsttaskpool.xml" />
|
2012-03-14 17:14:23 +00:00
|
|
|
<xi:include href="xml/gsttoc.xml" />
|
|
|
|
|
<xi:include href="xml/gsttocsetter.xml" />
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gsttypefind.xml" />
|
|
|
|
|
<xi:include href="xml/gsttypefindfactory.xml" />
|
|
|
|
|
<xi:include href="xml/gsturihandler.xml" />
|
|
|
|
|
<xi:include href="xml/gstutils.xml" />
|
|
|
|
|
<xi:include href="xml/gstvalue.xml" />
|
|
|
|
|
<xi:include href="xml/gstversion.xml" />
|
2000-11-07 21:18:52 +00:00
|
|
|
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
2004-01-28 14:33:59 +00:00
|
|
|
<chapter id="gstreamer-support">
|
|
|
|
|
<title>GStreamer Core Support</title>
|
|
|
|
|
<para>
|
2005-09-02 16:17:23 +00:00
|
|
|
Theses modules support the gstreamer core and plugin development.
|
|
|
|
|
Application developers will rarely need to know about it.
|
2005-08-31 14:08:45 +00:00
|
|
|
</para>
|
|
|
|
|
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/gstinfo.xml" />
|
2004-07-27 15:01:10 +00:00
|
|
|
|
|
|
|
|
</chapter>
|
|
|
|
|
|
2004-06-24 23:05:04 +00:00
|
|
|
<chapter id="gstreamer-hierarchy">
|
2004-05-14 14:00:04 +00:00
|
|
|
<title>Object Hierarchy</title>
|
2008-10-30 15:29:51 +00:00
|
|
|
<xi:include href="xml/tree_index.sgml"/>
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
</chapter>
|
2004-05-14 14:00:04 +00:00
|
|
|
|
2008-10-30 15:29:51 +00:00
|
|
|
<index id="api-index-full">
|
|
|
|
|
<title>API Index</title>
|
|
|
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
2005-08-11 17:39:48 +00:00
|
|
|
</index>
|
2008-10-30 15:29:51 +00:00
|
|
|
<index id="api-index-deprecated" role="deprecated">
|
|
|
|
|
<title>Index of deprecated API</title>
|
|
|
|
|
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
2004-07-15 13:20:54 +00:00
|
|
|
</index>
|
2004-05-14 14:00:04 +00:00
|
|
|
|
2009-10-28 08:15:12 +00:00
|
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
|
|
|
|
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.
2000-02-01 09:16:43 +00:00
|
|
|
</book>
|
