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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["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."]]],["The `EmsgEvent` class provides data for an EMSG event, detailing its properties. Key information includes `startTime` and `endTime` for event timing, `eventDuration`, and `presentationTimeDelta` for timing within the segment. `messageData` contains the message body, potentially with ID3 metadata, identified by `schemeIdUri`. `id` identifies the message instance, `timescale` defines the time unit, and `value` specifies the event's value. `segmentData` is present but being deprecated, with individual data fields preferred.\n"]]