mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-03 01:02:19 +00:00
626cbdc8b2
Original commit message from CVS: cleanup of unused and forgoten sections fixed links from the manual and the pwg to the API docs added more notes to README
215 lines
6.3 KiB
XML
215 lines
6.3 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 GstAtomic SYSTEM "xml/gstatomic.xml">
|
|
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
|
|
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
|
|
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
|
|
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
|
|
<!ENTITY GstCompat SYSTEM "xml/gstcompat.xml">
|
|
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
|
|
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
|
|
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
|
|
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
|
|
<!ENTITY GstElementDetails SYSTEM "xml/gstelementdetails.xml">
|
|
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
|
|
<!ENTITY GstEnumTypes SYSTEM "xml/gstenumtypes.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 GstMacros SYSTEM "xml/gstmacros.xml">
|
|
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.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 GstProbe SYSTEM "xml/gstprobe.xml">
|
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
|
<!ENTITY GstRealPad SYSTEM "xml/gstrealpad.xml">
|
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
|
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
|
|
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
|
|
<!ENTITY GstSchedulerFactory SYSTEM "xml/gstschedulerfactory.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 GstThread SYSTEM "xml/gstthread.xml">
|
|
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
|
|
<!ENTITY GstTrashStack SYSTEM "xml/gsttrashstack.xml">
|
|
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
|
|
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
|
|
<!ENTITY GstTypes SYSTEM "xml/gsttypes.xml">
|
|
<!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
|
|
<!ENTITY GstUriType SYSTEM "xml/gsturitype.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 GstAggregator SYSTEM "xml/gstaggregator.xml">
|
|
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
|
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
|
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
|
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.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">
|
|
-->
|
|
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
|
|
|
|
<!ENTITY hash "#">
|
|
]>
|
|
<book>
|
|
<bookinfo>
|
|
<title>GStreamer &GST_MAJORMINOR; Core API Reference</title>
|
|
<releaseinfo>for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
|
|
</bookinfo>
|
|
|
|
<chapter id="gstreamer">
|
|
<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;
|
|
&GstCaps;
|
|
&GstClock;
|
|
&GstConfig;
|
|
&GstCpu;
|
|
&GstData;
|
|
&GstElement;
|
|
&GstElementDetails;
|
|
&GstElementFactory;
|
|
&GstEnumTypes;
|
|
&GstError;
|
|
&GstEvent;
|
|
&GstFilter;
|
|
&GstFormat;
|
|
&GstGhostPad;
|
|
&GstImplementsInterface;
|
|
&GstIndex;
|
|
&GstIndexFactory;
|
|
&GstInfo;
|
|
&GstObject;
|
|
&GstPad;
|
|
&GstPadTemplate;
|
|
&GstParse;
|
|
&GstPipeline;
|
|
&GstPlugin;
|
|
&GstPluginFeature;
|
|
&GstProbe;
|
|
&GstQuery;
|
|
&GstQueue;
|
|
&GstRealPad;
|
|
&GstRegistry;
|
|
&GstRegistryPool;
|
|
&GstScheduler;
|
|
&GstSchedulerFactory;
|
|
&GstStructure;
|
|
&GstSystemClock;
|
|
&GstTagList;
|
|
&GstTagSetter;
|
|
&GstThread;
|
|
&GstTypeFind;
|
|
&GstTypeFindFactory;
|
|
&GstTypes;
|
|
&GstUriHandler;
|
|
&GstUriType;
|
|
&GstUtils;
|
|
&GstValue;
|
|
&GstVersion;
|
|
&GstXML;
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-support">
|
|
<title>GStreamer Core Support</title>
|
|
<para>
|
|
Theses elements support the gstreamer core and applications using it.
|
|
</para>
|
|
|
|
&GstAtomic;
|
|
&GstMacros;
|
|
&GstMemChunk;
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-compat">
|
|
<title>GStreamer Core Compatibility</title>
|
|
<para>
|
|
Theses elements are defined for compatibillity with older code.
|
|
The must not be use in new code!
|
|
</para>
|
|
|
|
&GstCompat;
|
|
|
|
</chapter>
|
|
|
|
<!--
|
|
FIXME: why is this commented out (reason #1: no public API)
|
|
<chapter id="element-types">
|
|
<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 g_object_get() and
|
|
g_object_set() functions and the GStreamer Core Library functions.
|
|
</para>
|
|
|
|
&GstAggregator;
|
|
|
|
&GstFakeSrc;
|
|
&GstFakeSink;
|
|
|
|
&GstFileSrc;
|
|
&GstDiskSink;
|
|
|
|
&GstFdSrc;
|
|
&GstFdSink;
|
|
|
|
&GstPipefilter;
|
|
&GstIdentity;
|
|
|
|
&GstStatistics;
|
|
&GstMD5Sink;
|
|
|
|
&GstTee;
|
|
</chapter>
|
|
-->
|
|
|
|
|
|
<chapter id="gstreamer-hierarchy">
|
|
<title>Object Hierarchy</title>
|
|
&gstreamer-tree-index;
|
|
</chapter>
|
|
|
|
<index id="api-index">
|
|
<title>API Index</title>
|
|
</index>
|
|
|
|
</book>
|