gstreamer/docs/libs/gst-plugins-base-libs-docs.sgml
Tim-Philipp Müller 1450f0fb18 API: add new libgstbaseutils library with functions
Original commit message from CVS:
* configure.ac:
* gst-libs/gst/Makefile.am:
* gst-libs/gst/utils/Makefile.am:
* gst-libs/gst/utils/base-utils.c: (gst_base_utils_init):
* gst-libs/gst/utils/base-utils.h:
* gst-libs/gst/utils/descriptions.c: (format_info_get_desc),
(find_format_info), (caps_are_rtp_caps),
(gst_base_utils_get_source_description),
(gst_base_utils_get_sink_description),
(gst_base_utils_get_decoder_description),
(gst_base_utils_get_encoder_description),
(gst_base_utils_get_element_description),
(gst_base_utils_add_codec_description_to_tag_list),
(gst_base_utils_get_codec_description), (gst_base_utils_list_all):
* gst-libs/gst/utils/descriptions.h:
* gst-libs/gst/utils/missing-plugins.c:
(missing_structure_get_type), (copy_and_clean_caps),
(gst_missing_uri_source_message_new),
(gst_missing_uri_sink_message_new),
(gst_missing_element_message_new),
(gst_missing_decoder_message_new),
(gst_missing_encoder_message_new),
(missing_structure_get_string_detail),
(missing_structure_get_caps_detail),
(gst_missing_plugin_message_get_installer_detail),
(gst_missing_plugin_message_get_description),
(gst_is_missing_plugin_message):
* gst-libs/gst/utils/missing-plugins.h:
API: add new libgstbaseutils library with functions
- to create and parse missing-plugins messages
- that provide (translated) descriptions for caps/decoders/sources/etc.
Closes #392393.
* pkgconfig/gstreamer-plugins-base-uninstalled.pc.in:
* pkgconfig/gstreamer-plugins-base.pc.in:
Add new lib.
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
Generate docs for new lib and API.
* tests/check/Makefile.am:
* tests/check/libs/.cvsignore:
* tests/check/libs/utils.c: (missing_msg_check_getters),
(GST_START_TEST), (libgstbaseutils_suite):
Add some basic unit tests.
2007-01-09 14:20:08 +00:00

214 lines
7.5 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 GstCompiling SYSTEM "compiling.sgml">
<!-- audio -->
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstAudioClock SYSTEM "xml/gstaudioclock.xml">
<!ENTITY GstAudioFilter SYSTEM "xml/gstaudiofilter.xml">
<!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml">
<!ENTITY GstAudioSink SYSTEM "xml/gstaudiosink.xml">
<!ENTITY GstAudioSrc SYSTEM "xml/gstaudiosrc.xml">
<!ENTITY GstBaseAudioSink SYSTEM "xml/gstbaseaudiosink.xml">
<!ENTITY GstBaseAudioSrc SYSTEM "xml/gstbaseaudiosrc.xml">
<!ENTITY GstMultiChannel SYSTEM "xml/gstmultichannel.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!-- cdda -->
<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
<!-- floatcast -->
<!ENTITY GstFloatCast SYSTEM "xml/gstfloatcast.xml">
<!-- interfaces -->
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstColorBalanceChannel SYSTEM "xml/gstcolorbalancechannel.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstMixerOptions SYSTEM "xml/gstmixeroptions.xml">
<!ENTITY GstMixerTrack SYSTEM "xml/gstmixertrack.xml">
<!ENTITY GstNavigation SYSTEM "xml/gstnavigation.xml">
<!ENTITY GstPropertyProbe SYSTEM "xml/gstpropertyprobe.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstTunerChannel SYSTEM "xml/gsttunerchannel.xml">
<!ENTITY GstTunerNorm SYSTEM "xml/gsttunernorm.xml">
<!ENTITY GstVideoOrientation SYSTEM "xml/gstvideoorientation.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
<!-- netbuffer -->
<!ENTITY GstNetBuffer SYSTEM "xml/gstnetbuffer.xml">
<!-- riff -->
<!ENTITY GstRiff SYSTEM "xml/gstriff.xml">
<!-- rtp -->
<!ENTITY GstBaseRtpAudioPayload SYSTEM "xml/gstbasertpaudiopayload.xml">
<!ENTITY GstBaseRtpDepayload SYSTEM "xml/gstbasertpdepayload.xml">
<!ENTITY GstBaseRtpPayload SYSTEM "xml/gstbasertppayload.xml">
<!ENTITY GstRtpBuffer SYSTEM "xml/gstrtpbuffer.xml">
<!-- tag -->
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml">
<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml">
<!-- utils -->
<!ENTITY GstBaseUtils SYSTEM "xml/gstbaseutils.xml">
<!ENTITY GstBaseUtilsDescriptions SYSTEM "xml/gstbaseutilsdescriptions.xml">
<!ENTITY GstBaseUtilsMissingPlugins SYSTEM "xml/gstbaseutilsmissingplugins.xml">
<!-- video -->
<!ENTITY GstVideo SYSTEM "xml/gstvideo.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!-- generated by gtkdoc-mkdb -->
<!ENTITY gst-plugin-libs-tree-index SYSTEM "xml/tree_index.sgml">
]>
<book id="index">
<bookinfo>
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</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>
&GstCompiling;
<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.pc</filename> and adding
<filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstAudio;
&GstAudioClock;
&GstAudioFilter;
&GstAudioMixerUtils;
&GstBaseAudioSink;
&GstBaseAudioSrc;
&GstAudioSink;
&GstAudioSrc;
&GstMultiChannel;
&GstRingBuffer;
</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.pc</filename> and adding
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstCddaBaseSrc;
</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.pc</filename> and adding
<filename>-lgstfloatcase-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstFloatCast;
</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.pc</filename> and adding
<filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstColorBalance;
&GstColorBalanceChannel;
&GstMixer;
&GstMixerOptions;
&GstMixerTrack;
&GstNavigation;
&GstPropertyProbe;
&GstTuner;
&GstTunerChannel;
&GstTunerNorm;
&GstVideoOrientation;
&GstXOverlay;
</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.pc</filename> and adding
<filename>-lgstnetbuffer-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstNetBuffer;
</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.pc</filename> and adding
<filename>-lgstriff-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstRiff;
</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.pc</filename> and adding
<filename>-lgstrtp-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstBaseRtpAudioPayload;
&GstBaseRtpDepayload;
&GstBaseRtpPayload;
&GstRtpBuffer;
</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.pc</filename> and adding
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstTag;
&GstTagVorbis;
&GstTagID3;
</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.pc</filename> and adding
<filename>-lgstbaseutils-&GST_MAJORMINOR;</filename> to the library
flags.
</para>
&GstBaseUtils;
&GstBaseUtilsDescriptions;
&GstBaseUtilsMissingPlugins;
</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.pc</filename> and adding
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstVideo;
&GstVideoSink;
&GstVideoFilter;
</chapter>
</part>
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gst-plugin-libs-tree-index;
</part>
<index id="api-index">
<title>Index</title>
</index>
</book>