Skip to main content
Version: v1.41.0

StageSubtitleCue

Beta

A single cue of text to be delivered downstream to subscribers, and in the future internal recording systems such as IPR or SSC.

Properties​

endTimeMs?​

optional endTimeMs: number

Beta

End time of the cue, on the same timeline as the start. 0 means unspecified.

languageCode​

languageCode: string

Beta

ISO 639-1 two-character lowercase code (e.g. en, ja, es). The SDK will only validate the number of characters the code has. The application must ensure this code aligns with the languageCode provided in the StageAgentConfiguration, or downstream recording configurations.

languageLabel?​

optional languageLabel: string

Beta

Human-readable label for the language (e.g. "English", "Español").

startTimeMs?​

optional startTimeMs: number

Beta

Start time of the cue, in milliseconds from the NTP capture time of the media it describes. 0 means unspecified. Real-time subtitles usually leave this unspecified, because they render as they arrive. Set the start and the end together. A cue with only one value set is published with neither.

targetParticipantId?​

optional targetParticipantId: string

Beta

The Participant ID the cue is attributed to. When omitted, the cue is self-authored for the participant ID associated with the current token.

text​

text: string

Beta

Text to be delivered via the cue.

Last updated on