colibrio-reader-framework/com.colibrio.readingsystem.audio/AudioTimeline

AudioTimeline

interface AudioTimeline

An AudioTimeline represents the playback order of the audio publication content.

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

An AudioTimeline is played using a ColibrioAudioPlayer.

AudioTimeline instances are created from AudioPublication instances. For example: WpAudioPublication.createAudioTimeline

Properties

Link copied to clipboard
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, OnMediaPlayerEventListener.onSegmentDurationChanged will be called.

Link copied to clipboard
abstract val mediaObjects: List<SyncMediaObjectData>

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

Link copied to clipboard
abstract val segments: List<SyncMediaSegmentData>

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

Functions

Link copied to clipboard
abstract fun getApproximateOffsetMs(position: SyncMediaTimelinePositionData): Int

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

Link copied to clipboard
abstract fun getNavigationItemReferences(    timelinePosition: SyncMediaTimelinePositionData,     publicationNavigation: ReaderPublicationNavigation,     options: FetchNavigationItemReferencesOptions): FetchNavigationItemReferencesResult

Returns the navigation item references related to the specified timeline position.

Link copied to clipboard
abstract fun getTimelinePosition(navigationItem: ReaderPublicationNavigationItem): ColibrioResult<SyncMediaTimelinePositionData>

Find the SyncMediaTimelinePositionData that most closely corresponds to a PublicationNavigationItem.

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.