Options
All
  • Public
  • Public/Protected
  • All
Menu

A SyncMediaTimeline is created by calling any of the createSyncMediaTimeline() methods on a ReaderPublication. Each publication format supports different sync media formats. EPUB supports Media Overlays as well as content block based TTS, whereas PDF only supports content block based TTS. For example: EpubReaderPublication.createMediaOverlaySyncMediaTimeline() or EpubReaderPublication.createTtsSyncMediaTimeline()

The SyncMediaTimeline contains a list of segments that should be played in order. Each segment contains references to media objects that should be played in parallel.

The SyncMediaTimeline also contains methods for mapping between SyncMediaTimelinePositions and ContentLocations. This feature allows the reading system to synchronize SyncMedia playback with visible publication content such as automatic page turning and highlighting of narrated content.

Hierarchy

  • ISyncMediaTimelineData

Index

Properties

approximateDurationMs

approximateDurationMs: number

It is possible that this duration is updated during runtime as media is loaded and more information is available. If that happens, a 'syncMediaSegmentDurationChanged' event is fired.

int

mediaObjectRefTypes

mediaObjectRefTypes: string[]

List of all media object ref types that MAY be present in this timeline.

mediaObjects

mediaObjects: ISyncMediaObjectData[]

Media objects used by this timeline.

readerPublicationDefaultLocatorUrl

readerPublicationDefaultLocatorUrl: string

The default Locator URL of the ReaderPublication this timeline was created from.

segments

all segments in the timeline defining the playback order of media objects.

syncMediaFormat

syncMediaFormat: SyncMediaFormat

The source sync media format.

Generated using TypeDoc