SyncMediaReaderViewSynchronizationStateData

data class SyncMediaReaderViewSynchronizationStateData(val mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange, val nextTimelineRange: SyncMediaTimelineRangeData?, val previousTimelineRange: SyncMediaTimelineRangeData?, val resolvedMediaPlayerPosition: SyncMediaResolvedLocatorData, val resolvedReaderViewReadingPosition: SyncMediaResolvedLocatorData, val triggeredBy: SyncMediaSyncEventTrigger, val visibleTimelineRange: SyncMediaTimelineRangeData)

Describes the synchronization state between a SyncMediaPlayer and a ReaderView.

Before you use this data to try to achieve a specific synchronization behaviour between the ReaderView and SyncMediaPlayer, please note that synchronization is an advanced topic. It is very likely that what you are trying to achieve is already available through SyncMediaPlayer.setManagedReaderViewSynchronizationOptions() or SyncMediaPlayer.setReaderViewSynchronizationWaitBehavior(). Please contact Colibrio if you are missing a specific type of synchronization behaviour.

Constructors

constructor(mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange, nextTimelineRange: SyncMediaTimelineRangeData?, previousTimelineRange: SyncMediaTimelineRangeData?, resolvedMediaPlayerPosition: SyncMediaResolvedLocatorData, resolvedReaderViewReadingPosition: SyncMediaResolvedLocatorData, triggeredBy: SyncMediaSyncEventTrigger, visibleTimelineRange: SyncMediaTimelineRangeData)

Types

Link copied to clipboard
object Companion

Properties

The SyncMediaPlayer position relative to the ReaderView's visible range.

Link copied to clipboard

The SyncMedia timeline range corresponding to the ReaderView's next content range. The end of the range is NOT considered as a part of the range, but describes the position just ofter the range.

Link copied to clipboard

The SyncMedia timeline range corresponding to the ReaderView's previous content range. The end of the range is NOT considered as a part of the range, but describes the position just ofter the range.

Link copied to clipboard

The SyncMediaPlayer position and the corresponding locator in the reader publication.

Link copied to clipboard

The ReaderView reading position and the corresponding SyncMediaTimelinePosition.

Link copied to clipboard

The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.

Link copied to clipboard

The SyncMedia timeline range corresponding to the ReaderView's visible content range. The end of the range is NOT considered as a part of the range, but describes the position just ofter the range.

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)