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

gstreamer.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 gstreamer.Toc structure which represents root contents of the source. You can also attach TOC-specific tags to it. Then fill it with gstreamer.TocEntry entries by appending them to the gstreamer.Toc using Toc.appendEntry, and appending subentries to a gstreamer.TocEntry using Toc.entryAppendSubEntry.

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 Event.newToc to create a new TOC gstreamer.Event, and Event.parseToc to parse received TOC event. Use Event.newTocSelect to create a new TOC select gstreamer.Event, and Event.parseTocSelect to parse received TOC select event. The same rule for the gstreamer.Message.get Message.newToc to create new TOC gstreamer.Message, and Message.parseToc 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).


this(GstToc* gstToc, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

this(GstTocScope scop)

Create a new gstreamer.Toc structure.



void appendEntry(TocEntry entry)

Appends the gstreamer.TocEntry entry to toc.

void dump()
TocEntry findEntry(string uid)

Find gstreamer.TocEntry with given uid in the toc.

ListG getEntries()

Gets the list of gstreamer.TocEntry of toc.

GstTocScope getScope()
void* getStruct()

the main Gtk struct as a void*

TagList getTags()

Gets the tags for toc.

GstToc* getTocStruct(bool transferOwnership = false)

Get the main Gtk struct

void mergeTags(TagList tags, GstTagMergeMode mode)

Merge tags into the existing tags of toc using mode.

void setTags(TagList tags)

Set a gstreamer.TagList with tags for the complete toc.

Static functions

GType getType()


GstToc* gstToc;

the main Gtk struct