Interface Quality

Represents a quality of a media track.

interface Quality {
    available: boolean;
    averageBandwidth?: number;
    bandwidth: number;
    codecs: string;
    id: string;
    label: string;
    name: string;
    score: undefined | number;
    uid: number;
    addEventListener<TType>(type, listener): void;
    removeEventListener<TType>(type, listener): void;
}

Hierarchy (view full)

Properties

available averageBandwidth? bandwidth codecs id label name score uid

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.

Readonly bandwidth

bandwidth: number

The required bandwidth for the quality.

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 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.

Methods

addEventListener

removeEventListener

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc