logo

THEOplayer > DateRangeCue

DateRangeCue interface

Inherits from TextTrackCue . See parent page for inherited properties and methods.

Represents a cue of a HLS date range metadata text track.

Signature:

export interface DateRangeCue extends TextTrackCue 

Properties

Property

Type

Description

class

string | undefined

The class of the date range cue.

customAttributes

Record<string, string | number | ArrayBuffer>

The custom attributes of the date range cue.

duration

number | undefined

The duration of the date range cue, in seconds.

endDate

Date | undefined

The playback position at which the date range cue becomes inactive, as a Date.

endOnNext

boolean

Whether end-on-next is enabled for the date range cue.

plannedDuration

number | undefined

The planned duration of the date range cue, in seconds.

scte35Cmd

ArrayBuffer | undefined

The SCTE 'cmd' splice_info_section of the date range cue.

scte35In

ArrayBuffer | undefined

The SCTE 'in' splice_info_section of the date range cue.

scte35Out

ArrayBuffer | undefined

The SCTE 'out' splice_info_section of the date range cue.

startDate

Date

The playback position at which the date range cue becomes active, as a Date.

Property Details

class

The class of the date range cue.

Signature:

class: string | undefined;

Remarks


- The class is a client-defined string specifying a set of attributes with associated value semantics.

customAttributes

The custom attributes of the date range cue.

Signature:

customAttributes: Record<string, string | number | ArrayBuffer>;

Remarks


- The attribute name in the record does not include the 'X-' prefix present in the manifest.

duration

The duration of the date range cue, in seconds.

Signature:

duration: number | undefined;

endDate

The playback position at which the date range cue becomes inactive, as a Date.

Signature:

endDate: Date | undefined;

endOnNext

Whether end-on-next is enabled for the date range cue.

Signature:

endOnNext: boolean;

Remarks


- End-on-next results in the DateRangeCue.endDate of the date range cue becoming equal to the DateRangeCue.startDate of the next date range cue with the same DateRangeCue.class, once it is known.

plannedDuration

The planned duration of the date range cue, in seconds.

Signature:

plannedDuration: number | undefined;

Remarks


- This is used when the exact duration is not known yet.

scte35Cmd

The SCTE 'cmd' splice_info_section of the date range cue.

Signature:

scte35Cmd: ArrayBuffer | undefined;

scte35In

The SCTE 'in' splice_info_section of the date range cue.

Signature:

scte35In: ArrayBuffer | undefined;

scte35Out

The SCTE 'out' splice_info_section of the date range cue.

Signature:

scte35Out: ArrayBuffer | undefined;

startDate

The playback position at which the date range cue becomes active, as a Date.

Signature:

startDate: Date;
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2022. All Rights Reserved.
Leuven
New York
Singapore
Barcelona