Options
All
  • Public
  • Public/Protected
  • All
Menu

This interface also inherits properties from EventTarget.

Hierarchy

  • EventTarget
    • TextTrack

Index

Properties

activeCues: null | internal.TextTrackCueList

Returns the text track cues from the text track list of cues that are currently active (i.e. that start before the current playback position and end after it), as a TextTrackCueList object.

Returns the text track list of cues, as a TextTrackCueList object.

id: string

Returns the ID of the given track.

For in-band tracks, this is the ID that can be used with a fragment if the format supports media fragment syntax, and that can be used with the getTrackById() method.

For TextTrack objects corresponding to track elements, this is the ID of the track element.

inBandMetadataTrackDispatchType: string

Returns the text track in-band metadata track dispatch type string.

Returns the text track kind string.

label: string

Returns the text track label, if there is one, or the empty string otherwise (indicating that a custom label probably needs to be generated from the other attributes of the object if the object is exposed to the user).

language: string

Returns the text track language string.

Returns the text track mode, represented by a string from the following list:

Can be set, to change the mode.

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

Methods

  • Adds the given cue to textTrack's text track list of cues.

    Parameters

    Returns void

  • addEventListener<K>(type: K, listener: ((this: internal.TextTrack, ev: TextTrackEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • Type Parameters

    • K extends "cuechange"

    Parameters

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

  • Removes the given cue from textTrack's text track list of cues.

    Parameters

    Returns void

  • removeEventListener<K>(type: K, listener: ((this: internal.TextTrack, ev: TextTrackEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
  • Type Parameters

    • K extends "cuechange"

    Parameters

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

Generated using TypeDoc