Chartbreaker
    Preparing search index...

    Interface TextTrack

    The TextTrack interface of the WebVTT API represents a text track associated with a media element.

    MDN Reference

    interface TextTrack {
        activeCues: null | TextTrackCueList;
        cues: null | TextTrackCueList;
        id: string;
        inBandMetadataTrackDispatchType: string;
        kind: TextTrackKind;
        label: string;
        language: string;
        mode: TextTrackMode;
        oncuechange: null | ((this: TextTrack, ev: Event) => any);
        addCue(cue: TextTrackCue): void;
        addEventListener<K extends "cuechange">(
            type: K,
            listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        removeCue(cue: TextTrackCue): void;
        removeEventListener<K extends "cuechange">(
            type: K,
            listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy

    • EventTarget
      • TextTrack
    Index

    Properties

    activeCues cues id inBandMetadataTrackDispatchType kind label language mode oncuechange

    Methods

    addCue addEventListener dispatchEvent removeCue removeEventListener

    Properties

    activeCues: null | TextTrackCueList

    The activeCues read-only property of the TextTrack interface returns a TextTrackCueList object listing the currently active cues.

    MDN Reference

    cues: null | TextTrackCueList

    The cues read-only property of the TextTrack interface returns a TextTrackCueList object containing all of the track's cues.

    MDN Reference

    id: string

    The id read-only property of the TextTrack interface returns the ID of the track if it has one.

    MDN Reference

    inBandMetadataTrackDispatchType: string

    The inBandMetadataTrackDispatchType read-only property of the TextTrack interface returns the text track's in-band metadata dispatch type of the text track represented by the TextTrack object.

    MDN Reference

    kind: TextTrackKind

    The kind read-only property of the TextTrack interface returns the kind of text track this object represents.

    MDN Reference

    label: string

    The label read-only property of the TextTrack interface returns a human-readable label for the text track, if it is available.

    MDN Reference

    language: string

    The language read-only property of the TextTrack interface returns the language of the text track.

    MDN Reference

    mode: TextTrackMode

    The TextTrack interface's mode property is a string specifying and controlling the text track's mode: disabled, hidden, or showing.

    MDN Reference

    oncuechange: null | ((this: TextTrack, ev: Event) => any)

    MDN Reference

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods