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

SyncMediaManagedReaderViewSynchronizationOptions

data class SyncMediaManagedReaderViewSynchronizationOptions(val alwaysSeekToSegmentStart: Boolean = false, val enabled: Boolean = true, val minimumTimeToDisplayPagesWithSyncMedia: Int = 0, val navigateOnVisibleRangeEndReached: Boolean = true, val skipPagesWithoutSyncMedia: Boolean = false, val timeToDisplayPagesWithoutSyncMedia: Int = 2000)

Options specifying the behavior for managed synchronization between a SyncMediaPlayer and a ReaderView.

Constructors

constructor(alwaysSeekToSegmentStart: Boolean = false, enabled: Boolean = true, minimumTimeToDisplayPagesWithSyncMedia: Int = 0, navigateOnVisibleRangeEndReached: Boolean = true, skipPagesWithoutSyncMedia: Boolean = false, timeToDisplayPagesWithoutSyncMedia: Int = 2000)

Types

Companion

object Companion

Properties

alwaysSeekToSegmentStart

val alwaysSeekToSegmentStart: Boolean = false

If set to true, the sync media player will always seek to the start of the segment that best matches the ReaderView's current readingPosition.

enabled

val enabled: Boolean = true

If managed synchronization should be enabled. This will enable automatic page turning when media playback reaches the end of the visible range, and seeking of sync media to match visible content when the ReaderView is navigated.

minimumTimeToDisplayPagesWithSyncMedia

val minimumTimeToDisplayPagesWithSyncMedia: Int = 0

The minimum amount of time in milliseconds to display pages with sync media. This can be useful if for example a page only contains one SyncMediaSegment with a very short duration. This allows the user to see the page content properly before the ReaderView navigates to the next page.

navigateOnVisibleRangeEndReached

val navigateOnVisibleRangeEndReached: Boolean = true

Automatically navigate the ReaderView when media playback reaches the end of the visible range. Note that if there is only a small amount of media to be played on the visible pages, it will navigate after that media has been played.

skipPagesWithoutSyncMedia

val skipPagesWithoutSyncMedia: Boolean = false

This option controls if pages without sync media should be skipped if navigateOnVisibleRangeEndReached is set to true.

timeToDisplayPagesWithoutSyncMedia

val timeToDisplayPagesWithoutSyncMedia: Int = 2000

The amount of time in milliseconds to wait before navigating to next page, when the current visible range contains no sync media.

Functions

serialize

fun serialize(generator: JsonGenerator)