IVSRemoteSubtitleStream

Objective-C


@interface IVSRemoteSubtitleStream : IVSStageStream

Swift

class IVSRemoteSubtitleStream : IVSStageStream

A remote participant’s subtitle stream.

Warning

This API is in beta and is only available to allowlisted accounts.

  • Set a callback to receive cues on this subtitle stream.

    The callback is invoked on the main thread, so it is safe to touch UI from it. The cue remains valid after the callback returns and may be retained.

    Note

    this must be called on the main thread

    Declaration

    Objective-C

    - (void)setOnCueCallback:
    (nullable void (^)(IVSStageSubtitleCue *_Nonnull))callback;

    Swift

    func setOnCueCallback(_ callback: ((IVSStageSubtitleCue) -> Void)?)

    Parameters

    callback

    A block invoked with each received cue.