Interface VideoQuality

Represents a quality of a video track.

interface VideoQuality {
    available: boolean;
    averageBandwidth?: number;
    bandwidth: number;
    codecs: string;
    firstFrame: number;
    frameRate: number;
    height: number;
    id: string;
    label: string;
    name: string;
    score: undefined | number;
    uid: number;
    width: number;
    addEventListener<TType>(type: TType | readonly TType[], listener: EventListener<QualityEventMap[TType]>): void;
    removeEventListener<TType>(type: TType | readonly TType[], listener: EventListener<QualityEventMap[TType]>): void;
}

Hierarchy (view full)

Quality
- VideoQuality

Index

Properties

available averageBandwidth? bandwidth codecs firstFrame frameRate height id label name score uid width

Methods

addEventListener removeEventListener

Properties

`Readonly`available

available: boolean

Whether the quality is available.

Remarks

- A quality can be unavailable due to a DRM restriction (e.g. HDCP).

`Optional` `Readonly`averageBandwidth

averageBandwidth?: number

The average bandwidth of the quality, in bits per second.

`Readonly`bandwidth

bandwidth: number

The required bandwidth for the quality, in bits per second.

`Readonly`codecs

codecs: string

The codecs of the quality.

Remarks

- These are represented as a string containing the codecs as defined by the manifest.

`Readonly`firstFrame

firstFrame: number

The timestamp of the first frame of the video quality, in seconds.

`Readonly`frameRate

frameRate: number

The framerate of the video quality.

`Readonly`height

height: number

The video height of the video quality, in pixels.

`Readonly`id

id: string

The identifier for this quality. This identifier is tied to the stream's internal representation. It may be empty. For a unique id, use Quality.uid.

label

label: string

The label of the quality.

`Readonly`name

name: string

The name of the quality.

`Readonly`score

score: undefined | number

The HLS SCORE attribute.

Remarks

- Available since v6.8.0.
- Only for HLS streams.

`Readonly`uid

uid: number

The unique identifier for this quality.

`Readonly`width

width: number

The video width of the video quality, in pixels.

Methods

addEventListener

addEventListener<TType>(type, listener): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends "update"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<QualityEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from Quality.addEventListener

removeEventListener

removeEventListener<TType>(type, listener): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends "update"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<QualityEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from Quality.removeEventListener

Interface VideoQuality

Hierarchy (view full)

Index

Properties

Methods

Properties

`Readonly`available

Remarks

`Optional` `Readonly`averageBandwidth

`Readonly`bandwidth

`Readonly`codecs

Remarks

`Readonly`firstFrame

`Readonly`frameRate

`Readonly`height

`Readonly`id

label

`Readonly`name

`Readonly`score

Remarks

`Readonly`uid

`Readonly`width

Methods

addEventListener

Type Parameters

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page

Interface VideoQuality

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonlyavailable

Remarks

Optional ReadonlyaverageBandwidth

Readonlybandwidth

Readonlycodecs

Remarks

ReadonlyfirstFrame

ReadonlyframeRate

Readonlyheight

Readonlyid

label

Readonlyname

Readonlyscore

Remarks

Readonlyuid

Readonlywidth

Methods

addEventListener

Type Parameters

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page

`Readonly`available

`Optional` `Readonly`averageBandwidth

`Readonly`bandwidth

`Readonly`codecs

`Readonly`firstFrame

`Readonly`frameRate

`Readonly`height

`Readonly`id

`Readonly`name

`Readonly`score

`Readonly`uid

`Readonly`width