Interface DashPlaybackConfiguration

Represents a configuration for controlling playback of an MPEG-DASH stream.

interface DashPlaybackConfiguration {
    desiredTimescale?: number;
    forceSeekToSynchronize?: boolean;
    ignoreAvailabilityWindow?: boolean;
    needsTimescaleShifting?: null | boolean;
    segmentRelativeVttTiming?: boolean;
    useSeamlessPeriodSwitch?: SeamlessPeriodSwitchStrategy;
}

Properties

desiredTimescale?: number

(Experimental) The desired timescale to which the media data should be shifted.

Platform

Web

Remarks


- When specified, if the player decides to shift the timescale (see DashPlaybackConfiguration.needsTimescaleShifting), the timescale will be set to the given desired timescale.
- When not specified, if the player decides to shift timescale, the player will decide the timescale to which it should shift.
- This is an experimental option. It should only be used after consulting with THEOplayer support or engineering.

forceSeekToSynchronize?: boolean

Whether the player should try to force the seek on period switching to realign video and audio.

Platform

Web
ignoreAvailabilityWindow?: boolean

(Experimental) Force the player to ignore the availability window of individual segments in the MPD, and instead consider every listed segment to be immediately available.

Platform

Android
Web

Remarks


- This only applies to livestreams (with <MPD type="dynamic">).
- This only applies to streams that use <SegmentTimeline>.

needsTimescaleShifting?: null | boolean

(Experimental) Whether the timescales of the media data need to be shifted, in order to work around platform-specific issues on certain smart TV platforms.

Platform

Android

Remarks


- On certain smart TV platforms (such as Tizen 2), playback issues may arise when the timescale of the media data changes across periods or discontinuities. In that case, the player may need to shift all the timescales first, however this strategy may not work for all streams.
- When not specified, the player will decide whether or not to shift timescales based on the platform.
- This is an experimental option. It should only be used after consulting with THEOplayer support or engineering.

segmentRelativeVttTiming?: boolean

A flag to indicate whether timestamps of segmented WebVTT subtitles are relative to the segment start time.

Platform

Web

Default Value

true

useSeamlessPeriodSwitch?: SeamlessPeriodSwitchStrategy

Whether to seamlessly switch between DASH periods.

Platform

Web

Default Value

'auto'