Files
ArtPlayer/README-CN.md
T
2020-05-15 13:21:16 +08:00

5.7 KiB

ArtPlayer.js

🎨 ArtPlayer.js 是一个现代全功能的 HTML5 视频播放器

Build Status version license size npm Downloads Codacy Badge dependencies Status

Screenshot

Features

  • 大小 - artplayer.js ≈ 100kb
  • 字幕 - 支持 .VTT, .ASS 和 .SRT 格式
  • 自定义 - 右键菜单, 业务图层, 视频控制器 和 设置面板
  • 控制器 - 画质切换, 字幕切换, 播放速度, 长宽比, 视频翻转, 全屏, 画中画, 截图, 缩略图, 自适应尺寸, 高亮 和 热键...
  • 内建 - 打开本地字幕, 打开本地视频, 迷你进度条, 网络监测 和 字幕时间偏移
  • 集成 - 容易与其它依赖集成:flv.js, hls.js, dash.js, shaka-player, webtorrent...
  • 代码 - 纯 ES6 和 SASS, 高解耦的代码, 清晰的结构, 容易跟踪 Bug 和添加新功能
  • 文档 - 详尽的接口文档和丰富的代码演示
  • 接口 - 丰富的接口和响应事件, 容易对接到业务或者自定义插件
  • 多语言 - 支持控件的国际化

生态

项目 描述 演示
artplayer-plugin-danmuku 弹幕库插件 demo
artplayer-plugin-gif GIF 生成插件 demo
artplayer-plugin-backlight 背光插件 demo
artplayer-tool-thumbnail 缩略图生成工具 demo
artplayer-tool-github Github 弹幕库工具 demo
artplayer-react React 组件 demo
artplayer-vue Vue 组件 demo

演示

打开 Github Pages 演示

手机端演示

mobile

文档

打开 Github Pages 文档

安装

通过 npm 安装:

$ npm install artplayer

或者通过 yarn 安装:

$ yarn add artplayer
import Artplayer from 'artplayer';

或者直接引入umd文件:

<script src="path/to/artplayer.js"></script>

或者从 jsDelivr CDN 引入:

<script src="https://cdn.jsdelivr.net/npm/artplayer/dist/artplayer.js"></script>

将会导出全局变量到window.Artplayer.

使用

<div class="artplayer-app"></div>
var art = new Artplayer({
    container: '.artplayer-app',
    url: 'path/to/video.mp4',
});

贡献

安装依赖:

$ npm install
$ npm run bootstrap

运行开发人员模式,然后选择要开发的项目:

$ npm run dev

开启网页服务器:

$ npm start

捐助

我们通过这些渠道接受捐赠:

QQ 群

QQ Group

证书

MIT © Harvey Zack