Class ITTParser

Parser for iTunes Timed Text (.itt). See TimedTextPlugin for usage examples.

Hierarchy (view full)

IMSCParser
- ITTParser

Index

Constructors

Properties

defaultEncoding OnMetadata format

Methods

addEventListener destroy fetch off on parse removeAllListeners removeEventListener reset

Constructors

constructor

new ITTParser(): ITTParser
Returns ITTParser
Overrides IMSCParser.constructor

Properties

defaultEncoding

defaultEncoding: string = "utf-8"

`Static` OnMetadata

OnMetadata: string = "metadata"

Event type emitted when parser reads metadata that should be passed to renderers

`Static` format

format: SubtitleFormat = SubtitleFormat.ITT

The format this parser is used for

Methods

addEventListener

addEventListener(type, callback, once?): void
Adds an event listener for a specific event.
Parameters
- type: string
  Event type.
- callback: ((...args) => void)
  Listener callback function.
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional once: boolean
  (Optional) Indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked.
Returns void
Inherited from IMSCParser.addEventListener

destroy

destroy(): void
Called when the parser is destroyed, when the subtitle is removed for example.

Returns void
Inherited from IMSCParser.destroy

fetch

fetch(url): Promise<CueData<string>>
Fetches the remote url and returns the data to parse.

This is called for sidecar files.
Parameters
- url: string
  the url to fetch
Returns Promise<CueData<string>>
Throws
error on fetch error

Inherited from IMSCParser.fetch

off

off(type, callback): void
Alias method for removeEventListener.
Parameters
- type: string
  Event type.
- callback: ((...args) => void)
  Listener callback function.
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns void
Inherited from IMSCParser.off

on

on(type, callback, once?): void
Alias method for addEventListener.
Parameters
- type: string
  Event type.
- callback: ((...args) => void)
  Listener callback function.
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional once: boolean
  (Optional) Indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked.
Returns void
Inherited from IMSCParser.on

parse

parse(cueData): TimedTextCue[]
Called when new data is available to parse.

In the case of streaming subtitles this will be called several times during playback, as subtitle data becomes available.

For sidecar files it is called once when the subtitle is loaded.
Parameters
- cueData: CueData<string>
  the cue data to parse
Returns TimedTextCue[]
Throws
error on parse error

Inherited from IMSCParser.parse

removeAllListeners

removeAllListeners(): void
Removes all listeners.

Returns void
Inherited from IMSCParser.removeAllListeners

removeEventListener

removeEventListener(type, callback): void
Removes an event listener for a specific event.
Parameters
- type: string
  Event type.
- callback: ((...args) => void)
  Listener callback function.
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
Returns void
Inherited from IMSCParser.removeEventListener

reset

reset(): void
Resets parser state (for stateful parsers).

This is called when the users seeks to a new position in the video.

Returns void
Inherited from IMSCParser.reset