gstreamer/docs/libs/gst-plugins-base-libs-docs.sgml
Wim Taymans 1e9f5c43ad docs/: Added some more docs to libs and plugins.
Original commit message from CVS:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
Added some more docs to libs and plugins.
* gst-libs/gst/audio/gstringbuffer.c:
(gst_ring_buffer_prepare_read), (gst_ring_buffer_clear):
* gst-libs/gst/audio/gstringbuffer.h:
Document ringbuffer some more.
* gst/videorate/gstvideorate.c: (gst_video_rate_class_init),
(gst_video_rate_setcaps), (gst_video_rate_reset),
(gst_video_rate_init), (gst_video_rate_flush_prev),
(gst_video_rate_swap_prev), (gst_video_rate_event),
(gst_video_rate_chain), (gst_video_rate_change_state):
* gst/videorate/gstvideorate.h:
Fix videorate to use segments.
Make it work with 0/1 framerates (closes #331903)
Handle EOS correctly.
Added docs.
2006-03-02 16:47:34 +00:00

99 lines
3.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 GstCompiling SYSTEM "compiling.sgml">
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml">
<!ENTITY GstAudioSink SYSTEM "xml/gstaudiosink.xml">
<!ENTITY GstBaseAudioSink SYSTEM "xml/gstbaseaudiosink.xml">
<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml">
<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
]>
<book id="index">
<bookinfo>
<title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
</bookinfo>
<chapter 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>
<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;
&GstAudioMixerUtils;
&GstBaseAudioSink;
&GstAudioSink;
&GstRingBuffer;
</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>
&GstVideoSink;
&GstVideoFilter;
</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;
&GstMixer;
&GstTuner;
&GstXOverlay;
</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-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>
</book>