# Livery Video Web Player

[![npm package](https://img.shields.io/npm/v/@liveryvideo/player.svg?logo=npm)](https://www.npmjs.com/package/@liveryvideo/player)
[![conventional CHANGELOG](https://img.shields.io/badge/conventional-CHANGELOG-FE5196.svg?logo=conventionalcommits)](https://docs.livery.live/npm/player/CHANGELOG)
[![tsdoc API](https://img.shields.io/badge/tsdoc-API-3178C6.svg?logo=typescript)](https://docs.livery.live/npm/player/dist/)
[![docsify Documentation](https://img.shields.io/badge/docsify-Documentation-2ECE53.svg?logo=docsify)](https://docs.livery.live/web-player)
[![Lit Elements](https://img.shields.io/badge/Lit-Elements-324FFF.svg?logo=lit)](https://lit.dev/)
[![license MIT](https://img.shields.io/npm/l/@liveryvideo/player.svg?color=808080&logo=unlicense)](https://cdn.jsdelivr.net/npm/@liveryvideo/player/LICENSE)

Livery video player for use in web browsers.

Please refer to our [docs](https://docs.livery.live/web-player) page for further information.

You can also view the [CHANGELOG](CHANGELOG.md) and [API](dist/index.md) documentation that are included in this NPM package from there.

## Installation

```bash
npm install @liveryvideo/player
```

Or just load the package using a script tag:

```html
<!-- Replace 'x.y.z' by your desired player version below -->
<script src="https://cdn.jsdelivr.net/npm/@liveryvideo/player@x.y.z"></script>
```

## Usage

```html
<!-- Replace the Livery Demo id by your stream id below -->
<livery-player streamid="6613d164e4b0bf3ad645f3c6"></livery-player>

<!-- For debugging you can also use the following elements -->
<livery-buffer-graph></livery-buffer-graph>
<livery-log></livery-log>
```