colibrio-reader-framework/com.colibrio.readingsystem.base/SyncMediaPlayer/attemptReaderViewSynchronization

attemptReaderViewSynchronization

abstract fun attemptReaderViewSynchronization(method: SyncMediaReaderViewSynchronizationMethod, timelinePosition: SyncMediaTimelinePositionData? = null, locator: SimpleLocatorData? = null)

Attempts to synchronize the player with the ReaderView using the given method.

If managed synchronization is enabled by the managedReaderViewSynchronizationOptions, this method is called automatically by the reading system.

If the SyncMediaPlayer is not attached to a ReaderView, this method does nothing.

Parameters

method

  • the method that will be used to attempt synchronization.

timelinePosition

  • If set, it will be used instead of resolving a new SyncMediaTimelinePosition from the ReaderView's readingPosition. (Only relevant if method is SEEK_SYNC_MEDIA)

locator

  • If set, it will be used instead of resolving a new content location from the current timelinePosition. (Only relevant if method is NAVIGATE_VIEW_GOTO)