Class: shaka.ui.Overlay

Constructor

(export) new Overlay(playernon-null, videoContainernon-null, videonon-null, configopt, non-null)

Parameters:
Name Type Attributes Description
player shaka.Player
videoContainer HTMLElement
video HTMLMediaElement
config Object <optional>
 This should follow the form of shaka.extern.UIConfiguration, but you may omit any field you do not wish to change.
Source:

Members

(private, non-null) config_ :shaka.extern.UIConfiguration

Type:
Source:

(private, non-null) controls_ :shaka.ui.Controls

Type:
Source:

(private, non-null) player_ :shaka.Player

Type:
Source:

Methods

(private, static) createUI_(containernon-null, videonon-null, confignon-null) → (non-null) {shaka.ui.Overlay}

Parameters:
Name Type Description
container HTMLElement
video HTMLMediaElement
config Object (Possibly partial) config in the form of shaka.extern.UIConfiguration
Source:
Returns:
Type
shaka.ui.Overlay

(private, static) scanPageForShakaElements_()

Source:

(private) defaultConfig_() → (non-null) {shaka.extern.UIConfiguration}

Source:
Returns:
Type
shaka.extern.UIConfiguration

(export) getControls() → (non-null) {shaka.ui.Controls}

Source:
Returns:
Type
shaka.ui.Controls

(export) getPlayer() → (non-null) {shaka.Player}

Source:
Returns:
Type
shaka.Player

(export) setEnabled(enabled)

Enable or disable the custom controls.
Parameters:
Name Type Description
enabled boolean
Source: