Members

activeCues :TextTrackCueList

tracks/text-track.js, line 265

The list text track cues that are currently active for this TextTrack.

cues :TextTrackCueList

tracks/text-track.js, line 250

The text track cue list for this TextTrack.

readonly default :boolean

tracks/text-track.js, line 204

If this track was set to be on or off by default. Cannot be changed after creation.

enabled :boolean

tracks/audio-track.js, line 53

If this AudioTrack is enabled or not. When setting this will fire AudioTrack#enabledchange if the state of enabled is changed.

Fires:

• VideoTrack#event:selectedchange

readonly id :string

tracks/track.js, line 62

The id of this track. Cannot be changed after creation.

readonly kind :string

tracks/track.js, line 69

The kind of track that this is. Cannot be changed after creation.

readonly label :string

tracks/track.js, line 76

The label of this track. Cannot be changed after creation.

readonly language :string

tracks/track.js, line 83

The two letter language code for this track. Cannot be changed after creation.

length :number

tracks/track-list.js, line 42

The current number of Tracks in the this Trackist.

length :number

tracks/text-track-cue-list.js, line 53

The current number of TextTrackCues in the TextTrackCueList.

length :number

tracks/html-track-element-list.js, line 34

The current number of Tracks in the this Trackist.

mode :string

tracks/text-track.js, line 218

Set the mode of this TextTrack to a valid TextTrack~Mode. Will not be set if setting to an invalid mode.

Fires:

• TextTrack#event:modechange

constant NONE :HTMLTrackElement~ReadyState

tracks/html-track-element.js, line 14

readyState :HTMLTrackElement~ReadyState

tracks/html-track-element.js, line 85

The current ready state of the track element.

selected :boolean

tracks/video-track.js, line 53

If this VideoTrack is selected or not. When setting this will fire VideoTrack#selectedchange if the state of selected changed.

Fires:

• VideoTrack#event:selectedchange

track :TextTrack

tracks/html-track-element.js, line 95

The underlying TextTrack object.

Methods

createTrackHelper(self, kind, labelopt, languageopt, optionsopt) → {TextTrack}

tech/tech.js, line 57

A function used by Tech to create a new TextTrack.

Parameters:

Name	Type	Attributes	Default	Description
self	Tech			An instance of the Tech class.
kind	string			TextTrack kind (subtitles, captions, descriptions, chapters, or metadata)
label	string	<optional>		Label to identify the text track
language	string	<optional>		Two letter language abbreviation
options	Object	<optional>	{}	An object with additional text track options

Returns:

TextTrack -

The text track that was created.

currentSrc() → {Tech~SourceObject}

tech/flash.js, line 241

Get the current source

Returns:

Tech~SourceObject -

The current source

emulateTextTracks()

tech/tech.js, line 561

Emulate texttracks

module:computed-style(el, prop)

utils/computed-style.js, line 22

A safe getComputedStyle with an IE8 fallback.

This is needed because in Firefox, if the player is loaded in an iframe with display:none, then getComputedStyle returns null, so, we do a null-check to make sure that the player doesn't break in these cases.

Parameters:

Name	Type	Description
el	Element	The element you want the computed style of
prop	string	The property name you want

See:

• https://bugzilla.mozilla.org/show_bug.cgi?id=548397

module:merge-options(sources) → {Object}

utils/merge-options.js, line 17

Deep-merge one or more options objects, recursively merging only plain object properties.

Parameters:

Name	Type	Description
sources	Array.<Object>	One or more objects to merge into a new object.

Returns:

Object -

A new object that is the merged result of all sources.

tryUpdateStyle(el, style, rule)

tracks/text-track-display.js, line 59

Try to update the style of a DOM element. Some style changes will throw an error, particularly in IE8. Those should be noops.

Parameters:

Name	Type	Description
el	Element	The DOM element to be styled.
style	string	The CSS property on the element that should be styled.
rule	string	The style rule that should be applied to the property.

Type Definitions

TextTrackCue

tracks/text-track-cue-list.js, line 7

Properties:

Name	Type	Description
id	string	The unique id for this text track cue
startTime	number	The start time for this text track cue
endTime	number	The end time for this text track cue
pauseOnExit	boolean	Pause when the end time is reached if true.

See:

• Spec