Class: shaka.text.TextEngine

Constructor

new TextEngine(displayer)

Manages text parsers and cues.
Parameters:
Name Type Description
displayer shakaExtern.TextDisplayer
Implements:
Source:

Members

(private, static, non-null) parserMap_ :Object.<string, !shakaExtern.TextParserPlugin>

Type:
Source:

(private) appendWindowEnd_ :number

Type:
  • number
Source:

(private) appendWindowStart_ :number

Type:
  • number
Source:

(private, nullable) bufferEnd_ :number

Type:
  • number
Source:

(private, nullable) bufferStart_ :number

Type:
  • number
Source:

(private) displayer_ :shakaExtern.TextDisplayer

Type:
Source:

(private) parser_ :shakaExtern.TextParser

Type:
Source:

(private) timestampOffset_ :number

Type:
  • number
Source:

Methods

(static) isTypeSupported(mimeType) → {boolean}

Parameters:
Name Type Description
mimeType string
Source:
Returns:
Type
boolean

(export, static) registerParser(mimeType, pluginnon-null)

Parameters:
Name Type Description
mimeType string
plugin shakaExtern.TextParserPlugin
Source:

(export, static) unregisterParser(mimeType)

Parameters:
Name Type Description
mimeType string
Source:

appendBuffer(buffernon-null, startTimenullable, endTimenullable) → (non-null) {Promise}

Parameters:
Name Type Attributes Description
buffer ArrayBuffer
startTime number <nullable>
 relative to the start of the presentation
endTime number <nullable>
 relative to the start of the presentation
Source:
Returns:
Type
Promise

(export) appendCues(cuesnon-null)

Append cues to text displayer.
Parameters:
Name Type Description
cues Array.<!shaka.text.Cue>
Source:

bufferedAheadOf(t) → {number}

Parameters:
Name Type Description
t number A timestamp
Source:
Returns:
Number of seconds ahead of 't' we have buffered
Type
number

bufferEnd() → (nullable) {number}

Source:
Returns:
Time in seconds of the end of the buffered range, or null if nothing is buffered.
Type
number

bufferStart() → (nullable) {number}

Source:
Returns:
Time in seconds of the beginning of the buffered range, or null if nothing is buffered.
Type
number

(export) destroy() → (non-null) {Promise}

Destroys the object, releasing all resources and shutting down all operations. Returns a Promise which is resolved when destruction is complete. This Promise should never be rejected.
Implements:
Source:
Returns:
Type
Promise

getStartTime(buffernon-null) → {number}

Parse the start time from the text media segment, if possible.
Parameters:
Name Type Description
buffer ArrayBuffer
Source:
Throws:
on failure
Type
shaka.util.Error
Returns:
Type
number

initParser(mimeType)

Initialize the parser. This can be called multiple times, but must be called at least once before appendBuffer.
Parameters:
Name Type Description
mimeType string
Source:

isBuffered(t) → {boolean}

Parameters:
Name Type Description
t number A timestamp
Source:
Returns:
Type
boolean

remove(startTime, endTime) → (non-null) {Promise}

Parameters:
Name Type Description
startTime number relative to the start of the presentation
endTime number relative to the start of the presentation
Source:
Returns:
Type
Promise

setAppendWindow(appendWindowStart, appendWindowEnd)

Parameters:
Name Type Description
appendWindowStart number
appendWindowEnd number
Source:

(export) setDisplayer(displayer)

Parameters:
Name Type Description
displayer shakaExtern.TextDisplayer
Source:

setTimestampOffset(timestampOffset)

Parameters:
Name Type Description
timestampOffset number
Source: