Class LanguageMenu

<theoplayer-language-menu> - A menu to change the spoken language and subtitles of the stream.

Slot

heading - A slot for the menu's heading.

Hierarchy

Constructors

constructor

Properties

activeVideoQuality? deviceType? error? fullscreen? playbackRate? previewTime? streamType? targetVideoQualities? theoplayerUiObservedProperties

Accessors

player observedAttributes

Methods

_upgradeProperty attributeChangedCallback closeCurrentMenu closeMenu connectedCallback disconnectedCallback getMenuById hasCurrentMenu isMenuOpen openMenu

Constructors

constructor

Properties

Optional activeVideoQuality

activeVideoQuality?: VideoQuality

Optional deviceType

deviceType?: DeviceType

Optional error

error?: THEOplayerError

Optional fullscreen

fullscreen?: boolean

Optional playbackRate

playbackRate?: number

Optional previewTime

previewTime?: number

Optional streamType

streamType?: StreamType

Optional targetVideoQualities

targetVideoQualities?: VideoQuality[]

Readonly theoplayerUiObservedProperties

theoplayerUiObservedProperties: (keyof StateReceiverPropertyMap)[]

The names of the properties this element will receive.

Accessors

player

Static observedAttributes

Methods

Protected _upgradeProperty

attributeChangedCallback

  • attributeChangedCallback(attrName, oldValue, newValue): void

  • Parameters

    • attrName: string
    • oldValue: any
    • newValue: any

    Returns void

closeCurrentMenu

  • closeCurrentMenu(): boolean

  • Close the current menu.

    Returns boolean

closeMenu

  • closeMenu(menuId?): boolean

  • Closes the menu with the given ID.

    If no ID is given, then the entire menu group is closed.

    If the given menu has opened one or more submenus, then those are also closed. If the last open menu is closed, then the menu group also becomes closed.

    Parameters

    • Optional menuId: string

      The ID of the menu to close.

    Returns boolean

    True if the given menu was found and closed.

connectedCallback

  • connectedCallback(): void

  • Returns void

disconnectedCallback

  • disconnectedCallback(): void

  • Returns void

getMenuById

  • getMenuById(menuId?): undefined | Menu | MenuGroup

  • Get the menu with the given ID.

    Parameters

    • Optional menuId: string

      The ID of the menu. If unset, returns this menu group.

    Returns undefined | Menu | MenuGroup

hasCurrentMenu

  • hasCurrentMenu(): boolean

  • Whether this menu group has a currently open menu.

    Returns boolean

isMenuOpen

  • isMenuOpen(menuId?): boolean

  • Whether the menu with the given ID is currently open.

    Parameters

    • Optional menuId: string

      The ID of the menu.

    Returns boolean

openMenu

  • openMenu(menuId?, opener?): boolean

  • Open the menu with the given ID.

    If no ID is given, the first menu in the group is opened.

    If there's already an open menu, then the new menu is opened as a "submenu". When it closed, the previous menu is opened.

    Parameters

    • Optional menuId: string

      The ID of the menu to open.

    • Optional opener: HTMLElement

      The control that opened the menu. When the menu is closed, focus is moved back to this control.

    Returns boolean

    True if the given menu was found.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc