Interface SourceAbrConfiguration

Describes the ABR configuration for a specific source.

interface SourceAbrConfiguration {
    preferredAudioCodecs?: string[];
    preferredVideoCodecs?: string[];
    restrictToPlayerSize?: boolean;
}

Properties

preferredAudioCodecs? preferredVideoCodecs? restrictToPlayerSize?

Properties

Optional preferredAudioCodecs

preferredAudioCodecs?: string[]

A list of preferred audio codecs which will be used by the ABR algorithm to make an initial selection, if the codec is supported.

Optional preferredVideoCodecs

preferredVideoCodecs?: string[]

A list of preferred video codecs which will be used by the ABR algorithm to make an initial selection, if the codec is supported.

Optional restrictToPlayerSize

restrictToPlayerSize?: boolean

Whether to restrict the ABR algorithm to only select qualities whose resolution fits within the player's rendered size.

Remarks


- If true, only select qualities that fit within the player's size.
- If false, allow selecting qualities that are larger than the player's size.
- If unset (default), then apply the restriction only when playing on a mobile device.

Default Value

undefined

Settings

Member Visibility

Theme

On This Page

preferredAudioCodecspreferredVideoCodecsrestrictToPlayerSize