mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-24 09:10:36 +00:00
242 lines
10 KiB
XML
242 lines
10 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;
|
|
]>
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
<bookinfo>
|
|
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
|
|
<releaseinfo>
|
|
for GStreamer Base Library &GST_MAJORMINOR; (&GST_VERSION;)
|
|
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/</ulink>.
|
|
</releaseinfo>
|
|
</bookinfo>
|
|
|
|
<part id="gstreamer-plugins-base">
|
|
<title>GStreamer Base Plugins Libraries</title>
|
|
<para>
|
|
This manual describes the libraries provided by the GStreamer Base Plugins
|
|
package.
|
|
</para>
|
|
<xi:include href="compiling.sgml" />
|
|
|
|
<chapter id="gstreamer-app">
|
|
<title>App Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstapp-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<para>
|
|
To use it the functionality, insert an appsrc or appsink element into a pipeline and call the appropriate functions on the element.
|
|
</para>
|
|
<xi:include href="xml/gstappsrc.xml" />
|
|
<xi:include href="xml/gstappsink.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-audio">
|
|
<title>Audio Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstaudio.xml" />
|
|
<xi:include href="xml/gstaudioclock.xml" />
|
|
<xi:include href="xml/gstaudiofilter.xml" />
|
|
<xi:include href="xml/gstaudiomixerutils.xml" />
|
|
<xi:include href="xml/gstaudiosink.xml" />
|
|
<xi:include href="xml/gstaudiosrc.xml" />
|
|
<xi:include href="xml/gstbaseaudiosink.xml" />
|
|
<xi:include href="xml/gstbaseaudiosrc.xml" />
|
|
<xi:include href="xml/gstmultichannel.xml" />
|
|
<xi:include href="xml/gstringbuffer.xml" />
|
|
<xi:include href="xml/gstaudioiec61937.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-cdda">
|
|
<title>CDDA Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstcddabasesrc.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-ffft">
|
|
<title>FFT Library</title>
|
|
<para>
|
|
The gstfft library is based on
|
|
<ulink role="online-location" url="http://sourceforge.net/projects/kissfft">kissfft</ulink>
|
|
by Mark Borgerding.
|
|
</para>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstfft-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstfft.xml" />
|
|
<xi:include href="xml/gstffts16.xml" />
|
|
<xi:include href="xml/gstffts32.xml" />
|
|
<xi:include href="xml/gstfftf32.xml" />
|
|
<xi:include href="xml/gstfftf64.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-floatcast">
|
|
<title>FloatCast Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstfloatcast.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-interfaces">
|
|
<title>Interfaces Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstcolorbalance.xml" />
|
|
<xi:include href="xml/gstcolorbalancechannel.xml" />
|
|
<xi:include href="xml/gstmixer.xml" />
|
|
<xi:include href="xml/gstmixeroptions.xml" />
|
|
<xi:include href="xml/gstmixertrack.xml" />
|
|
<xi:include href="xml/gstnavigation.xml" />
|
|
<xi:include href="xml/gstpropertyprobe.xml" />
|
|
<xi:include href="xml/gststreamvolume.xml" />
|
|
<xi:include href="xml/gsttuner.xml" />
|
|
<xi:include href="xml/gsttunerchannel.xml" />
|
|
<xi:include href="xml/gsttunernorm.xml" />
|
|
<xi:include href="xml/gstvideoorientation.xml" />
|
|
<xi:include href="xml/gstxoverlay.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-netbuffer">
|
|
<title>Network Buffer Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstnetbuffer-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstnetbuffer.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-riff">
|
|
<title>Riff Media Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstriff-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstriff.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-rtp">
|
|
<title>RTP Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstrtp-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstbasertpaudiopayload.xml" />
|
|
<xi:include href="xml/gstbasertpdepayload.xml" />
|
|
<xi:include href="xml/gstbasertppayload.xml" />
|
|
<xi:include href="xml/gstrtpbuffer.xml" />
|
|
<xi:include href="xml/gstrtcpbuffer.xml" />
|
|
<xi:include href="xml/gstrtppayloads.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-rtsp">
|
|
<title>RTSP Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstrtsp-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstrtspbase64.xml" />
|
|
<xi:include href="xml/gstrtspconnection.xml" />
|
|
<xi:include href="xml/gstrtspdefs.xml" />
|
|
<xi:include href="xml/gstrtspextension.xml" />
|
|
<xi:include href="xml/gstrtspmessage.xml" />
|
|
<xi:include href="xml/gstrtsprange.xml" />
|
|
<xi:include href="xml/gstrtsptransport.xml" />
|
|
<xi:include href="xml/gstrtspurl.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-sdp">
|
|
<title>SDP Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstsdp-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstsdpmessage.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-tag">
|
|
<title>Tag Support Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gsttag.xml" />
|
|
<xi:include href="xml/gsttagvorbis.xml" />
|
|
<xi:include href="xml/gsttagid3.xml" />
|
|
<xi:include href="xml/gsttagxmp.xml" />
|
|
<xi:include href="xml/gsttagxmpwriter.xml" />
|
|
<xi:include href="xml/gsttagdemux.xml" />
|
|
<xi:include href="xml/gsttaglanguagecodes.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-base-utils">
|
|
<title>Base Utils Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstpbutils-&GST_MAJORMINOR;</filename> to the library
|
|
flags.
|
|
</para>
|
|
<xi:include href="xml/gstpbutils.xml" />
|
|
<xi:include href="xml/gstpbutilscodecutils.xml" />
|
|
<xi:include href="xml/gstpbutilsdescriptions.xml" />
|
|
<xi:include href="xml/gstpbutilsmissingplugins.xml" />
|
|
<xi:include href="xml/gstpbutilsinstallplugins.xml" />
|
|
<xi:include href="xml/gstdiscoverer.xml" />
|
|
<xi:include href="xml/encoding-profile.xml" />
|
|
</chapter>
|
|
|
|
<chapter id="gstreamer-video">
|
|
<title>Video Library</title>
|
|
<para>
|
|
This library should be linked to by getting cflags and libs from
|
|
<filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
|
|
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
|
|
</para>
|
|
<xi:include href="xml/gstvideo.xml" />
|
|
<xi:include href="xml/gstvideofilter.xml" />
|
|
<xi:include href="xml/gstvideosink.xml" />
|
|
</chapter>
|
|
</part>
|
|
|
|
<part id="gstreamer-libs-hierarchy">
|
|
<title>Object Hierarchy</title>
|
|
<xi:include href="xml/tree_index.sgml" />
|
|
</part>
|
|
|
|
<index id="api-index-full">
|
|
<title>Index</title>
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<index id="api-index-deprecated" role="deprecated">
|
|
<title>Index of deprecated API</title>
|
|
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
</book>
|