docs/libs/ges-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
   8 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   9   <bookinfo>
  10     <title>GStreamer Editing Services &GES_VERSION; Reference Manual</title>
  11     <releaseinfo>
  12       for GStreamer Editing Services &GST_API_VERSION; (&GES_VERSION;)
  13     </releaseinfo>
  14   </bookinfo>
  15
  16   <chapter>
  17     <title>GStreamer Editing Services Overview</title>
  18     <para>
  19       The "GStreamer Editing Services" is a library to simplify the creation
  20 of multimedia editing applications. Based on the GStreamer multimedia framework
  21 and the GNonLin set of plugins, its goals are to suit all types of editing-related
  22 applications.
  23     </para>
  24
  25     <para>
  26       The GStreamer Editing Services are cross-platform and work on most UNIX-like
  27 platform as well as Windows. It is released under the GNU Library General Public License
  28 (GNU LGPL).
  29     </para>
  30   <xi:include href="architecture.xml"/>
  31   <xi:include href="xml/ges-common.xml"/>
  32   <xi:include href="xml/ges-enums.xml"/>
  33   <xi:include href="xml/ges-gerror.xml"/>
  34   </chapter>
  35
  36   <chapter>
  37     <title>Base Classes</title>
  38     <xi:include href="xml/gestimeline.xml"/>
  39     <xi:include href="xml/geslayer.xml"/>
  40     <xi:include href="xml/gestimelineelement.xml"/>
  41     <xi:include href="xml/gescontainer.xml"/>
  42     <xi:include href="xml/gesclip.xml"/>
  43     <xi:include href="xml/gessourceclip.xml"/>
  44     <xi:include href="xml/gesoperationclip.xml"/>
  45     <xi:include href="xml/gesoverlayclip.xml"/>
  46     <xi:include href="xml/gesbaseeffectclip.xml"/>
  47     <xi:include href="xml/gestrack.xml"/>
  48     <xi:include href="xml/gestrackelement.xml"/>
  49     <xi:include href="xml/gessource.xml"/>
  50     <xi:include href="xml/gesvideosource.xml"/>
  51     <xi:include href="xml/gesaudiosource.xml"/>
  52     <xi:include href="xml/gesbaseeffect.xml"/>
  53     <xi:include href="xml/gesoperation.xml"/>
  54     <xi:include href="xml/gesbasetransitionclip.xml"/>
  55     <xi:include href="xml/gesasset.xml"/>
  56   </chapter>
  57
  58   <chapter>
  59     <title>Timeline objects</title>
  60     <xi:include href="xml/gesuriclip.xml"/>
  61     <xi:include href="xml/gestitleclip.xml"/>
  62     <xi:include href="xml/gestestclip.xml"/>
  63     <xi:include href="xml/gestextoverlayclip.xml"/>
  64     <xi:include href="xml/gestransitionclip.xml"/>
  65     <xi:include href="xml/geseffectclip.xml"/>
  66     <xi:include href="xml/gesgroup.xml"/>
  67   </chapter>
  68
  69   <chapter>
  70     <title>Track objects</title>
  71     <xi:include href="xml/gesaudiourisource.xml"/>
  72     <xi:include href="xml/gesvideourisource.xml"/>
  73     <xi:include href="xml/gestitlesource.xml"/>
  74     <xi:include href="xml/gesaudiotestsource.xml"/>
  75     <xi:include href="xml/gesvideotestsource.xml"/>
  76     <xi:include href="xml/gestextoverlay.xml"/>
  77     <xi:include href="xml/gestransition.xml"/>
  78     <xi:include href="xml/gesvideotransition.xml"/>
  79     <xi:include href="xml/gesaudiotransition.xml"/>
  80     <xi:include href="xml/gesimagesource.xml"/>
  81     <xi:include href="xml/gesmultifilesource.xml"/>
  82     <xi:include href="xml/geseffect.xml"/>
  83   </chapter>
  84
  85   <chapter>
  86     <title>Convenience classes</title>
  87     <xi:include href="xml/gespipeline.xml"/>
  88   </chapter>
  89
  90   <chapter>
  91     <title>Serialization Classes</title>
  92     <xi:include href="xml/gesformatter.xml"/>
  93     <xi:include href="xml/gespitiviformatter.xml"/>
  94     <xi:include href="xml/gesbasexmlformatter.xml"/>
  95     <xi:include href="xml/gesxmlformatter.xml"/>
  96   </chapter>
  97
  98   <chapter>
  99     <title>Interfaces</title>
 100     <xi:include href="xml/gesmetacontainer.xml"/>
 101     <xi:include href="xml/gesextractable.xml"/>
 102   </chapter>
 103
 104   <chapter>
 105     <title>Assets</title>
 106     <xi:include href="xml/gesclipasset.xml"/>
 107     <xi:include href="xml/gestrackelementasset.xml"/>
 108     <xi:include href="xml/gesuriclipasset.xml"/>
 109     <xi:include href="xml/gesurisourceasset.xml"/>
 110     <xi:include href="xml/gesproject.xml"/>
 111   </chapter>
 112
 113   <chapter>
 114     <title>Tracks</title>
 115     <xi:include href="xml/gesvideotrack.xml"/>
 116     <xi:include href="xml/gesaudiotrack.xml"/>
 117   </chapter>
 118
 119   <chapter id="ges-hierarchy">
 120     <title>Object Hierarchy</title>
 121     <xi:include href="xml/tree_index.sgml"/>
 122   </chapter>
 123
 124   <index id="api-index-full">
 125     <title>API Index</title>
 126     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 127   </index>
 128
 129   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 130 </book>