Class: shaka.ui.Overlay

Constructor

new Overlay(playernon-null, videoContainernon-null, videonon-null, vrCanvasopt, nullable)

Parameters:
Name Type Attributes Default Description
player shaka.Player
videoContainer HTMLElement
video HTMLMediaElement
vrCanvas HTMLCanvasElement <optional>
<nullable>
 null
Implements:
Source:

Members

FailReasonCode :number

Describes the possible reasons that the UI might fail to load.
Type:
  • number
Properties:
Name Value Type Description
NO_BROWSER_SUPPORT 0 number
PLAYER_FAILED_TO_LOAD 1 number
Source:

TrackLabelFormat :number

Describes what information should show up in labels for selecting audio variants and text tracks.
Type:
  • number
Properties:
Name Value Type Description
LANGUAGE 0 number
ROLE 1 number
LANGUAGE_ROLE 2 number
LABEL 3 number
Source:

config_ :shaka.extern.UIConfiguration

Type:
Source:

controls_ :shaka.ui.Controls

Type:
Source:

player_ :shaka.Player

Type:
Source:

videoContainer_ :HTMLElement

Type:
  • HTMLElement
Source:

watermark_ :shaka.ui.Watermark

Type:
Source:

Methods

dispatchLoadedEvent_(eventName, reasonCodeopt)

Parameters:
Name Type Attributes Description
eventName string
reasonCode shaka.ui.Overlay.FailReasonCode <optional>
Source:

findOrMakeSpecialCanvases_(containernon-null, canvasesnon-null, vrCanvasesnon-null) → {{lcevcCanvas: !Element, vrCanvas: ?Element}}

Parameters:
Name Type Description
container Element
canvases NodeList<!Element>
vrCanvases NodeList<!Element>
Source:
Returns:
Type
{lcevcCanvas: !Element, vrCanvas: ?Element}

scanPageForShakaElements_()

Source:

setupUIandAutoLoad_(containernon-null, videonon-null, lcevcCanvasnon-null, vrCanvasnullable)

Parameters:
Name Type Attributes Description
container Element
video Element
lcevcCanvas Element
vrCanvas Element <nullable>
Source:

configure(config, valueopt)

Parameters:
Name Type Attributes Description
config string | Object This should either be a field name or an object following the form of shaka.extern.UIConfiguration, where you may omit any field you do not wish to change.
value * <optional>
 This should be provided if the previous parameter was a string field name.
Source:

defaultConfig_() → {shaka.extern.UIConfiguration}

Source:
Returns:
Type
shaka.extern.UIConfiguration

destroy(forceDisconnectopt) → {Promise}

Request that this object be destroyed, releasing all resources and shutting down all operations. Returns a Promise which is resolved when destruction is complete. This Promise should never be rejected.
Parameters:
Name Type Attributes Default Description
forceDisconnect boolean <optional>
 false If true, force the receiver app to shut down by disconnecting. Does nothing if not connected.
Implements:
Source:
Returns:
Type
Promise

getConfiguration() → {shaka.extern.UIConfiguration}

Source:
Returns:
Type
shaka.extern.UIConfiguration

getControls() → {shaka.ui.Controls}

Source:
Returns:
Type
shaka.ui.Controls

isMobile() → {boolean}

Detects if this is a mobile platform, in case you want to choose a different UI configuration on mobile devices.
Source:
Returns:
Type
boolean

isSmartTV() → {boolean}

Detects if this is a smart tv platform, in case you want to choose a different UI configuration on smart tv devices.
Source:
Returns:
Type
boolean

removeWatermark()

Source:

setEnabled(enabled)

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

setTextWatermark(text, optionsopt, nullable)

Parameters:
Name Type Attributes Description
text string
options shaka.ui.Watermark.Options <optional>
<nullable>
Source:

setupCastSenderUrl_()

Source: