colibrio-reader-framework/com.colibrio.readingsystem.base/SyncMediaTimeline

SyncMediaTimeline

A SyncMediaTimeline describes arbitrary media (such as audio or video) and how to synchronize them with the publication content.

The timeline contains a list of segments defining the playback order of mediaObjects.

A SyncMediaTimeline is played using a SyncMediaPlayer.

SyncMediaTimeline instances are created from ReaderPublication instances. For example: EpubReaderPublication.createMediaOverlaySyncMediaTimeline

Properties

approximateDurationMs

abstract val approximateDurationMs: Int

Returns the approximate total duration of the timeline in milliseconds. This value may be updated during playback as media is loaded and more information becomes available. When updated, OnSyncMediaPlayerEventListener.onSegmentDurationChanged will be called.

mediaObjects

abstract val mediaObjects: List<SyncMediaObjectData>

The media objects, such as audio and video resources, used by this timeline. Media objects are referenced by SyncMediaSegments

readerPublicationDefaultLocatorUrl

abstract val readerPublicationDefaultLocatorUrl: String

The base URL of the ReaderPublication this timeline was created from. This value will match ReaderPublication.defaultLocatorUrl.

segments

abstract val segments: List<SyncMediaSegmentData>

All segments in the timeline defining the playback order of mediaObjects.

syncMediaFormat

abstract val syncMediaFormat: SyncMediaFormat

The source sync media format this timeline was built from.

Functions

fetchLocator

abstract suspend fun fetchLocator(position: SyncMediaTimelinePositionData): ColibrioResult<SimpleLocatorData>

abstract fun fetchLocator(position: SyncMediaTimelinePositionData, onSuccess: (SimpleLocatorData) -> Unit, onError: (ColibrioException) -> Unit)

Find the locator that most closely corresponds to the timeline position.

fetchTimelinePosition

abstract suspend fun fetchTimelinePosition(locator: SimpleLocatorData): ColibrioResult<SyncMediaTimelinePositionData>

abstract fun fetchTimelinePosition(locator: SimpleLocatorData, onSuccess: (SyncMediaTimelinePositionData) -> Unit, onError: (ColibrioException) -> Unit)

Find the SyncMediaTimelinePositionData that most closely corresponds to a locator.

abstract suspend fun fetchTimelinePosition(navigationItem: ReaderPublicationNavigationItem): ColibrioResult<SyncMediaTimelinePositionData>

abstract fun fetchTimelinePosition(navigationItem: ReaderPublicationNavigationItem, onSuccess: (SyncMediaTimelinePositionData) -> Unit, onError: (ColibrioException) -> Unit)

Find the SyncMediaTimelinePositionData that most closely corresponds to a navigationItem.

fetchTimelineRange

abstract suspend fun fetchTimelineRange(locator: SimpleLocatorData): ColibrioResult<SyncMediaTimelineRangeData>

abstract fun fetchTimelineRange(locator: SimpleLocatorData, onSuccess: (SyncMediaTimelineRangeData) -> Unit, onError: (ColibrioException) -> Unit)

Find the timeline range that most closely corresponds to a range Locator.

getApproximateOffsetMs

abstract fun getApproximateOffsetMs(position: SyncMediaTimelinePositionData): Int

Get the approximate offset into the timeline in milliseconds from a timeline position object.

getTimelinePositionFromApproximateOffsetMs

abstract fun getTimelinePositionFromApproximateOffsetMs(approximateOffsetMs: Int): SyncMediaTimelinePositionData

Get the timeline position that most closely matches an offset into the timeline. If the offset is negative, the position at the start of the timeline will be returned. If the offset is larger than the duration of the timeline, the position at the end of the timeline will be returned.