Interface AdaptationPlatformConfig

Lower and upper bitrate boundaries to limit qualities.

The player automatically cancels requests if it takes too long and retries in a lower quality (default, false). This behavior can be disabled by setting this option to true.

Specifies whether qualities that must not be switched to should be removed when parsing the manifest or not. Qualities which must not be switched to can be specified by bitrates or resolution. Default is false.

Limits the automatically selected quality to the player size, so the player won't select quality levels with a higher resolution than the video element. This is disabled (false) per default.

Defines the type/version of adaptation logic to be used. Default is DOWNLOAD_PREDICTION.

The maximum bitrate the player should start playback with. Has no effect if startupBitrate is used.

A callback function to customize the player's adaptation logic that is called before the player tries to download a new audio segment.

Example:

const conf = {
  ...
  adaptation: {
    desktop: {
      onAudioAdaptation: (data) => {
        // Do your custom logic
        return newRepresentationId;
      }
    },
    mobile: {
      onAudioAdaptation: (data) => {
        // Do your custom logic
        return newRepresentationId;
      }
    },
  }
};
Copy

Returns

A valid representation/quality ID which the player should use, based on your custom logic (either data.suggested to switch to the player's suggested quality, or a id)

See

getAvailableAudioQualities to get a list of all available audio qualities

A callback function to customize the player's adaptation logic that is called before the player tries to download a new video segment.

Example:

const conf = {
  ...
  adaptation: {
    desktop: {
      onVideoAdaptation: (data) => {
        // Do your custom logic
        return newRepresentationId;
      }
    },
    mobile: {
      onVideoAdaptation: (data) => {
        // Do your custom logic
        return newRepresentationId;
      }
    },
  }
};
Copy

To simply restrict video qualities to the current video player size, use limitToPlayerSize.

Returns

A valid representation/quality ID which the player should use, based on your custom logic (either data.suggested to switch to the player's suggested quality, or a id)

See

getAvailableVideoQualities to get a list of all available video qualities

Specifies whether the player preloads the content (default: true for VOD, false for live streams) or not.

Defines the balance between quality (i.e. bitrate) and stability in a range of [0, 1]. A value of 0 means that the player will aim to play the best possible quality, potentially at the cost of lower playback stability. A value of 1 means that the player will aim for the highest stability with the least amount of stalls, while potentially sacrificing quality. This is only relevant when using the Low Latency adaptation logic.

Default is 0.5.

Lower and upper resolution boundaries. Use 0 for no limitation for minimum selectable width/height and Infinity for no limitation for maximum selectable width/height.

Defines what method shall be used to estimate the round-trip-time of the network based on the measured RTTs of previous downloads. Possible values are WeightedAverage and Median. The Median estimation method may perform better on low-performance devices. Default value is WeightedAverage. Can only be used with the 'v3' logic.

The bitrate the player should start playback with. If this option doesn’t exist in the configuration, the player will try to find the best startup bitrate automatically.