TocEntry#

class TocEntry(**kwargs)#
Constructors:

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

Constructors#

class TocEntry
classmethod new(type: TocEntryType, uid: str) → TocEntry#

Create new TocEntry structure.

Parameters:

  • type – entry type.

  • uid – unique ID (UID) in the whole TOC.

Methods#

class TocEntry
append_sub_entry(subentry: TocEntry) → None#

Appends the TocEntry subentry to entry.

Parameters:

subentry – A TocEntry

get_entry_type() → TocEntryType#
get_loop() → Tuple[bool, 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.

Added in version 1.4.

get_parent() → TocEntry | None#

Gets the parent TocEntry of entry.

get_start_stop_times() → Tuple[bool, int, int]#

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

get_sub_entries() → list[TocEntry]#

Gets the sub-entries of entry.

get_tags() → TagList | None#

Gets the tags for entry.

get_toc() → Toc | None#

Gets the parent Toc of entry.

get_uid() → str#

Gets the UID of entry.

is_alternative() → bool#
is_sequence() → bool#
merge_tags(tags: TagList | None, mode: TagMergeMode) → None#

Merge tags into the existing tags of entry using mode.

Parameters:
set_loop(loop_type: TocLoopType, repeat_count: int) → None#

Set loop_type and repeat_count values for the entry.

Added in version 1.4.

Parameters:

  • loop_type – loop_type value to set.

  • repeat_count – repeat_count value to set.

set_start_stop_times(start: int, stop: int) → None#

Set start and stop values for the entry.

Parameters:

  • start – start value to set.

  • stop – stop value to set.

set_tags(tags: TagList | None = None) → None#

Set a TagList with tags for the complete entry.

Parameters:

tags – A TagList or None