gstreamer-libs-docs.sgml 3.31 KB
Newer Older
1 2 3
<?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" [
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
4
<!ENTITY % version-entities SYSTEM "version.entities">
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
5
%version-entities;
6 7 8 9 10 11 12

<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
13
<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
14 15 16

<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">

17
<!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
18
<!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
19
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
20

21 22 23 24
<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">

25 26
<!-- generated by gtkdoc-mkdb, stupid name -->
<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">
27

28
<!ENTITY hash "#">
29
]>
30
<book id="index">
31
  <bookinfo>
32
    <title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
33
    <releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
34
  </bookinfo>
35
  <part id="gstreamer-libs">
36 37 38 39 40 41 42 43 44
    <title>GStreamer Libraries</title>

    <para>
      To ease the creation of plugins, a library system was created. The most common
      functions for a plugin can be found in a library.
    </para>
    <para>
      GStreamer provides some standard libraries you can use to create plugins.
    </para>
45
    &GstDataProtocol;
46

47 48 49 50 51 52 53 54 55 56 57 58 59 60
    <chapter id="gstreamer-base">
    <title>GStreamer Base and Utillity Classes</title>
    <para>
      libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
      by elements and utillity classes that are most useful for plugin developers.
    </para>

    &GstBaseSrc;
    &GstBaseSink;
    &GstBaseTransform;
    &GstPushSrc;

    &GstAdapter;
    &GstCollectPads;
61
    &GstTypeFindHelper;
62 63 64

  </chapter>

65 66 67
    <chapter id="gstreamer-control">
      <title>gstcontrol</title>
      &GstController;
68
      &GstControllerGObject;
69 70
    </chapter>

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
  <chapter id="gstreamer-net">
    <title>GStreamer Network Classes</title>
    <para>
      libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
    </para>

    &GstNetClientClock;
    &GstNetTimePacket;
    &GstNetTimeProvider;
  </chapter>

  <chapter id="gstreamer-check">
    <title>GStreamer Check Unit Testing</title>
    <para>
      libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
      unit tests that use the check framework.
    </para>

    &GstCheck;
  </chapter>



94
  </part>
95

96
  <part id="gstreamer-libs-hierarchy">
97
    <title>Object Hierarchy</title>
98
    &gstreamer-libs-tree-index;
99
  </part>
100 101

  <index id="api-index">
102 103 104 105 106
    <title>Index</title>
  </index>
  <index role="deprecated">
    <title>Index of deprecated symbols</title>
  </index>
107 108 109
  <!-- disable, as
     - index generation is extremly slow in gtk-doc
     - we have not tagged lots of symbols thsi way anyway
110 111 112 113 114
  <index role="0.8">
    <title>Index of new symbols in 0.8</title>
  </index>
  <index role="0.9">
    <title>Index of new symbols in 0.9</title>
115
  </index>
116
  -->
117

118
</book>