Class: EmsgEvent

  • EmsgEvent provides data for events of type cast.framework.events.EventType.EMSG, including timing, duration, and message content.

  • The event data includes details like startTime, endTime, eventDuration, timescale, and presentationTimeDelta for precise timing information.

  • messageData contains the main message body, potentially including ID3 metadata based on schemeIdUri.

  • schemeIdUri identifies the message scheme, while value offers an additional event value.

  • Although segmentData holds the entire raw segment data, it's recommended to utilize other provided fields due to its planned deprecation.

cast.framework.events.EmsgEvent

class   static

Event data for a cast.framework.events.EventType.EMSG event.

Constructor

EmsgEvent

new EmsgEvent(emsgData)

Parameter

emsgData

Object

Value must not be null.

Properties

endTime

constant

(number or undefined)

The time that the event ends (in presentation time).

eventDuration

constant

(number or undefined)

The duration of the event (in units of timescale).

id

constant

(number or undefined)

A field identifying this instance of the message.

messageData

constant

(non-null Uint8Array or undefined)

The body of the message, which can contain ID3 metadata if signaled by the schemeIdUri value. The schemeIdUri "https://aomedia.org/emsg/ID3" and "https://developer.apple.com/streaming/emsg-id3" always signals ID3 metadata.

presentationTimeDelta

constant

(number or undefined)

The offset that the event starts, relative to the start of the containing segment (in units of timescale).

schemeIdUri

constant

(string or undefined)

Identifies the message scheme.

segmentData

constant

(non-null Uint8Array or undefined)

The entire, raw segment data encompassing the EMSG. This field is scheduled for deprecation. It is recommended to use the provided EMSG event data fields instead of this field.

startTime

constant

(number or undefined)

The time that the event starts (in presentation time).

timescale

constant

(number or undefined)

Defines the timescale, in ticks per second.

value

constant

(string or undefined)

Specifies the value for the event.