summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-François Fortin Tam <nekohayo@gmail.com>2013-02-10 12:07:48 -0500
committerThibault Saunier <thibault.saunier@collabora.com>2013-02-10 17:05:43 -0300
commitedd45bba7834f23b9e0917b50b37c487759dcd2f (patch)
tree426db1dfb28c1718b57fc9de52e857d7ad2d9d3d
parent04b1ef6eb7c76f0209fa3e6141d40e5eb3019cc5 (diff)
docs: Clarify the distinction between Tracks and Layers
-rw-r--r--docs/libs/architecture.xml36
1 files changed, 16 insertions, 20 deletions
diff --git a/docs/libs/architecture.xml b/docs/libs/architecture.xml
index 0465b557..f42f209a 100644
--- a/docs/libs/architecture.xml
+++ b/docs/libs/architecture.xml
@@ -66,20 +66,28 @@
<para>The <classname>GESTimeline</classname> is a
<classname>GstElement</classname>. It can therefore be used in any
GStreamer pipeline like any other object.</para>
+ </refsect2>
+
+
+ <refsect2>
+ <title>Tracks and Layers</title>
<para>The GESTimeline can contain two types of objects (seen in <xref
linkend="layer_tracks_diagram" />): <itemizedlist>
<listitem>
- <para>Layers - Corresponds to the user-visible layout of
- non-overlapping objects. A minimalistic timeline would only have
- one layer. A more complex editing application could use as many as
- needed.</para>
+ <para>Layers - Corresponds to the user-visible arrangement of clips,
+ and what you primarily interact with as an application developer.
+ A minimalistic timeline would only have one layer,
+ but a more complex editing application could use as many as needed.
+ </para>
</listitem>
<listitem>
- <para>Tracks - Corresponds to the output stream formats. A typical
- GESTimeline would have a audio track and a video track. An audio
- editor would only require one single audio Track.</para>
+ <para>Tracks - Corresponds to the output streams in GStreamer.
+ A typical GESTimeline, aimed at a video editing application, would
+ have an audio track and a video track.
+ A GESTimeline for an audio editing application would only require
+ an audio track. Multiple layers can be related to each track.</para>
</listitem>
</itemizedlist></para>
@@ -94,22 +102,10 @@
</figure>
<para>In order to reduce even more the amount of GStreamer interaction
- the application developer has to deal with , a convenience GstPipeline
+ the application developer has to deal with, a convenience GstPipeline
has been made available specifically for Timelines : <link
linkend="GESTimelinePipeline">GESTimelinePipeline</link>.</para>
</refsect2>
- <refsect2>
- <title>Timeline layers</title>
-
- <para>The layers are the end-user visible part of GES.</para>
- </refsect2>
-
- <refsect2>
- <title>Timeline Tracks</title>
-
- <para>The tracks are the GStreamer-level components of a Timeline. They
- are a 1-to-1 relationship to the output streams.</para>
- </refsect2>
</refsect1>
</refentry>