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:
Properties:
Name |
Value |
Type |
Description |
NO_BROWSER_SUPPORT |
0
|
number
|
|
PLAYER_FAILED_TO_LOAD |
1
|
number
|
|
- Source:
Describes what information should show up in labels for selecting audio
variants and text tracks.
Type:
Properties:
Name |
Value |
Type |
Description |
LANGUAGE |
0
|
number
|
|
ROLE |
1
|
number
|
|
LANGUAGE_ROLE |
2
|
number
|
|
LABEL |
3
|
number
|
|
- Source:
videoContainer_ :HTMLElement
Type:
- Source:
Methods
dispatchLoadedEvent_(eventName, reasonCodeopt)
Parameters:
- 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, vrCanvasnon-null)
Parameters:
Name |
Type |
Description |
container |
Element
|
|
video |
Element
|
|
lcevcCanvas |
Element
|
|
vrCanvas |
Element
|
|
- Source:
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:
destroy() → {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.
- Implements:
- Source:
Returns:
-
Type
-
Promise
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
setEnabled(enabled)
Enable or disable the custom controls.
Parameters:
Name |
Type |
Description |
enabled |
boolean
|
|
- Source: