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

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.

Constructors

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

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

val mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange

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

Link copied to clipboard
val nextTimelineRange: SyncMediaTimelineRangeData?

The SyncMedia timeline range corresponding to the ReaderView's next content range. If there is no sync media present in the content range, the start and end position will be equal. Will be null if the ReaderView has no next content range (i.e. is at end).

Link copied to clipboard
val previousTimelineRange: SyncMediaTimelineRangeData?

The SyncMedia timeline range corresponding to the ReaderView's previous content range. If there is no sync media present in the content range, the start and end position will be equal. Will be null if the ReaderView has no previous content range (i.e. is at start).

Link copied to clipboard
val resolvedMediaPlayerPosition: SyncMediaResolvedLocatorData

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

Link copied to clipboard
val resolvedReaderViewReadingPosition: SyncMediaResolvedLocatorData

The ReaderView reading position and the corresponding SyncMediaTimelinePosition.

Link copied to clipboard
val triggeredBy: SyncMediaSyncEventTrigger

The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.

Link copied to clipboard
val visibleTimelineRange: SyncMediaTimelineRangeData

The SyncMedia timeline range corresponding to the ReaderView's visible content range. If there is no sync media present in the content range, the start and end position will be equal.