Toc

#GstToc functions are used to create/free #GstToc and #GstTocEntry structures. Also they are used to convert #GstToc into #GstStructure and vice versa.

#GstToc 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 #GstToc structure which represents root contents of the source. You can also attach TOC-specific tags to it. Then fill it with #GstTocEntry entries by appending them to the #GstToc using gst_toc_append_entry(), and appending subentries to a #GstTocEntry using gst_toc_entry_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 #GstEvent, and gst_event_parse_toc() to parse received TOC event. Use gst_event_new_toc_select() to create a new TOC select #GstEvent, and gst_event_parse_toc_select() to parse received TOC select event. The same rule for the #GstMessage: gst_message_new_toc() to create new TOC #GstMessage, 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).

Constructors

this
this(GstToc* gstToc, bool ownedRef)

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

this
this(GstTocScope scop)

Create a new #GstToc structure.

Members

Functions

appendEntry
void appendEntry(TocEntry entry)

Appends the #GstTocEntry @entry to @toc.

dump
void dump()
findEntry
TocEntry findEntry(string uid)

Find #GstTocEntry with given @uid in the @toc.

getEntries
ListG getEntries()

Gets the list of #GstTocEntry of @toc.

getScope
GstTocScope getScope()
getStruct
void* getStruct()

the main Gtk struct as a void*

getTags
TagList getTags()

Gets the tags for @toc.

getTocStruct
GstToc* getTocStruct(bool transferOwnership)

Get the main Gtk struct

mergeTags
void mergeTags(TagList tags, GstTagMergeMode mode)

Merge @tags into the existing tags of @toc using @mode.

setTags
void setTags(TagList tags)

Set a #GstTagList with tags for the complete @toc.

Static functions

getType
GType getType()

Variables

gstToc
GstToc* gstToc;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.

Meta