# xgplayer-flv

Latest version **3.0.27** (published 2026-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install xgplayer-flv
pnpm add xgplayer-flv
yarn add xgplayer-flv
bun add xgplayer-flv
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.27 |
| Published | 2026-10-29 |
| First published | 2018-06-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 814.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 9312 |
| Maintainers | gemstone, xiyuyizhi, cucygh, hongqiongxing, leonardo-fu, zhangxin92, bethelight, wopen, wudechang, chenyongjin, liangchang |

## Links

- npm: https://www.npmjs.com/package/xgplayer-flv
- Repository: https://github.com/bytedance/xgplayer
- Homepage: https://github.com/bytedance/xgplayer#readme
- Issues: https://github.com/bytedance/xgplayer/issues
- npm.io page: https://npm.io/package/xgplayer-flv

## Dependencies (3)

- [eventemitter3](https://npm.io/package/eventemitter3.md) ^4.0.7
- [xgplayer-transmuxer](https://npm.io/package/xgplayer-transmuxer.md) 3.0.27
- [xgplayer-streaming-shared](https://npm.io/package/xgplayer-streaming-shared.md) 3.0.27

## Recent versions

- 3.0.27 (latest) — 2026-10-29
- 3.0.27-rc.11 (rc) — 2026-10-21
- 3.0.25-alpha.3 (alpha) — 2026-06-11
- 3.0.23-beta.20 (beta) — 2026-05-21
- 3.0.0-next.19-2 (next) — 2024-09-02
- 3.0.0-next.8-1 (next_fix) — 2023-06-05
- 3.0.0-rc.3-1 (rc-test) — 2021-09-08
- 3.0.27-rc.10 — 2026-10-21
- 3.0.27-rc.9 — 2026-10-21
- 3.0.27-rc.8 — 2026-10-21
- 3.0.27-rc.7 — 2026-10-21
- 3.0.27-rc.6 — 2026-10-15
- 3.0.27-rc.5 — 2026-09-30
- 3.0.27-rc.4 — 2026-08-28
- 3.0.27-rc.3 — 2026-08-20
- … 443 more at https://npm.io/package/xgplayer-flv/versions

## README

<div align="center">
  <img src="https://raw.githubusercontent.com/bytedance/xgplayer/master/xgplayer.png" width="384" height="96">
</div>
<div align="center">
  <a href="https://www.npmjs.com/package/xgplayer" target="_blank">
    <img src="https://img.shields.io/npm/v/xgplayer.svg" alt="npm">
  </a>
  <a href="https://www.npmjs.com/package/xgplayer" target="_blank">
    <img src="https://img.shields.io/npm/l/xgplayer.svg" alt="license">
  </a>
  <a href="https://commitizen.github.io/cz-cli/">
    <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="commitizen">
  </a>
</div>

# xgplayer

xgplayer provides a flexible, plugin-based media player for web applications.
Its UI components, loading strategies, and format integrations can be composed
independently.

[Documentation](https://h5player.bytedance.com/en/)

## Installation

```bash
npm install xgplayer
```

## Usage

```html
<div id="player"></div>
```

```js
import Player from 'xgplayer'
import 'xgplayer/dist/index.min.css'

const player = new Player({
  id: 'player',
  url: 'https://s2.pstatp.com/cdn/expire-1-M/byted-player-videos/1.0.0/xgplayer-demo.mp4'
})
```

See the [configuration documentation](https://h5player.bytedance.com/en/config/)
for additional player options.

## Plugins

xgplayer provides built-in UI plugins and optional streaming or feature
packages. See the [plugin documentation](https://h5player.bytedance.com/en/plugins/)
for available integrations.

## Development

The repository uses Yarn 1.x. Fixture commands start local demos for each
format:

```bash
yarn
yarn dev:xgplayer
```

```bash
yarn dev:hls
yarn dev:flv
yarn dev:mp4
```

## Release

See the [release guideline](.github/release-guideline.md) for stable and
prerelease workflows.

## License

By using xgplayer, you agree to the following terms:

1. xgplayer is licensed under the [MIT License](https://opensource.org/licenses/MIT).
2. You authorize the xgplayer project to display the logo of a business using
   xgplayer on the project website.

---
_Source: https://npm.io/package/xgplayer-flv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._