Interface AbrConfiguration

interface AbrConfiguration {
    customPixelRatio: null | number;
    initialBandwidth: null | number;
    limitRenditionByPlayerDimensions: boolean;
    useDevicePixelRatio: boolean;
}

Properties

customPixelRatio: null | number

If set, this will take the initial player dimensions and multiply it by a custom ratio when the player automatically selects renditions. This means that if you have a player where the dimension is 540p, with a custom pixel ratio of 2, a rendition of 1080p or a lower rendition closest to this value will be chosen. Additionally, if you have a player where the dimension is 540p, with a custom pixel ratio of 0.5, a rendition of 270p or a lower rendition closest to this value will be chosen. When the custom pixel ratio is 0, the lowest available rendition will be selected. It is worth noting that if the player dimension multiplied by the custom pixel ratio is greater than any available rendition resolution, a rendition will be selected based on bandwidth, and the player dimension will be disregarded. limitRenditionByPlayerDimensions must be true in order for this feature to be enabled. If useDevicePixelRatio is set to true, the custom pixel ratio will be prioritized and overwrite any previous pixel ratio. Defaults to null

initialBandwidth: null | number

The bandwidth value to be used in the calculation for initial playlist selection, before more bandwidth information is seen by the player. Defaults to null

limitRenditionByPlayerDimensions: boolean

When this is set to true, rendition selection logic will take into account the player size and rendition resolutions when making a decision. This setting is true by default.

useDevicePixelRatio: boolean

If true, this will take the device pixel ratio into account when doing rendition switching. This means that if you have a player with the width of 540px in a high density display with a device pixel ratio of 2, a rendition of 1080p will be allowed. Defaults to false