Describes the adaptive bitrate configuration.

interface ABRConfiguration {
    bufferLookbackWindow?: number;
    maxBufferLength?: number;
    preferredMaximumResolution?: Resolution;
    preferredPeakBitRate?: number;
    strategy?: ABRStrategy;
    targetBuffer?: number;
}

Properties

bufferLookbackWindow?: number

The amount of data which the player should keep in its buffer before the current playback position, in seconds. This configuration option can be used to reduce the memory footprint on memory restricted devices or on devices which don't automatically prune decoder buffers.

Note that the player can decide to keep less data in the decoder buffer in case memory is running low. A value of 0 or lower is not accepted and will be treated as default.

Default Value

30

Platform

Web
maxBufferLength?: number

The maximum length of the player's buffer, in seconds.

The player will initially buffer up to ABRConfiguration.targetBuffer seconds of media data. If the player detects that the decoder is unable to hold so much data, it will reduce maxBufferLength and restrict targetBuffer to be less than this maximum.

Platform

Web
preferredMaximumResolution?: Resolution

A preferred upper limit on the resolution of the video to be downloaded (or otherwise transferred) and rendered by the player.

The default value is (0,0), which indicates that the client enforces no limit on video resolution. Other values indicate a preferred maximum video resolution. It only applies to HTTP Live Streaming asset.

Platform

iOS
preferredPeakBitRate?: number

The desired limit of network bandwidth consumption for this item.

Set preferredPeakBitRate to non-zero to indicate that the player should attempt to limit item playback to that bit rate, expressed in bits per second. If network bandwidth consumption cannot be lowered to meet the preferredPeakBitRate, it will be reduced as much as possible while continuing to play the item.

Platform

iOS
strategy?: ABRStrategy

The adaptive bitrate strategy.

Default Value

'bandwidth'

Platform

Android
Web
targetBuffer?: number

The amount which the player should buffer ahead of the current playback position, in seconds.

Default Value

20

Remarks


- Before v4.3.0: This duration has a maximum of 60 seconds.
- After v4.3.0: This duration has no maximum.
- The player might reduce or ignore the configured amount because of device or performance constraints.