mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 16:50:47 +00:00
32d6280888
Original commit message from CVS: * docs/gst/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/gstreamer.types: * gst/gstinfo.h: more docs fixes, add new api to the docs
282 lines
8 KiB
XML
282 lines
8 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
<!ENTITY % version-entities SYSTEM "version.entities">
|
|
%version-entities;
|
|
<!ENTITY Gst SYSTEM "xml/gst.xml">
|
|
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
|
|
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
|
|
<!ENTITY GstBus SYSTEM "xml/gstbus.xml">
|
|
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
|
|
<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
|
|
<!ENTITY GstChildProxy SYSTEM "xml/gstchildproxy.xml">
|
|
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
|
|
<!--
|
|
<!ENTITY GstCompat SYSTEM "xml/gstcompat.xml">
|
|
-->
|
|
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
|
|
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
|
|
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
|
|
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
|
|
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
|
|
<!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
|
|
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
|
|
<!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
|
|
<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
|
|
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
|
|
<!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
|
|
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
|
|
<!ENTITY GstIterator SYSTEM "xml/gstiterator.xml">
|
|
<!ENTITY GstMessage SYSTEM "xml/gstmessage.xml">
|
|
<!ENTITY GstMiniObject SYSTEM "xml/gstminiobject.xml">
|
|
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
|
|
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
|
|
<!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
|
|
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
|
|
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
|
|
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
|
|
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
|
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
|
<!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
|
|
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
|
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
|
|
<!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
|
|
<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
|
|
<!ENTITY GstTask SYSTEM "xml/gsttask.xml">
|
|
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
|
|
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
|
|
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
|
|
<!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
|
|
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
|
|
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
|
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
|
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
|
|
|
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
|
|
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
|
|
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
|
|
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
|
|
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
|
|
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
|
|
|
|
<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
|
|
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
|
|
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">
|
|
|
|
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
|
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
|
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
|
<!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
|
|
<!--
|
|
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
|
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
|
|
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
|
|
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
|
|
<!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
|
|
<!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
|
|
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
|
|
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">
|
|
-->
|
|
|
|
<!-- generated by gtkdoc-mkdb, stupid name -->
|
|
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
|
|
|
|
<!ENTITY gst-Running SYSTEM "running.xml">
|
|
|
|
<!ENTITY hash "#">
|
|
]>
|
|
<book id="index">
|
|
<bookinfo>
|
|
<title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
|
|
<releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
|
|
</bookinfo>
|
|
|
|
<chapter id="gstreamer">
|
|
|
|
<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>
|
|
|
|
&gst-Running;
|
|
</chapter>
|
|
|
|
<chapter id="libgstreamer">
|
|
<title>GStreamer Core Library</title>
|
|
|
|
<para>
|
|
libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
|
|
including initialization, plugin management and types,
|
|
as well as the object hierarchy that defines elements and bins,
|
|
along with some more specialized elements.
|
|
</para>
|
|
|
|
&Gst;
|
|
&GstBin;
|
|
&GstBuffer;
|
|
&GstBus;
|
|
&GstCaps;
|
|
&GstChildProxy;
|
|
&GstClock;
|
|
&GstConfig;
|
|
&GstElement;
|
|
&GstElementFactory;
|
|
&GstError;
|
|
&GstEvent;
|
|
&GstFilter;
|
|
&GstFormat;
|
|
&GstGhostPad;
|
|
&GstImplementsInterface;
|
|
&GstIndex;
|
|
&GstIndexFactory;
|
|
&GstIterator;
|
|
&GstMessage;
|
|
&GstMiniObject;
|
|
&GstObject;
|
|
&GstPad;
|
|
&GstPadTemplate;
|
|
&GstParse;
|
|
&GstPipeline;
|
|
&GstPlugin;
|
|
&GstPluginFeature;
|
|
&GstQuery;
|
|
&GstQueue;
|
|
&GstRegistry;
|
|
&GstSegment;
|
|
&GstStructure;
|
|
&GstSystemClock;
|
|
&GstTagList;
|
|
&GstTagSetter;
|
|
&GstTask;
|
|
&GstTypeFind;
|
|
&GstTypeFindFactory;
|
|
&GstUriHandler;
|
|
&GstUtils;
|
|
&GstValue;
|
|
&GstVersion;
|
|
&GstXML;
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-support">
|
|
<title>GStreamer Core Support</title>
|
|
<para>
|
|
Theses modules support the gstreamer core and plugin development.
|
|
Application developers will rarely need to know about it.
|
|
</para>
|
|
|
|
&GstCheck;
|
|
&GstInfo;
|
|
&GstTrace;
|
|
|
|
</chapter>
|
|
|
|
<!--
|
|
<chapter id="gstreamer-compat">
|
|
<title>GStreamer Core Compatibility</title>
|
|
<para>
|
|
These elements are defined for compatibility with older code.
|
|
They must not be used in new code!
|
|
</para>
|
|
|
|
&GstCompat;
|
|
|
|
</chapter>
|
|
-->
|
|
|
|
<chapter id="element-types">
|
|
<title>GStreamer Core Elements</title>
|
|
|
|
<para>
|
|
libgstelements.so provide some basic elements like a file source
|
|
and sink. The use of these elements is strictly though the g_object_get() and
|
|
g_object_set() functions and the GStreamer Core Library functions.
|
|
</para>
|
|
|
|
|
|
&GstFakeSrc;
|
|
&GstFakeSink;
|
|
&GstFileSrc;
|
|
&GstFileSink;
|
|
<!--
|
|
|
|
&GstAggregator;
|
|
|
|
&GstFdSrc;
|
|
&GstFdSink;
|
|
|
|
&GstPipefilter;
|
|
&GstIdentity;
|
|
|
|
&GstStatistics;
|
|
&GstMD5Sink;
|
|
|
|
&GstTee;
|
|
-->
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-base">
|
|
<title>GStreamer Base and Utillity Classes</title>
|
|
<para>
|
|
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
|
|
by elements and utillity classes that are most useful for plugin developers.
|
|
</para>
|
|
|
|
&GstBaseSrc;
|
|
&GstBaseSink;
|
|
&GstBaseTransform;
|
|
&GstPushSrc;
|
|
|
|
&GstAdapter;
|
|
&GstCollectPads;
|
|
|
|
</chapter>
|
|
|
|
|
|
<chapter id="gstreamer-net">
|
|
<title>GStreamer Network Classes</title>
|
|
<para>
|
|
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
|
|
</para>
|
|
|
|
&GstNetClientClock;
|
|
&GstNetTimePacket;
|
|
&GstNetTimeProvider;
|
|
</chapter>
|
|
|
|
|
|
<chapter id="gstreamer-hierarchy">
|
|
<title>Object Hierarchy</title>
|
|
&gstreamer-tree-index;
|
|
</chapter>
|
|
|
|
<index id="api-index">
|
|
<title>Index</title>
|
|
</index>
|
|
<index role="deprecated">
|
|
<title>Index of deprecated symbols</title>
|
|
</index>
|
|
<!-- disable, as
|
|
- index generation is extremly slow in gtk-doc
|
|
- we have not tagged lots of symbols thsi way anyway
|
|
<index role="0.8">
|
|
<title>Index of new symbols in 0.8</title>
|
|
</index>
|
|
<index role="0.9">
|
|
<title>Index of new symbols in 0.9</title>
|
|
</index>
|
|
-->
|
|
|
|
</book>
|