Class: shaka.media.TtmlTextParser

A TextEngine plugin that parses TTML files.

Parameters:
Name Type Attributes Description
data ArrayBuffer
segmentStartTime number <nullable>
segmentEndTime number <nullable>
Source:
Throws:
Returns:
Type
Array.<!TextTrackCue>

Classes

shaka.media.TtmlTextParser.RateInfo_

Members

(private, static, constant, non-null) percentValues_ :RegExp

Type:
  • RegExp
Source:
Example
50% 10%

(private, static, constant, non-null) timeColonFormat_ :RegExp

Type:
  • RegExp
Source:
Example
00:00:40 or 00:40

(private, static, constant, non-null) timeColonFormatFrames_ :RegExp

Type:
  • RegExp
Source:
Example
00:00:40:07 (7 frames) or 00:00:40:07.1 (7 frames, 1 subframe)

(private, static, constant, non-null) timeColonFormatMilliseconds_ :RegExp

example 01:02:43.0345555 or 02:43.03
Type:
  • RegExp
Source:

(private, static, constant, non-null) timeFramesFormat_ :RegExp

Type:
  • RegExp
Source:
Example
75f or 75.5f

(private, static, constant, non-null) timeHMSFormat_ :RegExp

Type:
  • RegExp
Source:
Example
3.45h, 3m or 4.20s

(private, static, constant, non-null) timeTickFormat_ :RegExp

Type:
  • RegExp
Source:
Example
50t or 50.5t

Methods

(private, static) addStyle_(cuenon-null, cueElementnon-null, region, stylesnon-null)

Adds applicable style properties to a cue.
Parameters:
Name Type Description
cue VTTCue
cueElement Element
region Element
styles Array.<!Element>
Source:

(private, static) getElementFromCollection_(element, attributeName, collectionnon-null) → {Element}

Selects an item from |collection| whose id matches |attributeName| from |element|.
Parameters:
Name Type Description
element Element
attributeName string
collection Array.<Element>
Source:
Returns:
Type
Element

(private, static) getInheritedAttribute_(elementnon-null, attributeName) → (nullable) {string}

Traverses upwards from a given node until a given attribute is found.
Parameters:
Name Type Description
element Element
attributeName string
Source:
Returns:
Type
string

(private, static) getLeafNodes_(element) → (non-null) {Array.<!Element>}

Gets leaf nodes of the xml node tree. Ignores the text, br elements and the spans positioned inside paragraphs
Parameters:
Name Type Description
element Element
Source:
Returns:
Type
Array.<!Element>

(private, static) getStyleAttribute_(cueElementnon-null, region, stylesnon-null, attribute) → (nullable) {string}

Finds a specified attribute on either the original cue element or its associated region and returns the value if the attribute was found.
Parameters:
Name Type Description
cueElement Element
region Element
styles Array.<!Element>
attribute string
Source:
Returns:
Type
string

(private, static) parseColonTimeWithFrames_(rateInfonon-null, text) → (nullable) {number}

Parses a TTML colon formatted time containing frames
Parameters:
Name Type Description
rateInfo shaka.media.TtmlTextParser.RateInfo_
text string
Source:
Returns:
Type
number

(private, static) parseCue_(cueElementnon-null, rateInfonon-null, stylesnon-null, regionsnon-null) → (non-null) {TextTrackCue}

Parses an Element into a TextTrackCue or VTTCue.
Parameters:
Name Type Description
cueElement Element
rateInfo shaka.media.TtmlTextParser.RateInfo_
styles Array.<!Element>
regions Array.<!Element>
Source:
Returns:
Type
TextTrackCue

(private, static) parseFramesTime_(rateInfonon-null, text) → (nullable) {number}

Parses a TTML time in frame format
Parameters:
Name Type Description
rateInfo shaka.media.TtmlTextParser.RateInfo_
text string
Source:
Returns:
Type
number

(private, static) parseTickTime_(rateInfonon-null, text) → (nullable) {number}

Parses a TTML time in tick format
Parameters:
Name Type Description
rateInfo shaka.media.TtmlTextParser.RateInfo_
text string
Source:
Returns:
Type
number

(private, static) parseTime_(text, rateInfonon-null) → (nullable) {number}

Parses a TTML time from the given word.
Parameters:
Name Type Description
text string
rateInfo shaka.media.TtmlTextParser.RateInfo_
Source:
Returns:
Type
number

(private, static) parseTimeFromRegex_(regexnon-null, text) → (nullable) {number}

Parses a TTML time with a given regex. Expects regex to be some sort of a time-matcher to match hours, minutes, seconds and milliseconds
Parameters:
Name Type Description
regex RegExp
text string
Source:
Returns:
Type
number