Module: Gst::TocSetter

Defined in:

(unknown)

Overview

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 Gst::TocSetter 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.

Instance Method Summary

• #reset ⇒ nil

  Reset the internal TOC.

• #toc ⇒ Gst::Toc

  Return current TOC the setter uses.

• #toc=(toc) ⇒ nil

  Set the given TOC on the setter.

Instance Method Details

#reset ⇒ nil

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

Returns:

• (nil)

#toc ⇒ Gst::Toc

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

Returns:

• (Gst::Toc) —

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

#toc=(toc) ⇒ nil

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

Parameters:

• toc (Gst::Toc) —

  a Gst::Toc to set.

Returns:

• (nil)