mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-07-01 20:30:41 +00:00
bf8c785fb0
Original commit message from CVS: Documentation updates. All standard library objects and standard elements are documented. Modified some of the elements to more accuratly report about their arguments so the documentation builds more reasonable output. Added aviencoder and jpegencoder elements (not working yet)
161 lines
4.3 KiB
Plaintext
161 lines
4.3 KiB
Plaintext
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
|
|
|
<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
|
|
<!entity Gst SYSTEM "sgml/gst.sgml">
|
|
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
|
|
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
|
|
<!entity GstConnection SYSTEM "sgml/gstconnection.sgml">
|
|
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
|
|
<!entity GstFilter SYSTEM "sgml/gstfilter.sgml">
|
|
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
|
|
<!entity GstMeta SYSTEM "sgml/gstmeta.sgml">
|
|
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
|
|
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
|
|
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
|
|
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
|
|
<!entity GstSink SYSTEM "sgml/gstsink.sgml">
|
|
<!entity GstSrc SYSTEM "sgml/gstsrc.sgml">
|
|
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
|
|
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
|
|
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
|
|
<!entity GstType SYSTEM "sgml/gsttype.sgml">
|
|
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
|
|
<!entity GstXml SYSTEM "sgml/gstxml.sgml">
|
|
|
|
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
|
|
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
|
|
|
|
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
|
|
<!entity GstAsyncDiskSrc SYSTEM "sgml/gstasyncdisksrc.sgml">
|
|
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
|
|
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
|
|
<!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml">
|
|
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
|
|
|
|
<!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml">
|
|
<!entity GstEsdSink SYSTEM "sgml/gstesdsink.sgml">
|
|
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
|
|
|
|
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
|
|
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
|
|
|
|
<!entity audioraw SYSTEM "sgml/audioraw.sgml">
|
|
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
|
|
<!entity videoraw SYSTEM "sgml/videoraw.sgml">
|
|
|
|
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
|
|
]>
|
|
|
|
|
|
<book>
|
|
<bookinfo>
|
|
<title>GStreamer Library Reference Manual</title>
|
|
</bookinfo>
|
|
<chapter id="gstreamer">
|
|
<title>GStreamer Core Library</title>
|
|
|
|
<para>libgst.la provides all the core GStreamer services,
|
|
including initialization, plugin management, types and metadata, as
|
|
well as the object hiarchy that defines elements and bins, along
|
|
with some more specialized elements.</para>
|
|
|
|
&Gst;
|
|
&GstObject;
|
|
&GstElement;
|
|
&GstBin;
|
|
&GstPipeline;
|
|
&GstFilter;
|
|
&GstSink;
|
|
&GstSrc;
|
|
&GstBuffer;
|
|
&GstPad;
|
|
&GstConnection;
|
|
&GstPlugin;
|
|
&GstThread;
|
|
&GstTee;
|
|
|
|
&GstType;
|
|
&GstMeta;
|
|
&GstUtils;
|
|
&GstTrace;
|
|
&GstXml;
|
|
</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>
|
|
|
|
&GstFakeSrc;
|
|
&GstFakeSink;
|
|
|
|
&GstDiskSrc;
|
|
&GstAsyncDiskSrc;
|
|
&GstHttpSrc;
|
|
&GstFdSrc;
|
|
&GstAudioSrc;
|
|
&GstSineSrc;
|
|
|
|
&GstAudioSink;
|
|
&GstFdSink;
|
|
|
|
&GstIdentity;
|
|
&GstQueue;
|
|
</chapter>
|
|
|
|
<chapter id="metatdata-types">
|
|
<title>GStreamer MetaData Types</title>
|
|
|
|
<para>MetaData is used to specify the content of buffers. See <classname>GstMeta</classname>. </para>
|
|
|
|
&spectrum;
|
|
&audioraw;
|
|
&videoraw;
|
|
</chapter>
|
|
|
|
<chapter id="plugins">
|
|
<title>GStreamer Multimedia Plugins</title>
|
|
|
|
<para>GStreamer has some advanced multimedia plugins. </para>
|
|
|
|
|
|
</chapter>
|
|
|
|
<chapter id="gst-index">
|
|
<title>Index</title>
|
|
|
|
<sect1>
|
|
<title>Object Hierarchy</title>
|
|
&gstreamer-tree-index;
|
|
</sect1>
|
|
</chapter>
|
|
</book>
|