Interface SubRepresentationType

Extends RepresentationBaseType to define a sub-representation, which is a subset of a representation often used for adaptive streaming. This includes details like bandwidth and dependencies on other components or levels within the content hierarchy.

interface SubRepresentationType {
    AudioChannelConfiguration?: readonly DescriptorType[];
    ContentProtection?: readonly DescriptorType[];
    EssentialProperty?: readonly DescriptorType[];
    FramePacking?: readonly DescriptorType[];
    InbandEventStream?: readonly EventStreamType[];
    SupplementalProperty?: readonly DescriptorType[];
    Switching?: readonly SwitchingType[];
    audioSamplingRate?: readonly number[];
    bandwidth?: number;
    codecs?: string;
    codingDependency?: boolean;
    contentComponent?: StringVectorType;
    dependencyLevel?: UIntVectorType;
    frameRate?: FrameRate;
    height?: number;
    level?: number;
    maxPlayoutRate?: number;
    maximumSAPPeriod?: number;
    mimeType?: string;
    profiles?: readonly string[];
    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.

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.

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 bandwidth requirement for this sub-representation, specified in bits per second. This indicates the network throughput needed to consume this content without interruptions.

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?: StringVectorType

Identifies the content components associated with this sub-representation, expressed as a vector of strings. Each string in the vector represents a content component ID, allowing this sub-representation to be associated with specific audio, video, or other types of media streams within the content.

dependencyLevel?: UIntVectorType

A vector of unsigned integers specifying the levels of dependency this sub-representation has on other representations. Each number in the vector refers to a level in the content hierarchy, indicating this sub-representation relies on components or data at those specified levels for proper playback or functionality.

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.

level?: number

An optional level indicator for this sub-representation, which could denote a quality level, spatial layer, or other hierarchical level within a multi-layered or scalable content structure. This helps in adaptive streaming decisions and content selection based on capabilities or preferences.

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.

mimeType?: string

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

profiles?: readonly string[]

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

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.