:right-sidebar: True

Toc
===================================================================

.. currentmodule:: gi.repository.Gst





.. class:: Toc(**kwargs)
   :no-contents-entry:






:Constructors:

::

    new(scope:Gst.TocScope) -> Gst.Toc



Constructors
------------

.. rst-class:: interim-class

.. class:: Toc
   :no-index:


   .. classmethod:: new(scope: ~gi.repository.Gst.TocScope) -> ~gi.repository.Gst.Toc

      Create a new :obj:`~gi.repository.Gst.Toc` structure.







      :param scope: scope of this TOC









Methods
-------

.. rst-class:: interim-class

.. class:: Toc
   :no-index:


   .. method:: append_entry(entry: ~gi.repository.Gst.TocEntry) -> None

      Appends the :obj:`~gi.repository.Gst.TocEntry` ``entry`` to ``toc``.







      :param entry: A :obj:`~gi.repository.Gst.TocEntry`





   .. method:: dump() -> None

      









   .. method:: find_entry(uid: str) -> ~gi.repository.Gst.TocEntry | None

      Find :obj:`~gi.repository.Gst.TocEntry` with given ``uid`` in the ``toc``.







      :param uid: UID to find :obj:`~gi.repository.Gst.TocEntry` with.





   .. method:: get_entries() -> list[~gi.repository.Gst.TocEntry]

      Gets the list of :obj:`~gi.repository.Gst.TocEntry` of ``toc``.










   .. method:: get_scope() -> ~gi.repository.Gst.TocScope

      









   .. method:: get_tags() -> ~gi.repository.Gst.TagList | None

      Gets the tags for ``toc``.










   .. method:: merge_tags(tags: ~gi.repository.Gst.TagList | None, mode: ~gi.repository.Gst.TagMergeMode) -> None

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







      :param tags: A :obj:`~gi.repository.Gst.TagList` or :const:`None`


      :param mode: A :obj:`~gi.repository.Gst.TagMergeMode`





   .. method:: set_tags(tags: ~gi.repository.Gst.TagList | None = None) -> None

      Set a :obj:`~gi.repository.Gst.TagList` with tags for the complete ``toc``.







      :param tags: A :obj:`~gi.repository.Gst.TagList` or :const:`None`