Skip to main content

VideoFilterConfiguration

Configuration object used to control video filtering and playback constraints.

This interface defines optional limits that the player may apply when selecting a video stream (e.g., during adaptive bitrate decisions).

See​

TrackManager.setVideoFilterConfiguration

Properties​

maxBitrate?​

optional maxBitrate: number

Max bitrate of the rendition in bits per second. In case rendition's bitrate is not specified in the manifest then the filtering is not enabled

Example​

maxBitrate: 2_000_000 // 2 Mbps

maxHeight?​

optional maxHeight: number

The maximum allowed video height (in pixels).

Used as a constraint for resolution selection during playback.

Example​

maxHeight: 720

maxWidth?​

optional maxWidth: number

The maximum allowed video width (in pixels).

Used as a constraint for resolution selection during playback.

Example​

maxWidth: 1280

maxPixel?​

optional maxPixel: number

Max number of pixels (width * height) of the rendition. In case rendition's resolution is not specified in the manifest then the filtering is not enabled.

Example​

maxPixel: 921_600 // corresponds to 1280×720