Class

player/extension/HTML5PlayerExternalSubtitle

player/extension/HTML5PlayerExternalSubtitle()

Constructor

# new player/extension/HTML5PlayerExternalSubtitle()

HTML5 Player External Subtitle Strategy.

Implements:
  • interfaces/SubtitleStrategy

Methods

# protected _getCapability() → {Array.<String>}

To get the supported format

Supported format

Array.<String>

# getCurrentSubtitle() → {Promise.<Subtitle>}

Retrieve information about the current subtitle.

Native Promise.

Promise.<Subtitle>

# getSubtitles() → {Promise.<Array.<Subtitle>>}

Retrieve all subtitles information.

Native Promise.

Promise.<Array.<Subtitle>>

# hideSubtitle() → {Promise}

Hide the current subtitle.

Native Promise. rejected one otherwise.

Promise

# prepare(player, subtitleOptionopt) → {void}

To prepare the subtitles, it will load the strategies and prepare them

Parameters:
Name Type Attributes Description
player interfaces/Player

the player

subtitleOption Object <optional>

the subtitle options

void

# showSubtitle(id) → {Promise}

Show the subtitle specified by the ID.

Parameters:
Name Type Description
id String

ID of the subtitle.

Native Promise. rejected one otherwise.

Promise