larkplayer
中文｜[English](./readme-en.md)
## 简介
larkplayer 是一款轻量、可扩展的 html5 播放器。
核心在于插件化的机制，使得播放器可以像[高达](https://baike.baidu.com/item/%E6%9C%BA%E5%8A%A8%E6%88%98%E5%A3%AB%E9%AB%98%E8%BE%BE/9365)一样可拆卸和组装，从而舒适地支持业务从简单到复杂的演变。
#### 功能支持
* 支持 mp4、webm、ogg、m3u8 多种格式
* 支持 PC、移动端自适应样式
* 支持视频点播、直播
* 支持断点续播功能
* 支持360°全景视频
相关功能通过插件提供，请参考下文的插件章节
#### 特性
* 体积小巧，~12KB(gzip)
* 解决大部分兼容性问题，如全屏、移动端内联播放等
* 提供事件机制，支持自定义事件
* 提供插件机制，支持多种插件类型
* 原生 javascript 编写，无特定框架依赖
查看[在线示例](https://dblate.github.io/larkplayer/examples/)
## 下载
NPM
```
npm install larkplayer
```
CDN
```
```
## 快速上手
#### 通过 script 的方式
```html
larkplayer quick start
```
#### 通过 npm + es6 的方式
```javascript
import larkplayer from 'larkplayer';
const player = larkplayer('video-el');
```
## 文档
* [设计思路](./docs/design.md)
* [使用示例](./docs/example.md)
* [插件编写](./docs/plugin)
* [Player API](./docs/api/player.md)
* [Events API](./docs/api/events.md)
* [DOM API](./docs/api/dom.md)
## 插件
* [larkplayer-ui](https://github.com/dblate/larkplayer-ui) 提供适应 PC 与 Mobile 的样式
* [larkplayer-hls](https://github.com/dblate/larkplayer-hls) 支持 M3U8 视频类型
* [larkplayer-vr](https://github.com/dblate/larkplayer-vr) 支持 VR 全景视频
* [larkplayer-auto-resume](https://github.com/dblate/larkplayer-auto-resume) 提供断点续播功能
* [larkplayer-play-muted](https://github.com/dblate/larkplayer-play-muted) 静音播放时，为用户提供提示与交互
## 如何贡献代码
* fork 或 clone 代码到本地
* 修改代码
* 使用 [fecs](http://fecs.baidu.com/api) 检查 js 代码规范
* 在项目根目录下执行 fecs src （更多选项可参考 [fecs_eslint_wiki](https://github.com/ecomfe/fecs/wiki/ESLint)）
* 修复所有级别为 ERROR 的提示
* 建议修复所有级别为 WARN 的提示
* 执行测试
* 切换到 test 目录，并执行 karma start
* 修复未通过的 case
* 提交 pull request
## 使用交流
QQ 群：860073225
## Change Log
[CHANGELOG](./CHANGELOG.md)
## License
larkplayer is [MIT licensed](./LICENSE)