Interface SubtitleTrack

Hierarchy

  • TextTrack
    • SubtitleTrack

Properties

activeCues cues enabled? forced? id inBandMetadataTrackDispatchType kind label language mode oncuechange

Methods

addCue addEventListener dispatchEvent removeCue removeEventListener

Properties

Readonly activeCues

activeCues: 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.

Readonly cues

cues: TextTrackCueList

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

Optional enabled

enabled?: boolean

Optional forced

forced?: boolean

Readonly id

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.

Readonly inBandMetadataTrackDispatchType

inBandMetadataTrackDispatchType: string

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

Readonly kind

kind: TextTrackKind

Returns the text track kind string.

Readonly label

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).

Readonly language

language: string

Returns the text track language string.

mode

mode: TextTrackMode

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

Can be set, to change the mode.

oncuechange

oncuechange: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: TextTrack
      • ev: Event

      Returns any

Methods

addCue

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

    Parameters

    • cue: TextTrackCue

    Returns void

addEventListener

  • Type Parameters

    • K extends "cuechange"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: TextTrack
          • ev: TextTrackEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

dispatchEvent

  • 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

removeCue

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

    Parameters

    • cue: TextTrackCue

    Returns void

removeEventListener

  • Type Parameters

    • K extends "cuechange"

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: TextTrack
          • ev: TextTrackEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc