Bitmovin Player API 8.268.0
    Preparing search index...

    Interface SubtitleCueParsedEvent

    Event payload for CueParsed events.

    interface SubtitleCueParsedEvent {
        end: number;
        html?: string;
        image?: string;
        position?: SubtitleCuePosition;
        region?: string;
        regionStyle?: string;
        start: number;
        subtitleId: string;
        text: string;
        timestamp: number;
        type: PlayerEvent;
        updates?: { html: string; updateTime: number }[];
        vtt?: VTTProperties;
    }

    Hierarchy (View Summary)

    Index
    end html? image? position? region? regionStyle? start subtitleId text timestamp type updates? vtt?
    end: number

    The playback time when the subtitle should be hidden

    getCurrentTime

    html?: string

    The textual content prepared to be put into a html element

    image?: string

    Data-URL containing the image data.

    position?: SubtitleCuePosition

    Only relevant for CEA-captions, provides information about where the cue should be positioned on a grid of 15 character rows times 32 columns. See https://dvcs.w3.org/hg/text-tracks/raw-file/default/608toVTT/608toVTT.html#positioning-in-cea-608 for detailed explanation.

    region?: string

    The region in which the subtitle should be displayed. Will be filled with information of the region attribute in TTML subtitle cues

    regionStyle?: string

    The style information of the region in which this subtitle should be displayed. Will be filled with the style information provided in the head of the TTML document if it matches the current cue's region attribute.

    start: number

    The playback time when the subtitle should be rendered

    getCurrentTime

    subtitleId: string

    The id of the associated subtitle track defined in id

    text

    text: string

    The textual content of this subtitle

    timestamp: number

    The time at which this event was fired

    type: PlayerEvent

    Event type, e.g. 'play'

    updates?: { html: string; updateTime: number }[]

    Changes to the cue, that will result in CueUpdate events. This will only be populated for WebVTT cues that contain inline timestamp tags.

    Type Declaration

    • html: string

      The stringified HTML content, prepared to be put into an HTML element.

    • updateTime: number

      The time at which the update occurs, in seconds.

    vtt?: VTTProperties

    Options for WebVTT subtitle styling and positioning, including region settings.

    Settings
    Member Visibility

    On This Page
    Properties