Vinyl
    Preparing search index...

    Interface AdaptationSetType

    Represents an adaptation set in a DASH Media Presentation. An adaptation set groups multiple representations that offer the same content but in different qualities, codecs, or other characteristics, allowing adaptive streaming based on network conditions or user preferences.

    interface AdaptationSetType {
        Accessibility?: readonly DescriptorType[];
        actuate: actuateType;
        AudioChannelConfiguration?: readonly DescriptorType[];
        audioSamplingRate?: readonly number[];
        BaseURL?: readonly BaseURLType[];
        bitstreamSwitching?: boolean;
        codecs?: string;
        codingDependency?: boolean;
        ContentComponent?: readonly ContentComponentType[];
        ContentProtection?: readonly DescriptorType[];
        contentType?: string;
        EssentialProperty?: readonly DescriptorType[];
        FramePacking?: readonly DescriptorType[];
        frameRate?: FrameRate;
        group?: number;
        height?: number;
        href?: string;
        id?: number;
        InbandEventStream?: readonly EventStreamType[];
        lang?: string;
        maxBandwidth?: number;
        maxFrameRate?: FrameRate;
        maxHeight?: number;
        maximumSAPPeriod?: number;
        maxPlayoutRate?: number;
        maxWidth?: number;
        mimeType?: string;
        minBandwidth?: number;
        minFrameRate?: FrameRate;
        minHeight?: number;
        minWidth?: number;
        par?: Ratio;
        parent: PeriodType;
        profiles?: readonly string[];
        Rating?: readonly DescriptorType[];
        Representation?: readonly RepresentationType[];
        Role?: readonly DescriptorType[];
        sar?: Ratio;
        scanType?: VideoScanType;
        segmentAlignment: ConditionalUintType;
        SegmentBase?: SegmentBaseType;
        SegmentList?: SegmentListType;
        segmentProfiles?: string;
        SegmentTemplate?: SegmentTemplateType;
        selectionPriority: number;
        startWithSAP?: number;
        subsegmentAlignment: ConditionalUintType;
        subsegmentStartsWithSAP: number;
        SupplementalProperty?: readonly DescriptorType[];
        Switching?: readonly SwitchingType[];
        Viewpoint?: readonly DescriptorType[];
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Accessibility? actuate AudioChannelConfiguration? audioSamplingRate? BaseURL? bitstreamSwitching? codecs? codingDependency? ContentComponent? ContentProtection? contentType? EssentialProperty? FramePacking? frameRate? group? height? href? id? InbandEventStream? lang? maxBandwidth? maxFrameRate? maxHeight? maximumSAPPeriod? maxPlayoutRate? maxWidth? mimeType? minBandwidth? minFrameRate? minHeight? minWidth? par? parent profiles? Rating? Representation? Role? sar? scanType? segmentAlignment SegmentBase? SegmentList? segmentProfiles? SegmentTemplate? selectionPriority startWithSAP? subsegmentAlignment subsegmentStartsWithSAP SupplementalProperty? Switching? Viewpoint? width?

    Properties

    Accessibility?: readonly DescriptorType[]

    Descriptors providing accessibility information, such as captions or sign language interpretations.

    actuate: actuateType

    Specifies the actuation mechanism for this adaptation set, defining how it should be activated or selected.

    AudioChannelConfiguration?: readonly DescriptorType[]

    Descriptors for audio channel configurations, providing detailed information about the audio channels included in the representation.

    audioSamplingRate?: 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.

    BaseURL?: readonly BaseURLType[]

    Base URLs for segment retrieval, providing alternative paths or locations for accessing content.

    bitstreamSwitching?: boolean

    Indicates whether bitstream switching is supported, allowing seamless switches between representations without the need for reinitializing the decoder.

    codecs?: string

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

    codingDependency?: boolean

    Indicates whether the coding of media frames within the representation depends on other frames. A value of true means there is a dependency, which affects adaptation logic.

    ContentComponent?: readonly ContentComponentType[]

    Defines content components within the adaptation set, such as different audio languages or video angles.

    ContentProtection?: readonly DescriptorType[]

    Descriptors for content protection schemes applied to the representation, facilitating the implementation of DRM and other content protection mechanisms.

    contentType?: string

    The type of content (e.g., video, audio, text) this adaptation set represents.

    EssentialProperty?: readonly DescriptorType[]

    Descriptors for essential properties of the representation that are not defined by other attributes or elements in the DASH manifest.

    FramePacking?: readonly DescriptorType[]

    Descriptors for frame packing arrangements in video representations, relevant for stereoscopic 3D content.

    frameRate?: FrameRate

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

    group?: number

    A group identifier, indicates a group of AdaptationSet elements that are related in some way. For example, an audio and video adaptation set that should be synchronized can be part of the same group.

    height?: number

    Height of the video in pixels for video representations.

    href?: string

    An optional URL reference providing additional information or data relevant to this adaptation set.

    id?: number

    A unique identifier for this adaptation set within the scope of the DASH manifest.

    InbandEventStream?: readonly EventStreamType[]

    Array of in-band event streams, specifying events such as subtitles or metadata that are embedded within the media content of the representation.

    lang?: string

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

    maxBandwidth?: number

    The maximum bandwidth in bits per second of all representations in this adaptation set.

    maxFrameRate?: FrameRate

    The maximum frame rate of all video representations in this adaptation set.

    maxHeight?: number

    The maximum height in pixels of all video representations in this adaptation set.

    maximumSAPPeriod?: number

    The maximum Segment Access Point (SAP) period in seconds. It indicates the maximum distance in playback time between random access points, aiding in efficient seeking and buffering strategies.

    maxPlayoutRate?: number

    Maximum playout rate, indicating the maximum speed at which the representation can be played without affecting normal audio pitch and video appearance.

    maxWidth?: number

    The maximum width in pixels of all video representations in this adaptation set.

    mimeType?: string

    MIME type of the representation, indicating the media type and potentially the codec information.

    minBandwidth?: number

    The minimum bandwidth in bits per second of all representations in this adaptation set.

    minFrameRate?: FrameRate

    The minimum frame rate of all video representations in this adaptation set.

    minHeight?: number

    The minimum height in pixels of all video representations in this adaptation set.

    minWidth?: number

    The minimum width in pixels of all video representations in this adaptation set.

    par?: Ratio

    The display aspect ratio (for video representations) within this adaptation set, specifying the width to height ratio of the video.

    parent: PeriodType

    The parent Period.

    profiles?: readonly string[]

    An array of profile identifiers indicating compliance with specific codec profiles, facilitating compatibility and quality assurance across devices and players.

    Rating?: readonly DescriptorType[]

    Rating descriptors providing content rating information, which may influence content selection.

    Representation?: readonly RepresentationType[]

    The representations available within this adaptation set, offering various qualities or formats of the content.

    Role?: readonly DescriptorType[]

    Role descriptors defining the role or function of the content, such as main, alternative, or supplementary.

    sar?: Ratio

    Sample aspect ratio for video representations, specifying the aspect ratio of the pixels themselves.

    scanType?: VideoScanType

    Scan type for video content, indicating whether the video is progressive or interlaced.

    segmentAlignment: ConditionalUintType

    Specifies if the segments within the representations are aligned, allowing for optimized switching and buffering.

    SegmentBase?: SegmentBaseType

    Specifies segment base information, defining access to media segments using a base URL

    SegmentList?: SegmentListType

    Provides a list of media segments, allowing time-based access to content without requiring individual segment URLs.

    segmentProfiles?: string

    Optional segment profiles supported by the representation, further defining the characteristics of the segments within the representation.

    SegmentTemplate?: SegmentTemplateType

    Defines templates for generating media segment URLs, optimizing manifest size and segment access efficiency.

    selectionPriority: number

    Specifies the selection priority for the described data structures, i.e. the one described by the containing element. In the absence of other information, higher numbers are the preferred selection to lower numbers.

    startWithSAP?: number

    Indicates the type of Stream Access Points (SAP) that the segments start with.

    subsegmentAlignment: ConditionalUintType

    Indicates if subsegments within the representations are aligned, further optimizing switching and buffering efficiencies.

    subsegmentStartsWithSAP: number

    Specifies the SAP (Segment Alignment Point) type, indicating the alignment of segment starts with SAPs.

    SupplementalProperty?: readonly DescriptorType[]

    Descriptors for supplemental properties of the representation, providing additional information that may enhance playback or presentation.

    Switching?: readonly SwitchingType[]

    Descriptors for switching information, indicating conditions or recommendations for switching from this representation to another.

    Viewpoint?: readonly DescriptorType[]

    Viewpoint descriptors providing information about the narrative or visual perspective of the content.

    width?: number

    Optional width of the video in pixels for video representations.

    Settings

    Member Visibility

    On This Page

    Properties