Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISyncMediaReaderViewSynchronizationState

    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.

    interface ISyncMediaReaderViewSynchronizationState {
        mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange;
        nextTimelineRange: ISyncMediaTimelineRange;
        previousTimelineRange: ISyncMediaTimelineRange;
        resolvedMediaPlayerPosition: ISyncMediaResolvedContentLocation;
        resolvedReaderViewReadingPosition: ISyncMediaResolvedContentLocation;
        triggeredBy: SyncMediaSyncEventTrigger;
        visibleTimelineRange: ISyncMediaTimelineRange;
        toJSON(): ISyncMediaReaderViewSynchronizationStateData;
    }

    Properties

    mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange

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

    nextTimelineRange: ISyncMediaTimelineRange

    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: ISyncMediaTimelineRange

    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: ISyncMediaResolvedContentLocation

    The SyncMediaPlayer position and the corresponding content location in the reader publication.

    resolvedReaderViewReadingPosition: ISyncMediaResolvedContentLocation

    The ReaderView reading position and the corresponding SyncMediaTimelinePosition.

    triggeredBy: SyncMediaSyncEventTrigger

    The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.

    visibleTimelineRange: ISyncMediaTimelineRange

    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.

    Methods

    Properties
    Methods