Class: shaka.text.TextEngine

Members

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

Type:

• Object.<string, !shakaExtern.TextParserPlugin>

Source:

• lib/text/text_engine.js, line 59

(private) appendWindowEnd_ :number

Type:

• number

Source:

• lib/text/text_engine.js, line 48

(private) appendWindowStart_ :number

Type:

• number

Source:

• lib/text/text_engine.js, line 45

(private, nullable) bufferEnd_ :number

Type:

• number

Source:

• lib/text/text_engine.js, line 54

(private, nullable) bufferStart_ :number

Type:

• number

Source:

• lib/text/text_engine.js, line 51

(private) displayer_ :shakaExtern.TextDisplayer

Type:

• shakaExtern.TextDisplayer

Source:

• lib/text/text_engine.js, line 39

(private) parser_ :shakaExtern.TextParser

Type:

• shakaExtern.TextParser

Source:

• lib/text/text_engine.js, line 36

(private) timestampOffset_ :number

Type:

• number

Source:

• lib/text/text_engine.js, line 42

Methods

(static) isTypeSupported(mimeType) → {boolean}

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/text/text_engine.js, line 85

Returns:

Type

boolean

(static) registerParser(mimeType, pluginnon-null)

Parameters:

Name	Type	Description
mimeType	string
plugin	shakaExtern.TextParserPlugin

Source:

• lib/text/text_engine.js, line 67

(static) unregisterParser(mimeType)

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/text/text_engine.js, line 76

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

Parameters:

Name	Type	Attributes	Description
buffer	ArrayBuffer
startTime	number	<nullable>
endTime	number	<nullable>

Source:

• lib/text/text_engine.js, line 162

Returns:

Type

Promise

bufferedAheadOf(t) → {number}

Parameters:

Name	Type	Description
t	number	A timestamp

Source:

• lib/text/text_engine.js, line 297

Returns:

Number of seconds ahead of 't' we have buffered

Type

number

bufferEnd() → (nullable) {number}

Source:

• lib/text/text_engine.js, line 279

Returns:

Time in seconds of the end of the buffered range, or null if nothing is buffered.

Type

number

bufferStart() → (nullable) {number}

Source:

• lib/text/text_engine.js, line 270

Returns:

Time in seconds of the beginning of the buffered range, or null if nothing is buffered.

Type

number

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:

• shaka.util.IDestroyable#destroy

Source:

• lib/text/text_engine.js, line 91

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:

• lib/text/text_engine.js, line 130

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:

• lib/text/text_engine.js, line 114

isBuffered(t) → {boolean}

Parameters:

Name	Type	Description
t	number	A timestamp

Source:

• lib/text/text_engine.js, line 288

Returns:

Type

boolean

remove(start, end) → (non-null) {Promise}

Parameters:

Name	Type	Description
start	number
end	number

Source:

• lib/text/text_engine.js, line 214

Returns:

Type

Promise

setAppendWindow(appendWindowStart, appendWindowEnd)

Parameters:

Name	Type	Description
appendWindowStart	number
appendWindowEnd	number

Source:

• lib/text/text_engine.js, line 259

setDisplayer(displayer)

Parameters:

Name	Type	Description
displayer	shakaExtern.TextDisplayer

Source:

• lib/text/text_engine.js, line 103

setTimestampOffset(timestampOffset)

Parameters:

Name	Type	Description
timestampOffset	number

Source:

• lib/text/text_engine.js, line 249