gst.toc_setter_mixin

Module for [TocSetter] interface mixin

tmpl TocSetterGidBuilderT TocSetterT

Templates 2

tmplTocSetterT()

Element interface that allows setting of the TOC.

Elements that support some kind of chapters or editions (or tracks like in the FLAC cue sheet) will implement this interface.

If you just want to retrieve the TOC in your application then all you need to do is watch for TOC messages on your pipeline's bus (or you can perform TOC query). This interface is only for setting TOC data, not for extracting it. To set TOC from the application, find proper tocsetter element and set TOC using [gst.toc_setter.TocSetter.setToc].

Elements implementing the #GstTocSetter interface can extend existing TOC by getting extend UID for that (you can use [gst.toc.Toc.findEntry] to retrieve it) with any TOC entries received from downstream.

Functions
gst.toc.Toc getToc()

Return current TOC the setter uses. The TOC should not be modified without making it writable first.

Returns

TOC set, or null. Unref with

gst_toc_unref() when no longer needed

void reset()

Reset the internal TOC. Elements should call this from within the state-change handler.

void setToc(gst.toc.Toc toc = null)

Set the given TOC on the setter. Previously set TOC will be unreffed before setting a new one.

Parameters

toca #GstToc to set.
tmplTocSetterGidBuilderT()