summaryrefslogtreecommitdiff
path: root/docs/libs/ges-docs.sgml
blob: 9aaae742acb6d63ce67e5d0ab54c1229b37b4e59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?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;
]>

<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>GStreamer Editing Services &GES_VERSION; Reference Manual</title>
    <releaseinfo>
      for GStreamer Editing Services &GST_API_VERSION; (&GES_VERSION;)
    </releaseinfo>
  </bookinfo>

  <chapter>
    <title>GStreamer Editing Services Overview</title>
    <para>
      The "GStreamer Editing Services" is a library to simplify the creation
of multimedia editing applications. Based on the GStreamer multimedia framework
and the GNonLin set of plugins, its goals are to suit all types of editing-related
applications.
    </para>

    <para>
      The GStreamer Editing Services are cross-platform and work on most UNIX-like
platform as well as Windows. It is released under the GNU Library General Public License
(GNU LGPL).
    </para>
  <xi:include href="architecture.xml"/>
  <xi:include href="xml/ges-common.xml"/>
  <xi:include href="xml/ges-enums.xml"/>
  <xi:include href="xml/ges-gerror.xml"/>
  </chapter>

  <chapter>
    <title>Base Classes</title>
    <xi:include href="xml/ges-timeline.xml"/>
    <xi:include href="xml/ges-layer.xml"/>
    <xi:include href="xml/ges-timeline-element.xml"/>
    <xi:include href="xml/ges-container.xml"/>
    <xi:include href="xml/ges-clip.xml"/>
    <xi:include href="xml/ges-source-clip.xml"/>
    <xi:include href="xml/ges-operation-clip.xml"/>
    <xi:include href="xml/ges-overlay-clip.xml"/>
    <xi:include href="xml/ges-base-effect-clip.xml"/>
    <xi:include href="xml/ges-track.xml"/>
    <xi:include href="xml/ges-track-element.xml"/>
    <xi:include href="xml/ges-source.xml"/>
    <xi:include href="xml/ges-base-effect.xml"/>
    <xi:include href="xml/ges-operation.xml"/>
    <xi:include href="xml/ges-base-transition-clip.xml"/>
    <xi:include href="xml/ges-asset.xml"/>
  </chapter>

  <chapter>
    <title>Timeline objects</title>
    <xi:include href="xml/ges-timeline-filesource.xml"/>
    <xi:include href="xml/ges-title-clip.xml"/>
    <xi:include href="xml/ges-test-clip.xml"/>
    <xi:include href="xml/ges-text-overlay-clip.xml"/>
    <xi:include href="xml/ges-transition-clip.xml"/>
    <xi:include href="xml/ges-effect-clip.xml"/>
  </chapter>

  <chapter>
    <title>Track objects</title>
    <xi:include href="xml/ges-uri-source.xml"/>
    <xi:include href="xml/ges-title-source.xml"/>
    <xi:include href="xml/ges-audio-test-source.xml"/>
    <xi:include href="xml/ges-video-test-source.xml"/>
    <xi:include href="xml/ges-text-overlay.xml"/>
    <xi:include href="xml/ges-transition.xml"/>
    <xi:include href="xml/ges-video-transition.xml"/>
    <xi:include href="xml/ges-audio-transition.xml"/>
    <xi:include href="xml/ges-image-source.xml"/>
    <xi:include href="xml/ges-effect.xml"/>
  </chapter>

  <chapter>
    <title>Simple Timeline interface</title>
    <xi:include href="xml/ges-simple-layer.xml"/>
  </chapter>

  <chapter>
    <title>Convenience classes</title>
    <xi:include href="xml/ges-timeline-pipeline.xml"/>
    <xi:include href="xml/ges-custom-source-clip.xml"/>
  </chapter>

  <chapter>
    <title>Serialization Classes</title>
    <xi:include href="xml/ges-formatter.xml"/>
    <xi:include href="xml/ges-pitivi-formatter.xml"/>
    <xi:include href="xml/ges-base-xml-formatter.xml"/>
    <xi:include href="xml/ges-xml-formatter.xml"/>
  </chapter>

  <chapter>
    <title>Interfaces</title>
    <xi:include href="xml/ges-meta-container.xml"/>
    <xi:include href="xml/ges-extractable.xml"/>
  </chapter>

  <chapter>
    <title>Assets</title>
    <xi:include href="xml/ges-clip-asset.xml"/>
    <xi:include href="xml/ges-track-element-asset.xml"/>
    <xi:include href="xml/ges-uri-clip-asset.xml"/>
    <xi:include href="xml/ges-asset-track-file-source.xml"/>
    <xi:include href="xml/ges-project.xml"/>
  </chapter>

  <chapter>
    <title>Tracks</title>
    <xi:include href="xml/ges-video-track.xml"/>
    <xi:include href="xml/ges-audio-track.xml"/>
  </chapter>

  <chapter id="ges-hierarchy">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>