Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AdaptationConfig

Example:

adaptation : {
  desktop: {
    bitrates: {
      minSelectableAudioBitrate: '128kbps',
      maxSelectableAudioBitrate: '320kbps',
      minSelectableVideoBitrate: '900kbps',
      maxSelectableVideoBitrate: Infinity
    }
  },
  mobile: {
    bitrates: {
      minSelectableAudioBitrate: 0,
      maxSelectableAudioBitrate: '256000bps',
      minSelectableVideoBitrate: 0,
      maxSelectableVideoBitrate: '2.5mbps'
    }
  }
}

Hierarchy

Index

Properties

Optional bitrates

Lower and upper bitrate boundaries to limit qualities.

Optional disableDownloadCancelling

disableDownloadCancelling: undefined | false | true

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.

Optional exclude

exclude: undefined | false | 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.

Optional limitToPlayerSize

limitToPlayerSize: undefined | false | true

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.

Optional maxStartupBitrate

maxStartupBitrate: Bitrate

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

Optional onAudioAdaptation

onAudioAdaptation: undefined | function

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;
      }
    },
  }
};
param

An object carrying the suggested attribute, holding the suggested representation/quality ID the player would select

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 AudioQuality.id)

see

PlayerAPI.getAvailableAudioQualities to get a list of all available audio qualities

Optional onVideoAdaptation

onVideoAdaptation: undefined | function

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;
      }
    },
  }
};

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

param

An object carrying the suggested attribute, holding the suggested representation/quality ID the player would select

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 VideoQuality.id)

see

PlayerAPI.getAvailableVideoQualities to get a list of all available video qualities

Optional preload

preload: undefined | false | true

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

Optional resolution

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.

Optional rttEstimationMethod

rttEstimationMethod: RttEstimationMethod

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 RttEstimationMethod.WeightedAverage and RttEstimationMethod.Median. The RttEstimationMethod.Median estimation method may perform better on low-performance devices. Default value is RttEstimationMethod.WeightedAverage. Can only be used with the 'v3' {@link logic}.

Optional startupBitrate

startupBitrate: Bitrate

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.

Generated using TypeDoc