Class: shaka.media.TextEngine

Members

(private, static) CueConstructor_ :function(new:TextTrackCue, number, number, string)

Type:

• function(new:TextTrackCue, number, number, string)

Source:

• lib/media/text_engine.js, line 126

(private, static, non-null) parserMap_ :Object.<string, !shaka.media.TextEngine.TextParser>

Type:

• Object.<string, !shaka.media.TextEngine.TextParser>

Source:

• lib/media/text_engine.js, line 72

(private) appendWindowEnd_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 50

(private, nullable) bufferEnd_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 56

(private, nullable) bufferStart_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 53

(private, nullable) parser_ :shaka.media.TextEngine.TextParser

Type:

• shaka.media.TextEngine.TextParser

Source:

• lib/media/text_engine.js, line 37

(private) timestampOffset_ :number

Type:

• number

Source:

• lib/media/text_engine.js, line 47

(private) track_ :TextTrack

Type:

• TextTrack

Source:

• lib/media/text_engine.js, line 44

Methods

(static) isTypeSupported(mimeType) → {boolean}

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/media/text_engine.js, line 98

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 112

Returns:

or null if the parameters were invalid.

Type

TextTrackCue

(static) registerParser(mimeType, parsernon-null)

Parameters:

Name	Type	Description
mimeType	string
parser	shaka.media.TextEngine.TextParser

Source:

• lib/media/text_engine.js, line 80

(static) unregisterParser(mimeType)

Parameters:

Name	Type	Description
mimeType	string

Source:

• lib/media/text_engine.js, line 89

appendBuffer(buffer, 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 148

Returns:

Type

Promise

bufferedAheadOf(t) → {number}

Parameters:

Name	Type	Description
t	number	A timestamp

Source:

• lib/media/text_engine.js, line 267

Returns:

Number of seconds ahead of 't' we have buffered

Type

number

bufferEnd() → (nullable) {number}

Source:

• lib/media/text_engine.js, line 258

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 249

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 130

Returns:

Type

Promise

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

Parameters:

Name	Type	Description
start	number
end	number

Source:

• lib/media/text_engine.js, line 189

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 285

setAppendWindowEnd(windowEnd)

Parameters:

Name	Type	Description
windowEnd	number

Source:

• lib/media/text_engine.js, line 239

setTimestampOffset(timestampOffset)

Parameters:

Name	Type	Description
timestampOffset	number

Source:

• lib/media/text_engine.js, line 232

Type Definitions

TextParser

Parses a text buffer into an array of cues.

Type:

• function(ArrayBuffer, number, ?number, ?number): !Array.<!TextTrackCue>

Source:

• lib/media/text_engine.js, line 68