:right-sidebar: True

TocEntry
===================================================================

.. currentmodule:: gi.repository.Gst





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






:Constructors:

::

    new(type:Gst.TocEntryType, uid:str) -> Gst.TocEntry



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

.. rst-class:: interim-class

.. class:: TocEntry
   :no-index:


   .. classmethod:: new(type: ~gi.repository.Gst.TocEntryType, uid: str) -> ~gi.repository.Gst.TocEntry

      Create new :obj:`~gi.repository.Gst.TocEntry` structure.






      :param type: entry type.

      :param uid: unique ID (UID) in the whole TOC.








Methods
-------

.. rst-class:: interim-class

.. class:: TocEntry
   :no-index:


   .. method:: append_sub_entry(subentry: ~gi.repository.Gst.TocEntry) -> None

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






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




   .. method:: get_entry_type() -> ~gi.repository.Gst.TocEntryType

      









   .. method:: get_loop() -> ~typing.Tuple[bool, ~gi.repository.Gst.TocLoopType, int]

      Get ``loop_type`` and ``repeat_count`` values from the ``entry`` and write them into
      appropriate storages. Loops are e.g. used by sampled instruments. GStreamer
      is not automatically applying the loop. The application can process this
      meta data and use it e.g. to send a seek-event to loop a section.


      .. versionadded:: 1.4








   .. method:: get_parent() -> ~gi.repository.Gst.TocEntry | None

      Gets the parent :obj:`~gi.repository.Gst.TocEntry` of ``entry``\.









   .. method:: get_start_stop_times() -> ~typing.Tuple[bool, int, int]

      Get ``start`` and ``stop`` values from the ``entry`` and write them into appropriate
      storages.









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

      Gets the sub-entries of ``entry``\.









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

      Gets the tags for ``entry``\.









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

      Gets the parent :obj:`~gi.repository.Gst.Toc` of ``entry``\.









   .. method:: get_uid() -> str

      Gets the UID of ``entry``\.









   .. method:: is_alternative() -> bool

      









   .. method:: is_sequence() -> bool

      









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

      Merge ``tags`` into the existing tags of ``entry`` using ``mode``\.






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

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




   .. method:: set_loop(loop_type: ~gi.repository.Gst.TocLoopType, repeat_count: int) -> None

      Set ``loop_type`` and ``repeat_count`` values for the ``entry``\.


      .. versionadded:: 1.4





      :param loop_type: loop_type value to set.

      :param repeat_count: repeat_count value to set.




   .. method:: set_start_stop_times(start: int, stop: int) -> None

      Set ``start`` and ``stop`` values for the ``entry``\.






      :param start: start value to set.

      :param stop: stop value to set.




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

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






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