mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-10 12:42:13 +00:00
a28d63431a
Original commit message from CVS: * gst/gstbin.h: removed ';' from the end of macro defs * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/.cvsignore: * gst/gstbus.h: * gst/gstelement.c: (gst_element_class_init), (gst_element_set_state), (activate_pads), (gst_element_save_thyself): * gst/gstevent.c: (gst_event_new_newsegment): * gst/gstevent.h: * gst/gstiterator.c: * gst/gstiterator.h: * gst/gstpad.c: * gst/gstprobe.h: * gst/gstutils.c: (gst_pad_query_convert): * gst/gstutils.h: fixed parameter name mismatches between source, header and docs added some more docs, resolved the last batch of unused elements in docs (now someone needs to doc them)
250 lines
7.1 KiB
XML
250 lines
7.1 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 GstElementDetails SYSTEM "xml/gstelementdetails.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 GstMacros SYSTEM "xml/gstmacros.xml">
|
|
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.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 GstProbe SYSTEM "xml/gstprobe.xml">
|
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
|
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.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 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 GstXMLRegistry SYSTEM "xml/gstxmlregistry.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 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 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 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;
|
|
&GstCheck;
|
|
&GstChildProxy;
|
|
&GstClock;
|
|
&GstConfig;
|
|
&GstElement;
|
|
&GstElementDetails;
|
|
&GstElementFactory;
|
|
&GstError;
|
|
&GstEvent;
|
|
&GstFilter;
|
|
&GstFormat;
|
|
&GstGhostPad;
|
|
&GstImplementsInterface;
|
|
&GstIndex;
|
|
&GstIndexFactory;
|
|
&GstInfo;
|
|
&GstIterator;
|
|
&GstMessage;
|
|
&GstMiniObject;
|
|
&GstObject;
|
|
&GstPad;
|
|
&GstPadTemplate;
|
|
&GstParse;
|
|
&GstPipeline;
|
|
&GstPlugin;
|
|
&GstPluginFeature;
|
|
&GstProbe;
|
|
&GstQuery;
|
|
&GstQueue;
|
|
&GstRegistry;
|
|
&GstRegistryPool;
|
|
&GstStructure;
|
|
&GstSystemClock;
|
|
&GstTagList;
|
|
&GstTagSetter;
|
|
&GstTypeFind;
|
|
&GstTypeFindFactory;
|
|
&GstTypes;
|
|
&GstUriHandler;
|
|
&GstUriType;
|
|
&GstUtils;
|
|
&GstValue;
|
|
&GstVersion;
|
|
&GstXML;
|
|
&GstXMLRegistry;
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-support">
|
|
<title>GStreamer Core Support</title>
|
|
<para>
|
|
Theses elements support the gstreamer core and applications using it.
|
|
</para>
|
|
|
|
&GstMacros;
|
|
&GstMemChunk;
|
|
|
|
</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 Classes</title>
|
|
<para>
|
|
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
|
|
by elements.
|
|
</para>
|
|
|
|
&GstAdapter;
|
|
&GstBaseSrc;
|
|
&GstBaseSink;
|
|
&GstBaseTransform;
|
|
&GstCollectPads;
|
|
&GstPushSrc;
|
|
|
|
</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>
|
|
<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>
|