Interface StreamData

---

Specifies stream data.

Properties
adPeriodData	The ad period data for the ad period currently playing.
adProgressData	Timing related information for currently playing ad.
cuepoints	The ad cuepoints for the on-demand stream.
errorMessage	The error message due to a stream error.
manifestFormat	The format of the stream manifest.
streamId	The unique ID to identify the current stream.
subtitles	The subtitles for the stream currently playing.
url	The manifest URL of the stream to play.

Properties

---

adPeriodData

adPeriodData: AdPeriodData

The ad period data for the ad period currently playing. Ad period data is only populated in the AD_PERIOD_STARTED stream event.

---

adProgressData

adProgressData: AdProgressData

Timing related information for currently playing ad.

---

cuepoints

cuepoints: CuePoint[]

The ad cuepoints for the on-demand stream. These cuepoints might change as the stream progresses. The cuepoints property only populates in the event listener for the CUEPOINTS_CHANGED stream event.

---

errorMessage

errorMessage: string

The error message due to a stream error.

---

manifestFormat

manifestFormat: string

The format of the stream manifest. This format can be HLS or DASH.

---

streamId

streamId: string

The unique ID to identify the current stream.

---

subtitles

subtitles: {
  language: string;
  language_name: string;
  url: string;
}[]

The subtitles for the stream currently playing. This property is an array of objects, where each object has a language key, a language_name key to separate the specific set of subtitles if multiple sets exist for the same language, and a url key which points to the subtitles file.

---

url

url: string

The manifest URL of the stream to play.