easy-player-pro 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +127 -0
- package/lib/build/EasyPlayer-decode.js +1 -0
- package/lib/build/EasyPlayer-lib.js +1 -0
- package/lib/build/EasyPlayer-pro.js +1 -0
- package/lib/build/EasyPlayer-pro.wasm +0 -0
- package/lib/build/EasyPlayer-snap.wasm +0 -0
- package/lib/core/config.js +117 -0
- package/lib/core/easy-player-pro.js +265 -0
- package/lib/core/easy-player.js +265 -0
- package/lib/index.js +2 -0
- package/lib/types/core/config.d.ts +118 -0
- package/lib/types/core/easy-player-pro.d.ts +177 -0
- package/lib/types/core/easy-player.d.ts +177 -0
- package/lib/types/index.d.ts +5 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# easy-player-pro
|
|
2
|
+
|
|
3
|
+
## 简介
|
|
4
|
+
基于EasyPlayer.js的二次封装，增加类型说明，支持在前端工程项目中安装使用。
|
|
5
|
+
|
|
6
|
+
EasyPlayer.js H5播放器，是一款能够同时支持HTTP、HTTP-FLV、HLS（m3u8）、WS、WEBRTC、FMP4视频直播与视频点播等多种协议，支持H.264、H.265、AAC、G711A、Mp3等多种音视频编码格式，支持MSE、WASM、WebCodec等多种解码方式，支持Windows、Linux、Android、iOS全平台终端的H5播放器，使用简单, 功能强大。
|
|
7
|
+
|
|
8
|
+
## 快速开始
|
|
9
|
+
|
|
10
|
+
**安装**
|
|
11
|
+
```bash
|
|
12
|
+
npm i easy-player-pro
|
|
13
|
+
# or
|
|
14
|
+
yarn add easy-player-pro
|
|
15
|
+
```
|
|
16
|
+
**使用**
|
|
17
|
+
```javascript
|
|
18
|
+
import EasyPlayer from "easy-player-pro";
|
|
19
|
+
// 初始化
|
|
20
|
+
const easyPalyer = new EasyPlayer("#palyer-box",{
|
|
21
|
+
isMute:true,
|
|
22
|
+
hasAuto:false
|
|
23
|
+
})
|
|
24
|
+
// 事件监听
|
|
25
|
+
easyPalyer.onPlay=()=>{
|
|
26
|
+
console.log('play event');
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
**vite配置**
|
|
30
|
+
```javascript
|
|
31
|
+
import easyPlayer from 'vite-plugin-easy-player'
|
|
32
|
+
export default defineConfig({
|
|
33
|
+
plugins:[
|
|
34
|
+
easyPlayer()
|
|
35
|
+
]
|
|
36
|
+
})
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 配置属性 config
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
43
|
+
| ------------------ | ------------------------------------------------ | -------------------------- |------------------------------------------------------------------------|
|
|
44
|
+
| isLive | 是否直播 | Boolean | true |
|
|
45
|
+
| hasAudio | 是否解析音频 | Boolean | true |
|
|
46
|
+
| isMute | 是否渲染音频 | Boolean | false |
|
|
47
|
+
| stretch | 视频拉伸 | Boolean | false |
|
|
48
|
+
| poster | 视频封面图片 | String | - |
|
|
49
|
+
| bufferTime | 加载显设置最小缓冲时长，单位秒，播放器会自动消除延迟。 | Number | 1 |
|
|
50
|
+
| loadTimeOut | 视频加载超时,单位秒。 | Number | 10 |
|
|
51
|
+
| loadTimeReplay | 重连次数 -1为一直加载。 | Number | 3 |
|
|
52
|
+
| MSE | MSE模式 | Boolean | fasle |
|
|
53
|
+
| WCS | WCS模式 | Boolean | fasle |
|
|
54
|
+
| WASM | WASM模式 | Boolean | fasle |
|
|
55
|
+
| WASMSIMD |WASMSIMD模式 | Boolean | false |
|
|
56
|
+
| gpuDecoder |硬解码 | Boolean | false |
|
|
57
|
+
| webGPU |渲染方式 | Boolean | false |
|
|
58
|
+
| canvasRender |渲染容器 | Boolean | false |
|
|
59
|
+
| isRtcSRS |SRS类型 | Boolean | false |
|
|
60
|
+
| isRtcZLM |ZLM类型 | Boolean | false |
|
|
61
|
+
| isFlow | 裸流 | Boolean | false |
|
|
62
|
+
| watermark | 水印 | Object | {text: {content:'',color:'',opacity:,fontSize:''},right: 0,top: 0} |
|
|
63
|
+
| fullWatermark | 全屏水印 | Object | {text: '',angle:'',color:'',fontSize: '',opacity:''} |
|
|
64
|
+
| quality | 配置清晰 | Array | ['普清', '高清', '超清', '4K', '8K'] |
|
|
65
|
+
| defaultQuality | 默认显示的清晰度，如果不设置，会显示第一个清晰度 | String | - |
|
|
66
|
+
| ptzConfig | PTZ配置 | Object | {ptz: true, ptzMore: true} |
|
|
67
|
+
| debug | 控制台日志打印 | Boolean | false |
|
|
68
|
+
注:
|
|
69
|
+
|
|
70
|
+
1.解码模式 MSE > WCS > wasm(simd适合高分辨率)
|
|
71
|
+
|
|
72
|
+
## 事件回调
|
|
73
|
+
|
|
74
|
+
| 事件名 | 说明 |
|
|
75
|
+
|------------------| ------------ |
|
|
76
|
+
| onPlay | 播放事件 |
|
|
77
|
+
| onPause | 暂时事件 |
|
|
78
|
+
| videoInfo | 视频信息 |
|
|
79
|
+
| onVideoInfo | 音频信息 |
|
|
80
|
+
| onFullscreen | 全屏 |
|
|
81
|
+
| onMute | 音频 |
|
|
82
|
+
| onKBps | 当前网速， 单位KB 每秒1次, |
|
|
83
|
+
| onStretch | 切换拉伸 |
|
|
84
|
+
| onPTZ | PTZ事件 |
|
|
85
|
+
| onScreenshots | 截图回调 |
|
|
86
|
+
| onContextmenuClose | 右击关闭回调 |
|
|
87
|
+
| onDecodeHevc | 视频编码回调 |
|
|
88
|
+
| onLiveEnd | 直播结束的事件 |
|
|
89
|
+
| onTimeout | 加载超时 |
|
|
90
|
+
| onRecordEnd | 录制结束的事件 |
|
|
91
|
+
| onRecordStart | 录制开始的事件 |
|
|
92
|
+
| onQualityChange | 清晰度回调 |
|
|
93
|
+
| onPlaybackSeek | 录像时间轴跳转回调 |
|
|
94
|
+
| onPlaybackRate | 录像倍数的回调 |
|
|
95
|
+
| onTimestamps | 播放时间回调 |
|
|
96
|
+
| onError | 播放异常 |
|
|
97
|
+
|
|
98
|
+
## 方法
|
|
99
|
+
|
|
100
|
+
| 方法名 | 说明 | 参数 |
|
|
101
|
+
| ---------- | ------------ | ---------------------|
|
|
102
|
+
| play | 播放 | 'url' |
|
|
103
|
+
| pause | 暂停播放 | |
|
|
104
|
+
| isPause | 返回是否暂停中状态 | |
|
|
105
|
+
| setMute | 音频 | true|false |
|
|
106
|
+
| isMute | 返回是否静音 | |
|
|
107
|
+
| screenshot | 获取快照 |('test', 'png \| jpeg', '0-1(压缩率)','download \| base64 \| blob')|
|
|
108
|
+
| setFullscreen | 全屏(取消全屏)播放视频 | |
|
|
109
|
+
| exitFullscreen | 退出全屏 | |
|
|
110
|
+
| setQuality | 设置分辨率必须是quality里面的数据 | |
|
|
111
|
+
| setRate | 设置录像倍数 | |
|
|
112
|
+
| seekTime | 设置录像跳转时间/s | |
|
|
113
|
+
| getVideoInfo | 获取视频信息 | |
|
|
114
|
+
| getAudioInfo | 获取音频信息 | |
|
|
115
|
+
| setMic | 设置语音对讲状态(PTZ需开启) | true|
|
|
116
|
+
| destroy | 关闭视频，释放底层资源 | |
|
|
117
|
+
|
|
118
|
+
screenshot 截图，调用后弹出下载框保存截图
|
|
119
|
+
|
|
120
|
+
filename: 可选参数, 保存的文件名, 默认 时间戳
|
|
121
|
+
format : 可选参数, 截图的格式，可选png或jpeg或者webp ,默认 png
|
|
122
|
+
quality: 可选参数, 当格式是jpeg或者webp时，压缩质量，取值0 ~ 1 ,默认 0.92
|
|
123
|
+
type: 可选参数, 可选download或者base64或者blob，默认download
|
|
124
|
+
案例:
|
|
125
|
+
```js
|
|
126
|
+
const base64 = easyPalyer.screenshot("test", "png", 0.5, 'base64')
|
|
127
|
+
```
|