:right-sidebar: True

TocSetter
===================================================================

.. currentmodule:: gi.repository.Gst





.. class:: TocSetter(*args, **kwargs)
   :no-contents-entry:






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 :func:`~gi.repository.Gst.TocSetter.set_toc`.

Elements implementing the :obj:`~gi.repository.Gst.TocSetter` interface can extend existing TOC
by getting extend UID for that (you can use :func:`~gi.repository.Gst.Toc.find_entry` to retrieve it)
with any TOC entries received from downstream.




Methods
-------

.. rst-class:: interim-class

.. class:: TocSetter
   :no-index:


   .. method:: get_toc() -> ~gi.repository.Gst.Toc | None

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









   .. method:: reset() -> None

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









   .. method:: set_toc(toc: ~gi.repository.Gst.Toc | None = None) -> None

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






      :param toc: a :obj:`~gi.repository.Gst.Toc` to set.