IVSTextCue

Objective-C


@interface IVSTextCue : IVSCue

Swift

class IVSTextCue : IVSCue

Contains information for the display of subtitles and captions including styling and positioning. Currently IVS streams do not contain positioning or styling information for TextCues. TextCues should be rendered in accordance with user preferences for captions/subtitles and should be cleared/reset when switching streams in the player or after a preset timeout period.

  • Returns IVSCueTypeText.

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSCueType _Nonnull type;

    Swift

    var type: IVSCue.CueType { get }

  • Line positioning of the cue.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float line;

    Swift

    var line: Float { get }

  • Size of the cue as a percentage of video size, or zero if unspecified.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float size;

    Swift

    var size: Float { get }

  • Position of the text as a fraction of the cue box within the video.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float position;

    Swift

    var position: Float { get }

  • Text content of the cue.

    Declaration

    Objective-C

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

    Swift

    var text: String { get }

  • Text alignment in the writing direction.

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSTextCueAlignment textAlignment;

    Swift

    var textAlignment: IVSTextCue.Alignment { get }