Vinyl
    Preparing search index...

    Interface MediaQualityMetadata

    Metadata representing attributes of a media representation.

    interface MediaQualityMetadata {
        audioSamplingRate: null | readonly number[];
        bandwidth: null | number;
        bandwidthTotal: null | number;
        codecs: null | string;
        contentProtections: readonly DrmProtection[];
        contentType: null | ContentType;
        decoderId: string;
        encryptionScheme: null | string;
        frameRate: null | FrameRate;
        groupId: string;
        height: null | number;
        initDataType: null | string;
        lang: null | string;
        mimeType: null | string;
        qualityId: string;
        supplementalProperties: DescriptorRecord;
        switchingGroupIds: null | readonly string[];
        width: null | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    audioSamplingRate bandwidth bandwidthTotal codecs contentProtections contentType decoderId encryptionScheme frameRate groupId height initDataType lang mimeType qualityId supplementalProperties switchingGroupIds width

    Properties

    audioSamplingRate: null | readonly number[]

    Audio sampling rate(s) in samples per second. An array of either one or two decimal integer values. If there are two elements this represents a minimum and maximum sampling rate of the audio media.

    bandwidth: null | number

    The average bandwidth in bits per second required for playing this representation. For HLS, and non-segmented media this will be null.

    bandwidthTotal: null | number

    The peak bandwidth in bits per second required for playing this representation with its cumulative A/V content streams.

    Guaranteed to be set for segmented media.

    codecs: null | string

    Optional string specifying the codec(s) used for this representation. The format follows the RFC 6381 codec string format.

    contentProtections: readonly DrmProtection[]

    Protection schemes used in this media.

    contentType: null | ContentType

    The content type of the representation, e.g. 'audio', 'video', 'text' Must be non-null for segmented media.

    decoderId: string

    Provides a decoding identifier. If this value changes from the previously buffered segment, the initialization segment must be buffered before appending the media segment. Unique to the track.

    encryptionScheme: null | string

    The method of encryption, or null.

    frameRate: null | FrameRate

    Frame rate for video representations, specified either as a ratio of integers, e.g. [30000, 1001]

    groupId: string

    Identifies the group this quality belongs to (e.g. the adaptation set).

    height: null | number

    For video representations, the height of the video in pixels.

    initDataType: null | string

    The initialization data format.

    lang: null | string

    Specifies the language of the content, using a code as defined by RFC 5646.

    mimeType: null | string

    The full MIME type of the media.

    Must be non-null for segmented media.

    qualityId: string

    The quality id identifies the quality representation. Unique to the track.

    supplementalProperties: DescriptorRecord

    Information that may enhance playback or presentation.

    switchingGroupIds: null | readonly string[]

    The group IDs that this quality is permitted to switch to during playback. Derived from the DASH urn:mpeg:dash:adaptation-set-switching:2016 supplemental property. Includes the quality's own groupId. Null means no switching constraint (all groups are permitted). An array restricts switching to only the listed group IDs. Default behavior:

    • DASH: restricted to own group unless adaptation-set-switching property is present.
    • HLS: restricted to variants with the same base codec and language.
    width: null | number

    For video representations, the width of the video in pixels.

    Settings

    Member Visibility

    On This Page

    Properties