Class: shaka.media.ClosedCaptionParser

Constructor

new ClosedCaptionParser(mimeType)

Parameters:
Name Type Description
mimeType string
Implements:
Source:

Members

decoderFactory_ :shaka.extern.CaptionDecoderPlugin

Type:
Source:

parserMap_ :Map<string, shaka.extern.CeaParserPlugin>

Type:
Source:

ceaDecoder_ :shaka.extern.ICaptionDecoder

Decoder for decoding CEA-X08 data from closed caption packets.
Type:
Source:

ceaParser_ :shaka.extern.ICeaParser

Type:
Source:

currentContinuityTimeline_ :number

Type:
  • number
Source:

decoderCache_ :Map<number, shaka.extern.ICaptionDecoder>

Type:
Source:

Methods

findDecoder() → {shaka.extern.CaptionDecoderPlugin}

Source:
Returns:
Type
shaka.extern.CaptionDecoderPlugin

findParser(mimeType) → {shaka.extern.CeaParserPlugin}

Parameters:
Name Type Description
mimeType string
Source:
Returns:
Type
shaka.extern.CeaParserPlugin

registerDecoder(pluginnon-null)

Parameters:
Name Type Description
plugin shaka.extern.CaptionDecoderPlugin
Source:

registerParser(mimeType, pluginnon-null)

Parameters:
Name Type Description
mimeType string
plugin shaka.extern.CeaParserPlugin
Source:

unregisterDecoder()

Source:

unregisterParser(mimeType)

Parameters:
Name Type Description
mimeType string
Source:

getStreams() → {Array<string>}

Returns the streams that the CEA decoder found.
Implements:
Source:
Returns:
Type
Array<string>

init(initSegment, adaptationopt, continuityTimelineopt)

Initialize the caption parser. This should be called whenever new init segment arrives.
Parameters:
Name Type Attributes Default Description
initSegment BufferSource
adaptation boolean <optional>
 false True if we just automatically switched active variant(s).
continuityTimeline number <optional>
 the optional continuity timeline
Implements:
Source:

parseFrom(mediaFragment) → {Array<!shaka.extern.ICaptionDecoder.ClosedCaption>}

Parses embedded CEA closed captions and interacts with the underlying CaptionStream, and calls the callback function when there are closed captions.
Parameters:
Name Type Description
mediaFragment BufferSource
Implements:
Source:
Returns:
An array of parsed closed captions.
Type
Array<!shaka.extern.ICaptionDecoder.ClosedCaption>

remove(timelinesToKeep)

Remove items from the decoder cache based on the provided continuity timelines. Caches relating to provided timelines are kept and the rest are discarded.
Parameters:
Name Type Description
timelinesToKeep Array<number>
Implements:
Source:

reset()

Resets the CaptionStream.
Implements:
Source:

updateDecoder_()

Source: