THEOplayer Web SDK
    Preparing search index...

    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 extends "update">(
            type: TType | readonly TType[],
            listener: EventListener<QualityEventMap[TType]>,
        ): void;
        removeEventListener<TType extends "update">(
            type: TType | readonly TType[],
            listener: EventListener<QualityEventMap[TType]>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    addEventListener removeEventListener

    Properties

    available: boolean

    Whether the quality is available.


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

    averageBandwidth?: number

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

    bandwidth: number

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

    codecs: string

    The codecs of the quality.


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

    firstFrame: number

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

    frameRate: number

    The framerate of the video quality.

    height: number

    The video height of the video quality, in pixels.

    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: string

    The label of the quality.

    name: string

    The name of the quality.

    score: undefined | number

    The HLS SCORE attribute.


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

    uid: number

    The unique identifier for this quality.

    width: number

    The video width of the video quality, in pixels.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods