easy-player
Version:
rtmp, hls, flv and websocket player
116 lines (81 loc) • 4.15 kB
Markdown
# easy-player
> 集 rtmp, hls, flv, websocket 于一身的`网页直播/点播`播放器, 使用简单, 功能强大
## 属性(Property)
- `video-url` 视频流地址 String default ''
- `video-title` 视频右上角显示的标题 String default ''
- `poster` 视频封面图片 String default ''
- `autoplay` 自动播放 Boolean default true
- `loop` 是否循环播放 Boolean default false
- `live` 是否直播, 标识要不要显示进度条 Boolean default false
- `alt` 视频流地址没有指定情况下, 视频所在区域显示的文字, 相当于 html img 标签的 alt 属性 String default '无信号'
- `muted` 是否静音 Boolean default false
- `aspect` 视频显示区域的宽高比 String default '16:9'
- `loading` 指示加载状态, 支持 sync 修饰符
- `fluent` 流畅模式, Boolean default true
- `stretch` 是否拉伸, Boolean default false
- `timeout` m3u8 加载超时(秒) Number default 20
- `show-custom-button` 是否在工具栏显示自定义按钮(极速/流畅, 拉伸/标准), Boolean default true
## 方法(Medthod)
- `getCurrentTime` 获取当前播放时间进度, 同步返回播放时间进度数据
- `snap` 外部 API 方式获取快照, 快照获取成功后, 触发 snapOutside Event
## 事件(Event)
- `message` 触发通知消息, 参数: { type: '', message: ''}
- `ended` 播放结束, 参数: 无
- `timeupdate` 进度更新, 参数: 当前时间进度
- `pause` 暂停, 参数: 当前时间进度
- `play` 播放, 参数: 当前时间进度,
- `snapOutside` 外部快照回调, 参数: 快照 Base64 数据
- `snapInside` 内部快照回调, 由控制栏快照按钮触发, 参数: 快照 Base64 数据
## 安装(Install)
- 安装
`npm install easy-player`
- 在 Vue 中使用
copy node_modules/easy-player/dist/component/easy-player.swf 到 www 根目录
copy node_modules/easy-player/dist/component/crossdomain.xml 到 www 根目录
copy node_modules/easy-player/dist/component/easy-player-lib.min.js 到 www 根目录
以上 copy 操作通过 webpack 完成, 编辑你的 webpack.config.js
```js
......
// copy js lib and swf files to dist dir
new CopyWebpackPlugin([
{ from: 'node_modules/easy-player/dist/component/crossdomain.xml'},
{ from: 'node_modules/easy-player/dist/component/easy-player.swf'},
{ from: 'node_modules/easy-player/dist/component/easy-player-lib.min.js', to: 'js/'}
]),
......
```
在 html 中引用 www 根目录 easy-player-lib.min.js
编辑你的 Vue 组件
```vue
......
import EasyPlayer from 'easy-player'
......
components: {
EasyPlayer
}
......
<EasyPlayer :videoUrl="videoUrl" fluent autoplay live stretch></EasyPlayer>
```
- 脱离 Vue 使用
copy node_modules/easy-player/dist/element/easy-player.swf 到 www 根目录
copy node_modules/easy-player/dist/element/crossdomain.xml 到 www 根目录
copy node_modules/easy-player/dist/element/easy-player-element.min.js 到 www 根目录
在 html 中引用 www 根目录 easy-player-element.min.js
HTML 集成 Demo
```html
<!DOCTYPE HTML>
<html>
<head>
<title>easy-player</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no" name="viewport">
<body>
<easy-player video-url="rtmp://live.hkstv.hk.lxdns.com/live/hks" live="true" stretch="true"></easy-player>
<easy-player video-url="http://live.hkstv.hk.lxdns.com/live/hks/playlist.m3u8" live="false" stretch="true"></easy-player>
<easy-player video-url="http://live.hkstv.hk.lxdns.com/flv/hks.flv" live="true" stretch="true"></easy-player>
<easy-player video-url="ws://192.168.1.65:3000/play?stream=rtsp://username:password@192.168.1.64:5504/Streaming/Channels/102"></easy-player>
<script type="text/javascript" src="easy-player-element.min.js"></script></body>
</html>
```