IVSStageSubtitleCue
Objective-C
@interface IVSStageSubtitleCue : NSObject
Swift
class IVSStageSubtitleCue : NSObject
A single subtitle cue received on an IVSRemoteSubtitleStream.
Warning
This API is in beta and is only available to allowlisted accounts.-
Unavailable
Do not create instances of this class directly
Declaration
Objective-C
IVS_INIT_UNAVAILABLE -
Unavailable
Do not create instances of this class directly
Declaration
Objective-C
IVS_INIT_UNAVAILABLE -
Text delivered by the cue. At most 3600 UTF-8 bytes.
Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *_Nonnull text;Swift
var text: String { get } -
ISO 639-1 two-character lowercase code (e.g.
en,ja,es),as named in the StageAgentConfiguration or downstream recording configuration.Declaration
Objective-C
@property (nonatomic, copy, readonly) NSString *_Nonnull languageCode;Swift
var languageCode: String { get } -
Human-readable label for the language (e.g.
English,Español),at most 96 UTF-8 bytes, or nil when the author did not supply one.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *languageLabel;Swift
var languageLabel: String? { get } -
The participant ID the cue is attributed to, which may differ from the participant that published it. Nil when the cue is self-authored by the publishing participant.
Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *targetParticipantId;Swift
var targetParticipantId: String? { get } -
Start time of the cue, in milliseconds from the NTP capture time of the media it describes, as an
int64_t(read it withlongLongValue),or nil when unspecified. Real-time subtitles usually leave this unspecified, because they render as they arrive. The start and end are either both set or both nil.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) NSNumber *startTimeMs;Swift
var startTimeMs: NSNumber? { get } -
End time of the cue, on the same timeline as the start, as an
int64_t(read it withlongLongValue),or nil when unspecified.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) NSNumber *endTimeMs;Swift
var endTimeMs: NSNumber? { get }