SubtitlesContextMenu

UI for selecting the active subtitle language.

Props

  • contextmenuVisible {boolean} - Should the context menu be visible.
  • subtitlesVisible {boolean} - Are subtitles active in the player.
  • availableLanguages {object} - Which subtitle languages are available in the player
  • selectedLanguage {string} - The id of the active language

API

player.ekoshell.SubtitlesContextMenu

  • show() - Shows the subtitles selection menu
  • hide() - Hides the subtitles selection menu
  • selectLanguage(clickedLang {string}) - Selects a language in the subtitles plugin and activates subtitles if necessary. clickedLang is the language id.

Events

  • SUBTITLES_MENU_OPEN: 'ekoshell.button.cc.menu.open'
  • SUBTITLES_MENU_CLOSE: 'ekoshell.button.cc.menu.close'
  • SUBTITLES_SELECTED: 'ekoshell.menu.cc.selected'

Plugin Options

No configurable options.

parentContainer

root

Notes

  • Adds SHOW_LANGUAGE_MENU to the ControlsOverlay‘s AutoHide action list.
  • Hides the menu on player playing.
  • Hides the menu when ControlsOverlay is hidden
  • Hides the menu when the volume slider is hidden
Rate this page: X
Tell us more!