Class: shaka.media.TextEngine

Classes

shaka.media.TextEngine.TextParserWrapper_

Members

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

Type:

• Object.<string, !shakaExtern.TextParserPlugin>

Source:

• lib/media/text_engine.js, line 56

(private) appendWindowEnd_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 45

(private, nullable) bufferEnd_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 51

(private, nullable) bufferStart_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 48

(private) parser_ :shakaExtern.TextParser

Type:

• shakaExtern.TextParser

Source:

• lib/media/text_engine.js, line 36

(private) timestampOffset_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 42

(private) track_ :TextTrack

Type:

• TextTrack

Source:

• lib/media/text_engine.js, line 39

Methods

(static) isTypeSupported(mimeType) → {boolean}

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/media/text_engine.js, line 91

Returns:

Type

boolean

(static) makeCue(startTime, endTime, payload) → {TextTrackCue}

Creates a cue using the best platform-specific interface available.

Parameters:

Name	Type	Description
startTime	number
endTime	number
payload	string

Source:

• lib/media/text_engine.js, line 105

Returns:

or null if the parameters were invalid.

Type

TextTrackCue

(static) registerParser(mimeType, pluginnon-null)

Parameters:

Name	Type	Description
mimeType	string
plugin	shakaExtern.TextParserPlugin

Source:

• lib/media/text_engine.js, line 64

(static) unregisterParser(mimeType)

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/media/text_engine.js, line 82

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

Parameters:

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

Source:

• lib/media/text_engine.js, line 151

Returns:

Type

Promise

bufferedAheadOf(t) → {number}

Parameters:

Name	Type	Description
t	number	A timestamp

Source:

• lib/media/text_engine.js, line 310

Returns:

Number of seconds ahead of 't' we have buffered

Type

number

bufferEnd() → (nullable) {number}

Source:

• lib/media/text_engine.js, line 292

Returns:

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

Type

number

bufferStart() → (nullable) {number}

Source:

• lib/media/text_engine.js, line 283

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/media/text_engine.js, line 118

Returns:

Type

Promise

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/media/text_engine.js, line 136

isBuffered(t) → {boolean}

Parameters:

Name	Type	Description
t	number	A timestamp

Source:

• lib/media/text_engine.js, line 301

Returns:

Type

boolean

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

Parameters:

Name	Type	Description
start	number
end	number

Source:

• lib/media/text_engine.js, line 220

Returns:

Type

Promise

(private) removeWhere_(predicate)

Remove all cues for which the matching function returns true.

Parameters:

Name	Type	Description
predicate	function(!TextTrackCue): boolean

Source:

• lib/media/text_engine.js, line 326

setAppendWindowEnd(windowEnd)

Parameters:

Name	Type	Description
windowEnd	number

Source:

• lib/media/text_engine.js, line 273

setTimestampOffset(timestampOffset)

Parameters:

Name	Type	Description
timestampOffset	number

Source:

• lib/media/text_engine.js, line 266