mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 04:01:08 +00:00
9ba56f4181
Original commit message from CVS: Get the API docs back in shape. This batch of patches contain the updates that don't require source code comment changes.
170 lines
4.8 KiB
Text
170 lines
4.8 KiB
Text
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
|
|
|
<!entity Gst SYSTEM "sgml/gst.sgml">
|
|
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
|
|
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
|
|
<!entity GstData SYSTEM "sgml/gstdata.sgml">
|
|
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
|
|
<!entity GstEvent SYSTEM "sgml/gstevent.sgml">
|
|
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
|
|
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
|
|
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
|
|
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
|
|
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
|
|
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
|
|
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
|
|
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
|
|
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
|
|
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
|
|
<!entity GstPluginFeature SYSTEM "sgml/gstpluginfeature.sgml">
|
|
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
|
|
<!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
|
|
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
|
|
<!entity GstType SYSTEM "sgml/gsttype.sgml">
|
|
<!entity GstTypeFactory SYSTEM "sgml/gsttypefactory.sgml">
|
|
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
|
|
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
|
|
<!entity GstClock SYSTEM "sgml/gstclock.sgml">
|
|
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
|
|
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
|
|
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
|
|
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
|
|
<!entity GstTimeCache SYSTEM "sgml/gsttimecache.sgml">
|
|
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
|
|
|
|
<!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
|
|
<!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
|
|
<!entity GstAggregator SYSTEM "sgml/gstaggregator.sgml">
|
|
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
|
|
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
|
|
<!entity GstFileSrc SYSTEM "sgml/gstfilesrc.sgml">
|
|
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
|
|
<!entity GstDiskSink SYSTEM "sgml/gstdisksink.sgml">
|
|
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
|
|
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
|
|
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
|
|
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
|
|
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
|
|
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
|
|
|
|
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
|
|
]>
|
|
|
|
|
|
<book>
|
|
<bookinfo>
|
|
<title>GStreamer Library Reference Manual (Core)</title>
|
|
</bookinfo>
|
|
<chapter id="gstreamer">
|
|
<title>GStreamer Core Library</title>
|
|
|
|
<para>libgst.la provides all the core GStreamer services,
|
|
including initialization, plugin management and types, as
|
|
well as the object hiarchy that defines elements and bins, along
|
|
with some more specialized elements.</para>
|
|
|
|
&Gst;
|
|
&GstAutoplug;
|
|
&GstBin;
|
|
&GstBuffer;
|
|
&GstBufferPool;
|
|
&GstCaps;
|
|
&GstClock;
|
|
&GstCpu;
|
|
&GstData;
|
|
&GstElement;
|
|
&GstEvent;
|
|
&GstInfo;
|
|
&GstObject;
|
|
&GstPad;
|
|
&GstParse;
|
|
&GstPipeline;
|
|
&GstPlugin;
|
|
&GstPluginFeature;
|
|
&GstProps;
|
|
&GstQueue;
|
|
&GstScheduler;
|
|
&GstThread;
|
|
&GstTimeCache;
|
|
&GstTrace;
|
|
&GstType;
|
|
&GstTypeFactory;
|
|
&GstTypeFind;
|
|
&GstUtils;
|
|
&GstXML;
|
|
|
|
&cothreads;
|
|
</chapter>
|
|
|
|
<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 gtk_object_get() and
|
|
gtk_object_set() functions and the GStreamer Core Library functions.
|
|
</para>
|
|
<para>
|
|
Use the gst_elementfactory_find() and gst_elementfactory_create() functions
|
|
to create these elements.
|
|
</para>
|
|
<para>
|
|
The following code example shows you how to create a GstDiskSrc element.
|
|
</para>
|
|
|
|
<para>
|
|
<programlisting role="C">
|
|
#include <gst/gst.h>
|
|
|
|
GstElement *src;
|
|
GstElementFactory *srcfactory;
|
|
|
|
gst_init(&argc,&argv);
|
|
|
|
srcfactory = gst_elementfactory_find("disksrc");
|
|
g_return_if_fail(srcfactory != NULL);
|
|
src = gst_elementfactory_create(srcfactory,"src");
|
|
g_return_if_fail(src != NULL);
|
|
...
|
|
</programlisting>
|
|
</para>
|
|
|
|
&GstAggregator;
|
|
|
|
&GstFakeSrc;
|
|
&GstFakeSink;
|
|
|
|
<!-- &GstFileSrc; -->
|
|
&GstDiskSrc;
|
|
&GstDiskSink;
|
|
|
|
&GstHttpSrc;
|
|
|
|
&GstFdSrc;
|
|
&GstFdSink;
|
|
|
|
&GstPipefilter;
|
|
&GstIdentity;
|
|
|
|
&GstTee;
|
|
</chapter>
|
|
|
|
<chapter id="autopluggers">
|
|
<title>GStreamer Autoppluggers</title>
|
|
|
|
<para>the autopluggers provide a way to automatically construct elements based on
|
|
sink and src capabilities</para>
|
|
|
|
&GstStaticAutoplug;
|
|
&GstStaticAutoplugRender;
|
|
</chapter>
|
|
|
|
<chapter id="gst-index">
|
|
<title>Index</title>
|
|
|
|
<sect1>
|
|
<title>Object Hierarchy</title>
|
|
&gstreamer-tree-index;
|
|
</sect1>
|
|
</chapter>
|
|
</book>
|