Amazon IVS Player
    Preparing search index...

    Interface TextCue

    Contains information for the display of subtitles and captions including styling and positioning. Note: 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.

    interface TextCue {
        endTime: number;
        line: number;
        position: number;
        size: number;
        startTime: number;
        text: string;
        type: "TextCue";
    }

    Hierarchy (View Summary)

    Index

    Properties

    endTime: number

    The time when the cue should be cleared.

    line: number

    The line on which the text belongs.

    position: number

    The position of the text as a fraction of the cue box within the video.

    size: number

    The size of the cue as a percentage of the video.

    startTime: number

    The time when the cue should be displayed.

    text: string

    The text of the cue.

    type: "TextCue"