docs/libs/gstreamer-libs-docs.sgml

<?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 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">
<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">

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

<!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
<!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">

<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">

<!-- generated by gtkdoc-mkdb -->
<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">

<!ENTITY hash "#">
]>
<book id="index">
  <bookinfo>
    <title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
    <releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
  </bookinfo>
  <part id="gstreamer-libs">
    <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>

    <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;
      &GstTypeFindHelper;
    </chapter>

    <chapter id="gstreamer-control">
      <title>GStreamer Dynamic Parameter Control</title>
      &GstController;
      &GstControllerGObject;
    </chapter>

    <chapter id="gstreamer-dataprotocol">
      <title>GStreamer Data Protocol</title>
      &GstDataProtocol;
    </chapter>

    <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>
  </part>

  <part id="gstreamer-libs-hierarchy">
    <title>Object Hierarchy</title>
    &gstreamer-libs-tree-index;
  </part>

  <index id="api-index">
    <title>Index</title>
  </index>
  <index role="deprecated">
    <title>Index of deprecated symbols</title>
  </index>
  <!-- disable, as
     - index generation is extremly slow in gtk-doc
     - we have not tagged lots of symbols thsi way anyway
  <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>
  </index>
  -->

</book>