Skip to content
This repository has been archived by the owner on May 17, 2024. It is now read-only.
/ shaka-video-element Public archive

A custom element (web component) for Shaka Player.

License

Notifications You must be signed in to change notification settings

muxinc/shaka-video-element

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<shaka-video>

A custom element (web component) for Shaka Player, which supports both HLS and DASH streaming protocols.

The element API matches the HTML5 <video> tag, so it can be easily swapped with other media, and be compatible with other UI components that work with the video tag, including media chrome.

Example

<html>
<head>
  <script type="module" src="https://unpkg.com/[email protected]"></script>
</head>
<body>

  <shaka-video controls src="https://stream.mux.com/DS00Spx1CV902MCtPj5WknGlR102V5HFkDe.m3u8"></shaka-video>

</body>
</html>

Installing

<shaka-video> is packaged as a javascript module (es6) only, which is supported by all evergreen browsers and Node v12+.

Loading into your HTML using <script>

Note the type="module", that's important.

Modules are always loaded asynchronously by the browser, so it's ok to load them in the head 👍, and best for registering web components quickly.

<head>
  <script type="module" src="https://unpkg.com/[email protected]"></script>
</head>

Adding to your app via npm

npm install shaka-video-element --save

Include in your app javascript (e.g. src/App.js)

import 'shaka-video-element';

This will register the custom elements with the browser so they can be used as HTML.