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

Hierarchy (view full)

Properties

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

Properties

Optional ReadonlyAccessibility

Accessibility?: readonly DescriptorType[]

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

Optional ReadonlyAudioChannelConfiguration

AudioChannelConfiguration?: readonly DescriptorType[]

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

Optional ReadonlyBaseURL

BaseURL?: readonly BaseURLType[]

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

Optional ReadonlyContentComponent

ContentComponent?: readonly ContentComponentType[]

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

Optional ReadonlyContentProtection

ContentProtection?: readonly DescriptorType[]

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

Optional ReadonlyEssentialProperty

EssentialProperty?: readonly DescriptorType[]

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

Optional ReadonlyFramePacking

FramePacking?: readonly DescriptorType[]

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

Optional ReadonlyInbandEventStream

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.

Optional ReadonlyRating

Rating?: readonly DescriptorType[]

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

Optional ReadonlyRepresentation

Representation?: readonly RepresentationType[]

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

Optional ReadonlyRole

Role?: readonly DescriptorType[]

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

Optional ReadonlySegmentBase

SegmentBase?: SegmentBaseType

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

Optional ReadonlySegmentList

SegmentList?: SegmentListType

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

Optional ReadonlySegmentTemplate

SegmentTemplate?: SegmentTemplateType

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

Optional ReadonlySupplementalProperty

SupplementalProperty?: readonly DescriptorType[]

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

Optional ReadonlySwitching

Switching?: readonly SwitchingType[]

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

Optional ReadonlyViewpoint

Viewpoint?: readonly DescriptorType[]

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

Readonlyactuate

actuate: actuateType

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

Optional ReadonlyaudioSamplingRate

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.

Optional ReadonlybitstreamSwitching

bitstreamSwitching?: boolean

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

Optional Readonlycodecs

codecs?: string

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

Optional ReadonlycodingDependency

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.

Optional ReadonlycontentType

contentType?: string

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

Optional ReadonlyframeRate

frameRate?: FrameRate

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

Optional Readonlygroup

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.

Optional Readonlyheight

height?: number

Height of the video in pixels for video representations.

Optional Readonlyhref

href?: string

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

Optional Readonlyid

id?: number

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

Optional Readonlylang

lang?: string

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

Optional ReadonlymaxBandwidth

maxBandwidth?: number

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

Optional ReadonlymaxFrameRate

maxFrameRate?: FrameRate

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

Optional ReadonlymaxHeight

maxHeight?: number

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

Optional ReadonlymaxPlayoutRate

maxPlayoutRate?: number

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

Optional ReadonlymaxWidth

maxWidth?: number

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

Optional ReadonlymaximumSAPPeriod

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.

Optional ReadonlymimeType

mimeType?: string

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

Optional ReadonlyminBandwidth

minBandwidth?: number

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

Optional ReadonlyminFrameRate

minFrameRate?: FrameRate

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

Optional ReadonlyminHeight

minHeight?: number

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

Optional ReadonlyminWidth

minWidth?: number

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

Optional Readonlypar

par?: Ratio

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

Readonlyparent

parent: PeriodType

The parent Period.

Optional Readonlyprofiles

profiles?: readonly string[]

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

Optional Readonlysar

sar?: Ratio

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

Optional ReadonlyscanType

scanType?: VideoScanType

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

ReadonlysegmentAlignment

segmentAlignment: ConditionalUintType

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

Optional ReadonlysegmentProfiles

segmentProfiles?: string

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

ReadonlyselectionPriority

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.

Optional ReadonlystartWithSAP

startWithSAP?: number

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

ReadonlysubsegmentAlignment

subsegmentAlignment: ConditionalUintType

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

ReadonlysubsegmentStartsWithSAP

subsegmentStartsWithSAP: number

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

Optional Readonlywidth

width?: number

Optional width of the video in pixels for video representations.

Settings

Member Visibility

On This Page

Properties