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

  • The body of the cue to display.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull text;

    Swift

    var text: String { get }

  • Language code of this cue.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull languageCode;

    Swift

    var languageCode: String { get }

  • Human-readable name for the language, e.g. English, 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 this cue describes — the speaker, which is distinct from the participant that authored and published it. Nil when the publisher is describing itself.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *targetParticipantId;

    Swift

    var targetParticipantId: String? { get }

  • Start time of the cue in milliseconds, as an int64_t (read it with longLongValue), or nil when the author did not supply timing.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSNumber *startTimeMs;

    Swift

    var startTimeMs: NSNumber? { get }

  • End time of the cue in milliseconds, as an int64_t (read it with longLongValue), or nil when the author did not supply timing.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSNumber *endTimeMs;

    Swift

    var endTimeMs: NSNumber? { get }