toc: some documentation updates

This commit is contained in:
Tim-Philipp Müller 2013-03-24 17:53:35 +00:00
parent 1e6e797d65
commit a76885f333
2 changed files with 18 additions and 0 deletions

View file

@ -58,6 +58,15 @@ timestamps for each item using gst_toc_entry_set_start_stop().
The best way to process already created GstToc is to recursively go through
the 'entries' and 'subentries' fields.
Applications and plugins should not rely on TOCs having a certain kind of
structure, but should allow for different alternatives. For example, a
simple CUE sheet embedded in a file may be presented as a flat list of
track entries, or could have a top-level edition node (or some other
alternative type entry) with track entries underneath that node; or even
multiple top-level edition nodes (or some other alternative type entries)
each with track entries underneath, in case the source file has extracted
a track listing from different sources).
2. TOC scope: global and current

View file

@ -60,6 +60,15 @@
* chapters and angles, for example, while the current TOC would only contain
* the chapters for the currently playing title if playback of a specific
* title was requested.
*
* Applications and plugins should not rely on TOCs having a certain kind of
* structure, but should allow for different alternatives. For example, a
* simple CUE sheet embedded in a file may be presented as a flat list of
* track entries, or could have a top-level edition node (or some other
* alternative type entry) with track entries underneath that node; or even
* multiple top-level edition nodes (or some other alternative type entries)
* each with track entries underneath, in case the source file has extracted
* a track listing from different sources).
*/
#ifdef HAVE_CONFIG_H