GI.Gst.Interfaces.TocSetter

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 tocSetterSetToc.

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

Exported types

newtype TocSetter

Memory-managed wrapper type.

Constructors

TocSetter (ManagedPtr TocSetter)

Instances

GObject TocSetter

Defined in GI.Gst.Interfaces.TocSetter

Methods

gobjectType :: IO GType

HasParentTypes TocSetter

Defined in GI.Gst.Interfaces.TocSetter

type ParentTypes TocSetter

Defined in GI.Gst.Interfaces.TocSetter

type ParentTypes TocSetter = Element ': (Object ': (Object ': ([] :: [Type])))

noTocSetter :: Maybe TocSetter

A convenience alias for Nothing :: Maybe TocSetter.

class (GObject o, IsDescendantOf TocSetter o) => IsTocSetter o

Type class for types which can be safely cast to TocSetter, for instance with toTocSetter.

Instances

(GObject o, IsDescendantOf TocSetter o) => IsTocSetter o

Defined in GI.Gst.Interfaces.TocSetter

toTocSetter :: (MonadIO m, IsTocSetter o) => o -> m TocSetter

Cast to TocSetter, for types for which this is known to be safe. For general casts, use castTo.

Methods

getToc

tocSetterGetToc

Arguments

:: (HasCallStack, MonadIO m, IsTocSetter a)

=> a

setter: a TocSetter.

-> m (Maybe Toc)

Returns: TOC set, or Nothing. Unref with gst_toc_unref() when no longer needed

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

reset

tocSetterReset

Arguments

:: (HasCallStack, MonadIO m, IsTocSetter a)

=> a

setter: a TocSetter.

-> m ()

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

setToc

tocSetterSetToc

Arguments

:: (HasCallStack, MonadIO m, IsTocSetter a)

=> a

setter: a TocSetter.

-> Maybe Toc

toc: a Toc to set.

-> m ()

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