Class: shaka.text.VttTextParser

Constructor

new VttTextParser()

Constructs a VTT parser.
Implements:
Source:

Members

MPEG_TIMESCALE_ :number

Type:
  • number
Source:

timeFormat_ :RegExp

Type:
  • RegExp
Source:
Example
00:00.000 or 00:00:00.000 or 0:00:00.000 or
00:00.00 or 00:00:00.00 or 0:00:00.00

manifestType_ :string

Type:
  • string
Source:

sequenceMode_ :boolean

Type:
  • boolean
Source:

Methods

addDefaultTextColor_(stylesnon-null)

Add default color
Parameters:
Name Type Description
styles Map.<string, shaka.text.Cue>
Source:

escapeInvalidChevrons_(inputnon-null) → {string}

This method converts invalid > chevrons to HTML entities. It also removes < chevrons as per spec.
Parameters:
Name Type Description
input string
Source:
Returns:
Type
string

generateCueFromElement_(elementnon-null, rootCuenon-null, stylesnon-null)

Parameters:
Name Type Description
element shaka.extern.xml.Node
rootCue shaka.text.Cue
styles Map.<string, shaka.text.Cue>
Source:

getOrDefault_(value, defaultValue)

Parameters:
Name Type Description
value string
defaultValue string
Source:

getRegionById_(regionsnon-null, id) → {shaka.text.CueRegion}

Parameters:
Name Type Description
regions Array.<!shaka.text.CueRegion>
id string
Source:
Returns:
Type
shaka.text.CueRegion

mergeStyle_(cuenon-null, refCue)

Merges values created in parseStyle_
Parameters:
Name Type Description
cue shaka.text.Cue
refCue shaka.text.Cue
Source:

parseCue_(textnon-null, timeOffset, regionsnon-null, stylesnon-null) → {shaka.text.Cue}

Parses a text block into a Cue object.
Parameters:
Name Type Description
text Array.<string>
timeOffset number
regions Array.<!shaka.text.CueRegion>
styles Map.<string, shaka.text.Cue>
Source:
Returns:
Type
shaka.text.Cue

parseCueSetting(cuenon-null, word, regionsnon-null) → {boolean}

Parses a WebVTT setting from the given word.
Parameters:
Name Type Description
cue shaka.text.Cue
word string
regions Array.<!shaka.text.CueRegion>
Source:
Returns:
True on success.
Type
boolean

parseCueStyles(payload, rootCuenon-null, stylesnon-null)

Parses a WebVTT styles from the given payload.
Parameters:
Name Type Description
payload string
rootCue shaka.text.Cue
styles Map.<string, shaka.text.Cue>
Source:

parsedLineValueAndInterpretation_(cuenon-null, word) → {boolean}

Parameters:
Name Type Description
cue shaka.text.Cue
word string
Source:
Returns:
Type
boolean

parseRegion_(text) → {shaka.text.CueRegion}

Parses a string into a Region object.
Parameters:
Name Type Description
text string
Source:
Returns:
Type
shaka.text.CueRegion

parseRegionSetting_(regionnon-null, word) → {boolean}

Parses a WebVTTRegion setting from the given word.
Parameters:
Name Type Description
region shaka.text.CueRegion
word string
Source:
Returns:
True on success.
Type
boolean

parseStyle_(textnon-null, stylesnon-null)

Parses a style block into a Cue object.
Parameters:
Name Type Description
text Array.<string>
styles Map.<string, shaka.text.Cue>
Source:

parseTime_(parsernon-null) → {number}

Parses a WebVTT time from the given parser.
Parameters:
Name Type Description
parser shaka.util.TextParser
Source:
Returns:
Type
number

replaceKaraokeStylePayload_(payload) → {string}

Converts karaoke style tag to be valid for xml parsing For example, input: Text <00:00:00.450> time <00:00:01.450> 1 output: Text
time
1
Parameters:
Name Type Description
payload string
Source:
Returns:
processed payload
Type
string

replaceVoiceStylePayload_(payload) → {string}

Converts voice style tag to be valid for xml parsing For example, input: Test output: Test
Parameters:
Name Type Description
payload string
Source:
Returns:
processed payload
Type
string

setPositionAlign_(cuenon-null, align)

Parameters:
Name Type Description
cue shaka.text.Cue
align string
Source:

setTextAlign_(cuenon-null, align)

Parameters:
Name Type Description
cue shaka.text.Cue
align string
Source:

setVerticalWritingMode_(cuenon-null, value)

Parameters:
Name Type Description
cue shaka.text.Cue
value string
Source:

computeHlsSequenceModeOffset_(headerBlock, time) → {number}

Parameters:
Name Type Description
headerBlock string Contains X-TIMESTAMP-MAP.
time shaka.extern.TextParser.TimeContext
Source:
Returns:
Type
number

parseInit(datanon-null)

Parse an initialization segment. Some formats do not have init segments so this won't always be called.
Parameters:
Name Type Description
data Uint8Array The data that makes up the init segment.
Implements:
Source:

parseMedia(datanon-null, timeContext, urinullable) → {Array.<!shaka.text.Cue>}

Parse a media segment and return the cues that make up the segment.
Parameters:
Name Type Attributes Description
data Uint8Array The next section of buffer.
timeContext shaka.extern.TextParser.TimeContext The time information that should be used to adjust the times values for each cue.
uri string | undefined <nullable>
 The media uri.
Implements:
Source:
Returns:
Type
Array.<!shaka.text.Cue>

setManifestType(manifestType)

Notifies the manifest type.
Parameters:
Name Type Description
manifestType string
Implements:
Source:

setSequenceMode(sequenceMode)

Notifies the stream if the manifest is in sequence mode or not.
Parameters:
Name Type Description
sequenceMode boolean
Implements:
Source: