c9678277b4eb30c54892fbd99d588638badaed8b
[platform/upstream/gstreamer.git] / docs / libs / gst-plugins-base-libs-docs.sgml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY % version-entities SYSTEM "version.entities">
5 %version-entities;
6
7 <!ENTITY GstCompiling SYSTEM "compiling.sgml">
8 <!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
9 <!ENTITY GstAudioMixerUtils SYSTEM "xml/gstaudiomixerutils.xml">
10 <!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
11 <!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
12 <!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
13 <!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
14 <!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
15 <!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
16 <!ENTITY GstTag SYSTEM "xml/gsttag.xml">
17 <!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
18 <!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
19
20 ]>
21 <book id="index">
22   <bookinfo>
23     <title>GStreamer Base Plugins &GST_MAJORMINOR; Library Reference Manual</title>
24   </bookinfo>
25
26   <chapter id="gstreamer-plugins-base">
27     <title>GStreamer Base Plugins Libraries</title>
28     <para>
29 This manual describes the libraries provided by the GStreamer Base Plugins
30 package.
31     </para>
32     &GstCompiling;
33   </chapter>
34
35   <chapter id="gstreamer-audio">
36     <title>Audio Library</title>
37     <para>
38 This library should be linked to by getting cflags and libs from
39 <filename>gstreamer-plugins-base.pc</filename> and adding
40 <filename>-lgstaudio-&GST_MAJORMINOR;</filename> to the library flags.
41     </para>
42     &GstAudio;
43     &GstAudioMixerUtils;
44     &GstRingBuffer;
45   </chapter>
46
47   <chapter id="gstreamer-video">
48     <title>Video Library</title>
49     <para>
50 This library should be linked to by getting cflags and libs from
51 <filename>gstreamer-plugins-base.pc</filename> and adding
52 <filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
53     </para>
54     &GstVideoSink;
55     &GstVideoFilter;
56   </chapter>
57
58   <chapter id="gstreamer-interfaces">
59     <title>Interfaces Library</title>
60     <para>
61 This library should be linked to by getting cflags and libs from
62 <filename>gstreamer-plugins-base.pc</filename> and adding
63 <filename>-lgstinterfaces-&GST_MAJORMINOR;</filename> to the library flags.
64     </para>
65     &GstColorBalance;
66     &GstMixer;
67     &GstTuner;
68     &GstXOverlay;
69   </chapter>
70
71   <chapter id="gstreamer-tag">
72     <title>Tag Support Library</title>
73     <para>
74 This library should be linked to by getting cflags and libs from
75 <filename>gstreamer-plugins-base.pc</filename> and adding
76 <filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
77     </para>
78     &GstTag;
79   </chapter>
80
81   <chapter id="gstreamer-cdda">
82     <title>CDDA Library</title>
83     <para>
84 This library should be linked to by getting cflags and libs from
85 <filename>gstreamer-plugins-base.pc</filename> and adding
86 <filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
87     </para>
88     &GstCddaBaseSrc;
89   </chapter>
90
91 </book>