Gst.Toc

Fields

None

Methods

class new (scope)
  append_entry (entry)
  dump ()
  find_entry (uid)
  get_entries ()
  get_scope ()
  get_tags ()
  merge_tags (tags, mode)
  set_tags (tags)

Details

class Gst.Toc

Gst.Toc functions are used to create/free Gst.Toc and Gst.TocEntry structures. Also they are used to convert Gst.Toc into Gst.Structure and vice versa.

Gst.Toc lets you to inform other elements in pipeline or application that playing source has some kind of table of contents (TOC). These may be chapters, editions, angles or other types. For example: DVD chapters, Matroska chapters or cue sheet TOC. Such TOC will be useful for applications to display instead of just a playlist.

Using TOC is very easy. Firstly, create Gst.Toc structure which represents root contents of the source. You can also attach TOC-specific tags to it. Then fill it with Gst.TocEntry entries by appending them to the Gst.Toc using Gst.Toc.append_entry(), and appending subentries to a Gst.TocEntry using Gst.TocEntry.append_sub_entry().

Note that root level of the TOC can contain only either editions or chapters. You should not mix them together at the same level. Otherwise you will get serialization /deserialization errors. Make sure that no one of the entries has negative start and stop values.

Use Gst.Event.new_toc() to create a new TOC Gst.Event, and Gst.Event.parse_toc() to parse received TOC event. Use Gst.Event.new_toc_select() to create a new TOC select Gst.Event, and Gst.Event.parse_toc_select() to parse received TOC select event. The same rule for the Gst.Message: Gst.Message.new_toc() to create new TOC Gst.Message, and Gst.Message.parse_toc() to parse received TOC message.

TOCs can have global scope or current scope. Global scope TOCs contain all entries that can possibly be selected using a toc select event, and are what an application is usually interested in. TOCs with current scope only contain the parts of the TOC relevant to the currently selected/playing stream; the current scope TOC is used by downstream elements such as muxers to write correct TOC entries when transcoding files, for example. When playing a DVD, the global TOC would contain a hierarchy of all titles, 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).

classmethod new(scope)[source]
Parameters:scope (Gst.TocScope) – scope of this TOC
Returns:newly allocated Gst.Toc structure, free it with gst_toc_unref().
Return type:Gst.Toc

Create a new Gst.Toc structure.

append_entry(entry)[source]
Parameters:entry (Gst.TocEntry) – A Gst.TocEntry

Appends the Gst.TocEntry entry to self.

dump()[source]
find_entry(uid)[source]
Parameters:uid (str) – UID to find Gst.TocEntry with.
Returns:Gst.TocEntry with specified uid from the self, or None if not found.
Return type:Gst.TocEntry or None

Find Gst.TocEntry with given uid in the self.

get_entries()[source]
Returns:A GLib.List of Gst.TocEntry for entry
Return type:[Gst.TocEntry]

Gets the list of Gst.TocEntry of self.

get_scope()[source]
Returns:scope of self
Return type:Gst.TocScope
get_tags()[source]
Returns:A Gst.TagList for entry
Return type:Gst.TagList

Gets the tags for self.

merge_tags(tags, mode)[source]
Parameters:

Merge tags into the existing tags of self using mode.

set_tags(tags)[source]
Parameters:tags (Gst.TagList or None) – A Gst.TagList or None

Set a Gst.TagList with tags for the complete self.