| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gst.Structs.Toc
Description
Toc functions are used to create/free Toc and TocEntry structures.
Also they are used to convert Toc into Structure and vice versa.
Toc lets you to inform other elements in pipeline or application that playing
source has some kind of table of contents (TOC). These may be chapters, editions,
angles or other types. For example: DVD chapters, Matroska chapters or cue sheet
TOC. Such TOC will be useful for applications to display instead of just a
playlist.
Using TOC is very easy. Firstly, create Toc structure which represents root
contents of the source. You can also attach TOC-specific tags to it. Then fill
it with TocEntry entries by appending them to the Toc using
tocAppendEntry, and appending subentries to a TocEntry using
tocEntryAppendSubEntry.
Note that root level of the TOC can contain only either editions or chapters. You should not mix them together at the same level. Otherwise you will get serialization /deserialization errors. Make sure that no one of the entries has negative start and stop values.
Use eventNewToc to create a new TOC Event, and eventParseToc to
parse received TOC event. Use eventNewTocSelect to create a new TOC select Event,
and eventParseTocSelect to parse received TOC select event. The same rule for
the Message: messageNewToc to create new TOC Message, and
messageParseToc to parse received TOC message.
TOCs can have global scope or current scope. Global scope TOCs contain all entries that can possibly be selected using a toc select event, and are what an application is usually interested in. TOCs with current scope only contain the parts of the TOC relevant to the currently selected/playing stream; the current scope TOC is used by downstream elements such as muxers to write correct TOC entries when transcoding files, for example. When playing a DVD, the global TOC would contain a hierarchy of all titles, chapters and angles, for example, while the current TOC would only contain the chapters for the currently playing title if playback of a specific title was requested.
Applications and plugins should not rely on TOCs having a certain kind of structure, but should allow for different alternatives. For example, a simple CUE sheet embedded in a file may be presented as a flat list of track entries, or could have a top-level edition node (or some other alternative type entry) with track entries underneath that node; or even multiple top-level edition nodes (or some other alternative type entries) each with track entries underneath, in case the source file has extracted a track listing from different sources).
Synopsis
- newtype Toc = Toc (ManagedPtr Toc)
- noToc :: Maybe Toc
- tocAppendEntry :: (HasCallStack, MonadIO m) => Toc -> TocEntry -> m ()
- tocDump :: (HasCallStack, MonadIO m) => Toc -> m ()
- tocFindEntry :: (HasCallStack, MonadIO m) => Toc -> Text -> m (Maybe TocEntry)
- tocGetEntries :: (HasCallStack, MonadIO m) => Toc -> m [TocEntry]
- tocGetScope :: (HasCallStack, MonadIO m) => Toc -> m TocScope
- tocGetTags :: (HasCallStack, MonadIO m) => Toc -> m TagList
- tocMergeTags :: (HasCallStack, MonadIO m) => Toc -> Maybe TagList -> TagMergeMode -> m ()
- tocNew :: (HasCallStack, MonadIO m) => TocScope -> m Toc
- tocSetTags :: (HasCallStack, MonadIO m) => Toc -> Maybe TagList -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Toc (ManagedPtr Toc) |
Methods
Overloaded methods
appendEntry
Appends the TocEntry entry to toc.
dump
tocDump :: (HasCallStack, MonadIO m) => Toc -> m () Source #
No description available in the introspection data.
findEntry
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Toc |
|
| -> Text |
|
| -> m (Maybe TocEntry) | Returns: |
Find TocEntry with given uid in the toc.
getEntries
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Toc |
|
| -> m [TocEntry] |
Gets the list of TocEntry of toc.
getScope
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Toc |
|
| -> m TocScope | Returns: scope of |
No description available in the introspection data.
getTags
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Toc |
|
| -> m TagList | Returns: A |
Gets the tags for toc.
mergeTags
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Toc |
|
| -> Maybe TagList | |
| -> TagMergeMode |
|
| -> m () |
Merge tags into the existing tags of toc using mode.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => TocScope |
|
| -> m Toc | Returns: newly allocated |
Create a new Toc structure.