ISyncMediaPlaybackRangeOptions | Colibrio Reader Framework API

Options object used with SyncMediaPlayer.setPlaybackRange.

Hierarchy

ISyncMediaPlaybackRangeOptions

Index

Properties

Optional alwaysInitiallySeekToRangeStart

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.

default: true

Optional pauseOnRangeRemoved

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.

default: false

Optional removeRangeOnEndReached

removeRangeOnEndReached?: boolean

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

default: true

Optional seekBehaviour

seekBehaviour?: SyncMediaRangeSeekBehavior

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

default: ALWAYS_REMOVE_RANGE