Toc

class Toc(**kwargs)

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

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 Toc structure which represents root contents of the source. You can also attach TOC-specific tags to it. Then fill it with TocEntry entries by appending them to the Toc using append_entry(), and appending subentries to a TocEntry using 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 new_toc() to create a new TOC Event, and parse_toc() to parse received TOC event. Use new_toc_select() to create a new TOC select Event, and parse_toc_select() to parse received TOC select event. The same rule for the Message: new_toc() to create new TOC Message, and 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).

Constructors

class Toc

classmethod new(scope: TocScope) → Toc

Create a new Toc structure.

Parameters:

scope – scope of this TOC

Methods

class Toc

append_entry(entry: TocEntry) → None

Appends the TocEntry entry to toc.

Parameters:

entry – A TocEntry

dump() → None

find_entry(uid: str) → TocEntry | None

Find TocEntry with given uid in the toc.

Parameters:

uid – UID to find TocEntry with.

get_entries() → list[TocEntry]

Gets the list of TocEntry of toc.

get_scope() → TocScope

get_tags() → TagList | None

Gets the tags for toc.

merge_tags(tags: TagList | None, mode: TagMergeMode) → None

Merge tags into the existing tags of toc using mode.

Parameters:

• tags – A TagList or None

• mode – A TagMergeMode

set_tags(tags: TagList | None = None) → None

Set a TagList with tags for the complete toc.

Parameters:

tags – A TagList or None