Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • ISyncMediaReaderViewSynchronizationStateData

Index

Properties

mediaPlayerPositionRelativeToVisibleRange

mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange

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

nextTimelineRange

nextTimelineRange: ISyncMediaTimelineRangeData

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.

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).

previousTimelineRange

previousTimelineRange: ISyncMediaTimelineRangeData

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.

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).

resolvedMediaPlayerPosition

resolvedMediaPlayerPosition: ISyncMediaResolvedLocatorData

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

resolvedReaderViewReadingPosition

resolvedReaderViewReadingPosition: ISyncMediaResolvedLocatorData

The ReaderView reading position and the corresponding SyncMediaTimelinePosition.

triggeredBy

The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.

visibleTimelineRange

visibleTimelineRange: ISyncMediaTimelineRangeData

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.

If there is no sync media present in the content range, the start and end position will be equal.

Generated using TypeDoc