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

    Interface ISyncMediaPlaybackRangeOptions

    Options object used with SyncMediaPlayer.setPlaybackRange.

    interface ISyncMediaPlaybackRangeOptions {
        alwaysInitiallySeekToRangeStart?: boolean;
        pauseOnRangeRemoved?: boolean;
        removeRangeOnEndReached?: boolean;
        seekBehaviour?: SyncMediaRangeSeekBehavior;
    }

    Properties

    alwaysInitiallySeekToRangeStart?: boolean

    If set to false, no initial seek to range start will be done if the current timeline position is within the range. If set to true, or if the current timeline position is outside the range, then the SyncMediaPlayer will seek to range.start.

    true
    
    pauseOnRangeRemoved?: boolean

    If the SyncMediaPlayer should pause when the playback range is removed.

    Note: The SyncMediaPlayer always pause when playback reaches the end of the range, regardless of the value used on this option.

    false
    
    removeRangeOnEndReached?: boolean

    If the SyncMediaPlayer should remove the playback range when playback reaches the end of the range.

    true
    

    Defines how the SyncMediaPlayer handles seeking while the playback range is active.

    ALWAYS_REMOVE_RANGE