Files
shaka-player/docs/design/ui.md
T
Sandra Lokshina 6b1ca2d229 Initial release of Shaka Player UI
Other contributors:
 - @joeyparrish
 - @michellezhuogg
 - @TheModMaker
 - @theodab
 - @vaage

Change-Id: If6df33d9ab5035d1ead4402004f7de37ee8470f4
2018-11-16 14:40:37 -08:00

1.0 KiB

Shaka UI Library Design

Overview

Shaka UI is a customizable, easy to set up UI layer for Shaka Player with built-in accessibility and localization support. It provides a default set of video controls that are visually similar to Chrome native controls and can be added to an application with just one line of code and styled through CSS. Using the UI API, the UI can be customized to better meet applications' needs.

UI layer is a part of the default Shaka build, but can be excluded from the build by applications.

Player-UI relationships

Arrows signify ownership (shaka.UI.Overlay -> shaka.Player mean that shaka.UI.Overlay class has a shaka.Player field).

Player-UI relationships diagram

The following statements are true:

container.ui == video.ui
castProxy.video == video
castProxy.player == ui.player

For details on adding Shaka UI to your application, see UI library tutorial.