UNPKG

hls-video-element

Version:

Custom element (web component) for playing video using the HTTP Live Streaming (HLS) format. Uses HLS.js.

github.com/muxinc/media-elements

muxinc/media-elements

57 lines (41 loc) • 3.18 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# `<hls-video>` [![NPM Version](https://img.shields.io/npm/v/hls-video-element?style=flat-square&color=informational)](https://www.npmjs.com/package/hls-video-element) [![NPM Downloads](https://img.shields.io/npm/dm/hls-video-element?style=flat-square&color=informational&label=npm)](https://www.npmjs.com/package/hls-video-element) [![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/hls-video-element?style=flat-square&color=%23FF5627)](https://www.jsdelivr.com/package/npm/hls-video-element) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/hls-video-element?style=flat-square&color=success&label=gzip)](https://bundlephobia.com/result?p=hls-video-element) A [custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for [hls.js](https://github.com/video-dev/hls.js) with an API that matches the [`<video>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video) API. - 🏄‍♂️ Compatible [`HTMLMediaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) API - 🕺 Seamlessly integrates with [Media Chrome](https://github.com/muxinc/media-chrome) ## Example <!-- prettier-ignore --> ```html <script type="module" src="https://cdn.jsdelivr.net/npm/hls-video-element@1.1/+esm"></script> <hls-video controls src="https://stream.mux.com/r4rOE02cc95tbe3I00302nlrHfT023Q3IedFJW029w018KxZA.m3u8"></hls-video> ``` ## Install First install the NPM package: ```bash npm install hls-video-element ``` Import in your app javascript (e.g. src/App.js): ```js import 'hls-video-element'; ``` Optionally, you can load the script directly from a CDN using [jsDelivr](https://www.jsdelivr.com/): <!-- prettier-ignore --> ```html <script type="module" src="https://cdn.jsdelivr.net/npm/hls-video-element@1.1/+esm"></script> ``` This will register the custom elements with the browser so they can be used as HTML. ## Related - [Media Chrome](https://github.com/muxinc/media-chrome) Your media player's dancing suit. 🕺 - [`<youtube-video>`](https://github.com/muxinc/media-elements/tree/main/packages/youtube-video-element) A custom element for the YouTube player. - [`<vimeo-video>`](https://github.com/muxinc/media-elements/tree/main/packages/vimeo-video-element) A custom element for the Vimeo player. - [`<videojs-video>`](https://github.com/muxinc/media-elements/tree/main/packages/videojs-video-element) A custom element for Video.js. - [`<wistia-video>`](https://github.com/muxinc/media-elements/tree/main/packages/wistia-video-element) A custom element for the Wistia player. - [`<jwplayer-video>`](https://github.com/muxinc/media-elements/tree/main/packages/jwplayer-video-element) A custom element for the JW player. - [`castable-video`](https://github.com/muxinc/media-elements/tree/main/packages/castable-video) Cast your video element to the big screen with ease! - [`<mux-player>`](https://github.com/muxinc/elements/tree/main/packages/mux-player) The official Mux-flavored video player custom element. - [`<mux-video>`](https://github.com/muxinc/elements/tree/main/packages/mux-video) A Mux-flavored HTML5 video element w/ hls.js and Mux data builtin.