Interface RepresentationType

Represents a single representation within a DASH Media Presentation. Representations are versions of an adaptation set that differ in quality, bitrate, or other characteristics.

interface RepresentationType {
    AudioChannelConfiguration?: readonly DescriptorType[];
    BaseURL?: readonly BaseURLType[];
    ContentProtection?: readonly DescriptorType[];
    EssentialProperty?: readonly DescriptorType[];
    FramePacking?: readonly DescriptorType[];
    InbandEventStream?: readonly EventStreamType[];
    SegmentBase?: SegmentBaseType;
    SegmentList?: SegmentListType;
    SegmentTemplate?: SegmentTemplateType;
    SubRepresentation?: readonly SubRepresentationType[];
    SupplementalProperty?: readonly DescriptorType[];
    Switching?: readonly SwitchingType[];
    audioSamplingRate?: readonly number[];
    bandwidth: number;
    bitrate?: number;
    codecs?: string;
    codingDependency?: boolean;
    dependencyId?: StringVectorType;
    frameRate?: FrameRate;
    height?: number;
    id: string;
    maxPlayoutRate?: number;
    maximumSAPPeriod?: number;
    mediaStreamStructureId?: StringVectorType;
    mimeType?: string;
    parent: AdaptationSetType;
    profiles?: readonly string[];
    qualityRanking?: number;
    sar?: Ratio;
    scanType?: VideoScanType;
    segmentProfiles?: string;
    startWithSAP?: number;
    width?: number;
}

Hierarchy (view full)

Properties

AudioChannelConfiguration?: readonly DescriptorType[]

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

BaseURL?: readonly BaseURLType[]

An array of BaseURL elements that specify base URLs for segment fetching. BaseURLs can provide alternative locations or addressable paths for accessing media segments.

ContentProtection?: readonly DescriptorType[]

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

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.

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.

SegmentBase?: SegmentBaseType

An optional SegmentBase element that specifies how to access media segments for this representation using a single URL and optional byte range.

SegmentList?: SegmentListType

An optional SegmentList element that provides a list of media segments through URLs and duration information, allowing for time-based access to segments.

SegmentTemplate?: SegmentTemplateType

An optional SegmentTemplate element that specifies how to generate segment URLs using template patterns, enabling efficient access to segments without needing an explicit list.

SubRepresentation?: readonly SubRepresentationType[]

An optional array of SubRepresentation elements, which are subsets of this representation that may differ in certain characteristics like bitrate or resolution to support more granular adaptation.

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.

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.

bandwidth: number

The average bandwidth in bits per second required for playing this representation.

bitrate?: number

Specifies the bitrate of the representation, in bits per second.

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.

dependencyId?: StringVectorType

Optional identifiers for other representations that this representation depends on. Dependency is typically used for representations that cannot be decoded independently, such as enhanced layers in scalable video coding.

frameRate?: FrameRate

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

height?: number

Height of the video in pixels for video representations.

id: string

A unique identifier for this representation within the scope of its adaptation set.

maxPlayoutRate?: number

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

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.

mediaStreamStructureId?: StringVectorType

Optional identifiers for media stream structure elements, such as segments, that this representation is associated with.

mimeType?: string

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

The parent Adaptation Set.

profiles?: readonly string[]

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

qualityRanking?: number

Specifies a quality ranking of the Representation relative to other Representations in the same Adaptation Set. Lower values represent higher quality

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.

segmentProfiles?: string

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

startWithSAP?: number

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

width?: number

Optional width of the video in pixels for video representations.