Gst.TocEntry¶

Fields¶

None

Methods¶

class	`new` (type, uid)
	`append_sub_entry` (subentry)
	`get_entry_type` ()
	`get_loop` ()
	`get_parent` ()
	`get_start_stop_times` ()
	`get_sub_entries` ()
	`get_tags` ()
	`get_toc` ()
	`get_uid` ()
	`is_alternative` ()
	`is_sequence` ()
	`merge_tags` (tags, mode)
	`set_loop` (loop_type, repeat_count)
	`set_start_stop_times` (start, stop)
	`set_tags` (tags)

Details¶

class Gst.TocEntry¶

classmethod new(type, uid)[source]¶

Parameters:	type (`Gst.TocEntryType`) – entry type. uid (`str`) – unique ID (UID) in the whole TOC.
Returns:	newly allocated `Gst.TocEntry` structure, free it with gst_toc_entry_unref().
Return type:	`Gst.TocEntry`

Create new Gst.TocEntry structure.

append_sub_entry(subentry)[source]¶

Parameters:	subentry (`Gst.TocEntry`) – A `Gst.TocEntry`

Appends the Gst.TocEntry subentry to self.

get_entry_type()[source]¶

Returns:	self’s entry type
Return type:	`Gst.TocEntryType`

get_loop()[source]¶

Returns:

True if all non-None storage pointers were filled with appropriate values, False otherwise.

loop_type:	the storage for the loop_type value, leave `None` if not need.
repeat_count:	the storage for the repeat_count value, leave `None` if not need.

Return type: (bool, loop_type: Gst.TocLoopType, repeat_count: int)

Get loop_type and repeat_count values from the self 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.

New in version 1.4.

get_parent()[source]¶

Returns:	The parent `Gst.TocEntry` of self
Return type:	`Gst.TocEntry` or `None`

Gets the parent Gst.TocEntry of self.

get_start_stop_times()[source]¶

Returns:

True if all non-None storage pointers were filled with appropriate values, False otherwise.

start:	the storage for the start value, leave `None` if not need.
stop:	the storage for the stop value, leave `None` if not need.

Return type: (bool, start: int, stop: int)

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

get_sub_entries()[source]¶

Returns:	A `GLib.List` of `Gst.TocEntry` of self
Return type:	[`Gst.TocEntry`]

Gets the sub-entries of self.

get_tags()[source]¶

Returns:	A `Gst.TagList` for self
Return type:	`Gst.TagList`

Gets the tags for self.

get_toc()[source]¶

Returns:	The parent `Gst.Toc` of self
Return type:	`Gst.Toc`

Gets the parent Gst.Toc of self.

get_uid()[source]¶

Returns:	The UID of self
Return type:	`str`

Gets the UID of self.

is_alternative()[source]¶

Returns:	`True` if self’s type is an alternative type, otherwise `False`
Return type:	`bool`

is_sequence()[source]¶

Returns:	`True` if self’s type is a sequence type, otherwise `False`
Return type:	`bool`

merge_tags(tags, mode)[source]¶

Parameters:	tags (`Gst.TagList` or `None`) – A `Gst.TagList` or `None` mode (`Gst.TagMergeMode`) – A `Gst.TagMergeMode`

Merge tags into the existing tags of self using mode.

set_loop(loop_type, repeat_count)[source]¶

Parameters:	loop_type (`Gst.TocLoopType`) – loop_type value to set. repeat_count (`int`) – repeat_count value to set.

Set loop_type and repeat_count values for the self.

New in version 1.4.

set_start_stop_times(start, stop)[source]¶

Parameters:	start (`int`) – start value to set. stop (`int`) – stop value to set.

Set start and stop values for the self.

set_tags(tags)[source]¶

Parameters:	tags (`Gst.TagList` or `None`) – A `Gst.TagList` or `None`

Set a Gst.TagList with tags for the complete self.