Package org.freedesktop.gstreamer.gst

Interface TocSetter

All Superinterfaces:

Proxy

All Known Implementing Classes:

TocSetter.TocSetterImpl

@Generated("io.github.jwharm.JavaGI")
public interface TocSetter
extends Proxy

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 gst_toc_setter_set_toc().

Elements implementing the GstTocSetter interface can extend existing TOC by getting extend UID for that (you can use gst_toc_find_entry() to retrieve it) with any TOC entries received from downstream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TocSetter.TocSetterImpl	The TocSetterImpl type represents a native instance of the TocSetter interface.
static class	TocSetter.TocSetterInterface	GstTocSetterInterface interface.

Method Summary

Modifier and Type	Method	Description
default Toc	getToc()	Return current TOC the setter uses.
static Type	getType()	Get the GType of the TocSetter class
default void	reset()	Reset the internal TOC.
default void	setToc(@Nullable Toc toc)	Set the given TOC on the setter.

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Method Details

getType

static Type getType()

Get the GType of the TocSetter class

Returns:

the GType

getToc

default Toc getToc()

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

Returns:

TOC set, or null. Unref with gst_toc_unref() when no longer needed

reset

default void reset()

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

setToc

default void setToc(@Nullable
 @Nullable Toc toc)

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

Parameters:

toc - a GstToc to set.