GstTocSetter

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_set_toc.

Elements implementing the GstTocSetter interface can extend existing TOC by getting extend UID for that (you can use gst_toc_find_entry to retrieve it) with any TOC entries received from downstream.

GstTocSetter

Opaque GstTocSetter data structure.


Gst.TocSetter

Opaque Gst.TocSetter data structure.


Gst.TocSetter

Opaque Gst.TocSetter data structure.


Methods

gst_toc_setter_get_toc

GstToc *
gst_toc_setter_get_toc (GstTocSetter * setter)

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

Parameters:

setter

a GstTocSetter.

Returns ( [transfer: full][nullable])

TOC set, or NULL. Unref with gst_toc_unref when no longer needed


Gst.TocSetter.prototype.get_toc

function Gst.TocSetter.prototype.get_toc(): {
    // javascript wrapper for 'gst_toc_setter_get_toc'
}

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.

Returns (Gst.Toc)

TOC set, or null. Unref with gst_toc_unref (not introspectable) when no longer needed


Gst.TocSetter.get_toc

def Gst.TocSetter.get_toc (self):
    #python wrapper for 'gst_toc_setter_get_toc'

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.

Returns (Gst.Toc)

TOC set, or None. Unref with gst_toc_unref (not introspectable) when no longer needed


gst_toc_setter_reset

gst_toc_setter_reset (GstTocSetter * setter)

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

Parameters:

setter

a GstTocSetter.


Gst.TocSetter.prototype.reset

function Gst.TocSetter.prototype.reset(): {
    // javascript wrapper for 'gst_toc_setter_reset'
}

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.


Gst.TocSetter.reset

def Gst.TocSetter.reset (self):
    #python wrapper for 'gst_toc_setter_reset'

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.


gst_toc_setter_set_toc

gst_toc_setter_set_toc (GstTocSetter * setter,
                        GstToc * toc)

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

Parameters:

setter

a GstTocSetter.

toc ( [allow-none])

a GstToc to set.


Gst.TocSetter.prototype.set_toc

function Gst.TocSetter.prototype.set_toc(toc: Gst.Toc): {
    // javascript wrapper for 'gst_toc_setter_set_toc'
}

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.

toc (Gst.Toc)

a Gst.Toc to set.


Gst.TocSetter.set_toc

def Gst.TocSetter.set_toc (self, toc):
    #python wrapper for 'gst_toc_setter_set_toc'

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

Parameters:

setter (Gst.TocSetter)

a Gst.TocSetter.

toc (Gst.Toc)

a Gst.Toc to set.


The results of the search are