Interface SegmentTemplateType

Extends MultipleSegmentBaseType with template properties for generating segment URLs.

interface SegmentTemplateType {
    BitstreamSwitching?: URLType;
    Initialization?: URLType;
    RepresentationIndex?: URLType;
    SegmentTimeline?: SegmentTimelineType;
    availabilityTimeComplete?: boolean;
    availabilityTimeOffset?: number;
    bitstreamSwitching?: string;
    duration?: number;
    index?: string;
    indexRange?: ByteRange;
    indexRangeExact: boolean;
    initialization?: string;
    media?: string;
    presentationTimeOffset?: number;
    startNumber?: number;
    timescale?: number;
}

Hierarchy (view full)

Properties

BitstreamSwitching? Initialization? RepresentationIndex? SegmentTimeline? availabilityTimeComplete? availabilityTimeOffset? bitstreamSwitching? duration? index? indexRange? indexRangeExact initialization? media? presentationTimeOffset? startNumber? timescale?

Properties

Optional ReadonlyBitstreamSwitching

BitstreamSwitching?: URLType

An optional URL pointing to a bitstream switching segment. This segment contains data that enables the decoder to seamlessly switch between different bitrates or representations without the need for a full reinitialization. Using this property can significantly improve the user experience in adaptive streaming scenarios by reducing the latency and buffering times associated with bitrate switches.

Optional ReadonlyInitialization

Initialization?: URLType

The URL to the initialization segment required for decoding the media segments.

Optional ReadonlyRepresentationIndex

RepresentationIndex?: URLType

The URL to the segment index providing information about segment locations within the media stream.

Optional ReadonlySegmentTimeline

SegmentTimeline?: SegmentTimelineType

An optional SegmentTimeline that provides a detailed breakdown of the segments' timing and duration within the content.

Optional ReadonlyavailabilityTimeComplete

availabilityTimeComplete?: boolean

Indicates whether the availability time for the segment is complete.

Optional ReadonlyavailabilityTimeOffset

availabilityTimeOffset?: number

Specifies a time offset, in seconds, from the availability start time of the content.

Optional ReadonlybitstreamSwitching

bitstreamSwitching?: string

A template for bitstream switching segment URLs, if bitstream switching is supported.

Optional Readonlyduration

duration?: number

The duration of each segment within the sequence, specified in the timescale units.

Optional Readonlyindex

index?: string

A template for generating segment index URLs.

Optional ReadonlyindexRange

indexRange?: ByteRange

Specifies the byte range for the segment index within the media file, if applicable.

ReadonlyindexRangeExact

indexRangeExact: boolean

Indicates whether the indexRange is exact, providing precise byte range information for segment indexing.

Optional Readonlyinitialization

initialization?: string

A template for generating initialization segment URLs.

Optional Readonlymedia

media?: string

A template for generating media segment URLs.

Optional ReadonlypresentationTimeOffset

presentationTimeOffset?: number

Specifies a presentation time offset in the media timeline relative to the start of the Period, in timescale units, used to adjust the timing of media presentation.

Optional ReadonlystartNumber

startNumber?: number

The number of the first segment in the sequence.

Optional Readonlytimescale

timescale?: number

The timescale in units per second used for timing properties within the segment.

Settings

Member Visibility

On This Page

Properties