THEOplayer Web SDK
    Preparing search index...

    Interface Quality

    Represents a quality of a media track.

    interface Quality {
        available: boolean;
        averageBandwidth?: number;
        bandwidth: number;
        codecs: string;
        enabled: boolean;
        id: string;
        label: string;
        name: string;
        score: number | undefined;
        uid: 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 enabled id label name score uid

    Methods

    addEventListener removeEventListener

    Properties

    available: boolean

    Whether the quality is available for selection.

    • A quality that is unavailable will be ignored during ABR selection and when setting MediaTrack.targetQuality.
    • A quality can be unavailable due to a DRM restriction (e.g. HDCP).
    • To prevent a quality from being selected for reasons outside the player, set enabled to `false`.
    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.

    enabled: boolean

    Whether the quality is allowed to be selected.

    • A quality that is disabled will be ignored during ABR selection, and when setting MediaTrack.targetQuality.
    • Setting this to `false` will cause available to become `false`. However, setting this to `true` **does not** guarantee that available will become `true`, since the player might not be able to select this quality for its own reasons.
    • Available since v11.4.0.

    true

    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: number | undefined

    The HLS SCORE attribute.


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

    uid: number

    The unique identifier for this quality.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods