IVS Linux Broadcast SDK (C) 1.49.0
Loading...
Searching...
No Matches
aws_ivs_realtime_subtitle_cue Struct Reference

#include <aws_ivs_realtime.h>

Data Fields

const char * text
const char * language_code
const char * target_participant_id
const char * language_label
int64_t start_time_ms
int64_t end_time_ms

Detailed Description

A subtitle cue to publish.

Field Documentation

◆ end_time_ms

int64_t aws_ivs_realtime_subtitle_cue::end_time_ms

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

◆ language_code

const char* aws_ivs_realtime_subtitle_cue::language_code

The language of the cue as an ISO 639-1 code, for example "en". Required; must be non-empty. Carried through to receivers unmodified and otherwise unvalidated.

◆ language_label

const char* aws_ivs_realtime_subtitle_cue::language_label

Optional human-readable label for the language, for example "English", which provides a readable passthrough display receivers can use. Max 96 bytes. Carried through to receivers unmodified and otherwise unvalidated.

◆ start_time_ms

int64_t aws_ivs_realtime_subtitle_cue::start_time_ms

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 of them is published with neither.

◆ target_participant_id

const char* aws_ivs_realtime_subtitle_cue::target_participant_id

The participant the cue describes, which is not necessarily the one that authored it. Leave it unset to attribute the cue to the local participant.

◆ text

const char* aws_ivs_realtime_subtitle_cue::text

The cue text, as UTF-8. Required; must be non-empty.


The documentation for this struct was generated from the following file: