docs: Clarify the distinction between Tracks and Layers

This commit is contained in:
Jean-François Fortin Tam 2013-02-10 12:07:48 -05:00 committed by Thibault Saunier
parent 04b1ef6eb7
commit edd45bba78

View file

@ -66,20 +66,28 @@
<para>The <classname>GESTimeline</classname> is a <para>The <classname>GESTimeline</classname> is a
<classname>GstElement</classname>. It can therefore be used in any <classname>GstElement</classname>. It can therefore be used in any
GStreamer pipeline like any other object.</para> 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 <para>The GESTimeline can contain two types of objects (seen in <xref
linkend="layer_tracks_diagram" />): <itemizedlist> linkend="layer_tracks_diagram" />): <itemizedlist>
<listitem> <listitem>
<para>Layers - Corresponds to the user-visible layout of <para>Layers - Corresponds to the user-visible arrangement of clips,
non-overlapping objects. A minimalistic timeline would only have and what you primarily interact with as an application developer.
one layer. A more complex editing application could use as many as A minimalistic timeline would only have one layer,
needed.</para> but a more complex editing application could use as many as needed.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Tracks - Corresponds to the output stream formats. A typical <para>Tracks - Corresponds to the output streams in GStreamer.
GESTimeline would have a audio track and a video track. An audio A typical GESTimeline, aimed at a video editing application, would
editor would only require one single audio Track.</para> 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> </listitem>
</itemizedlist></para> </itemizedlist></para>
@ -99,17 +107,5 @@
linkend="GESTimelinePipeline">GESTimelinePipeline</link>.</para> linkend="GESTimelinePipeline">GESTimelinePipeline</link>.</para>
</refsect2> </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> </refsect1>
</refentry> </refentry>