# mux-background-video

Mux-specific name for the HLS background video component

`<mux-background-video>` is the Mux-specific name for [`<hls-background-video>`](https://videojs.org/docs/framework/html/reference/components/hls-background-video). The two names use the same implementation and API.

Use this name when your source is a Mux HLS URL and the Mux identity makes the composition easier to read. See [Add a background video](https://videojs.org/docs/framework/html/guides/background-video) to compare the background-video options.

## Import

```ts
import '@videojs/html/media/mux-background-video';
```

Or load it from the [CDN](https://videojs.org/docs/framework/html/guides/cdn):

```html
<script type="module" src="https://cdn.jsdelivr.net/npm/@videojs/cdn@10.0.0-rc.4/media/mux-background-video.js"></script>
```

## Load a Mux source

Pass a complete Mux HLS URL through `src`. This component does not take a playback ID or structured `source` object. Use Mux delivery query parameters to limit which renditions Mux includes in the manifest:

```html
<mux-background-video
  src="https://stream.mux.com/PLAYBACK_ID.m3u8?max_resolution=720p"
  crossorigin
></mux-background-video>
```

`<mux-background-video>` does not create a poster or preview thumbnails, and it does not send analytics data. Keep the poster in your page and add analytics separately when you need them.

## API

The source, error, fixed playback behavior, and CSS custom properties are identical to [`<hls-background-video>`](https://videojs.org/docs/framework/html/reference/components/hls-background-video).

---

HTML documentation: https://videojs.org/docs/framework/html/llms.txt
All documentation: https://videojs.org/llms.txt