mn-video-player-v2 1.4.9 → 1.5.0
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/package.json +3 -3
- package/readme.md +50 -5
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mn-video-player-v2",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.0",
|
|
4
4
|
"description": "MN Video Player for WebSocket streaming",
|
|
5
|
-
"main": "./dist/mn-video-player.umd.js",
|
|
6
|
-
"module": "./dist/mn-video-player.es.js",
|
|
5
|
+
"main": "./dist/mn-video-player-v2.umd.js",
|
|
6
|
+
"module": "./dist/mn-video-player-v2.es.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
8
8
|
"exports": {
|
|
9
9
|
".": {
|
package/readme.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
MnVideoPlayer 是一个基于 WebSocket 的视频播放器,支持实时播放、历史回放、对讲等功能。
|
|
6
6
|
|
|
7
|
-
在项目中使用时,需要排除 `mn-video-player` 模块的预加载,以避免与 Worker文件资源获取失败。
|
|
7
|
+
在项目中使用时,需要排除 `mn-video-player-v2` 模块的预加载,以避免与 Worker文件资源获取失败。
|
|
8
8
|
|
|
9
9
|
```javascript
|
|
10
10
|
// 示例:Vue 项目配置
|
|
11
11
|
module.exports = {
|
|
12
12
|
// ... 其他配置
|
|
13
13
|
optimizeDeps: {
|
|
14
|
-
exclude: ['mn-video-player']
|
|
14
|
+
exclude: ['mn-video-player-v2']
|
|
15
15
|
},
|
|
16
16
|
};
|
|
17
17
|
```
|
|
@@ -39,6 +39,7 @@ module.exports = {
|
|
|
39
39
|
| streamType | number | 否 | 码流类型 实时:(0=主码流,1=子码流) 回放:(1=主码流,2=子码流) |
|
|
40
40
|
| renderType | string | 否 | 渲染类型(wasm 或 decode) 使用wasm解码 回放时建议使用decode |
|
|
41
41
|
| showControlBar | boolean | 否 | 是否显示内置控制栏(默认 true) |
|
|
42
|
+
| debug | boolean | 否 | 是否显示调试信息悬浮层(时间戳、fps、延迟、网速等,每 1 秒刷新,默认 false) |
|
|
42
43
|
| enableDoubleClickFullscreen | boolean | 否 | 是否启用双击全屏(默认 true) |
|
|
43
44
|
| controlCallbackFn | (type: MnVideoPlayerControlType) => boolean | 否 | 控制回调函数,返回 false 则阻止默认行为 ,返回 true 则执行默认行为 MnVideoPlayerControlType 枚举值 : refresh 刷新 close 关闭 fullscreen 全屏/退出全屏 stream 切换码流 speedDec 降低倍速 speedInc 增加倍速 |
|
|
44
45
|
|
|
@@ -268,6 +269,50 @@ player.timeCallBack((time) => {
|
|
|
268
269
|
});
|
|
269
270
|
```
|
|
270
271
|
|
|
272
|
+
### netSpeedCallback 属性
|
|
273
|
+
|
|
274
|
+
设置网速回调函数,播放时周期性收到网速数据。与 `timeCallBack` 不同,该回调直接赋值给 player 实例。
|
|
275
|
+
|
|
276
|
+
**参数:**
|
|
277
|
+
|
|
278
|
+
| 参数 | 类型 | 说明 |
|
|
279
|
+
|------|------|------|
|
|
280
|
+
| kbPerSec | number | 网速(KB/s) |
|
|
281
|
+
| frame | object | 原始网速帧对象,含 `d`(本周期字节数)、`len`(缓存帧数)等 |
|
|
282
|
+
|
|
283
|
+
**示例:**
|
|
284
|
+
|
|
285
|
+
```javascript
|
|
286
|
+
player.netSpeedCallback = (kbPerSec, frame) => {
|
|
287
|
+
console.log('当前网速:', kbPerSec, 'KB/s');
|
|
288
|
+
console.log('缓存帧数:', frame.len);
|
|
289
|
+
};
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
## 调试功能
|
|
293
|
+
|
|
294
|
+
### debug 选项
|
|
295
|
+
|
|
296
|
+
初始化时设置 `debug: true`,会在视频左上角悬浮显示实时调试信息(每 1 秒刷新):
|
|
297
|
+
|
|
298
|
+
- **时间**:当前播放时间戳
|
|
299
|
+
- **fps**:实际出帧率
|
|
300
|
+
- **延迟**:帧输出相对应播时刻的平均/最大滞后(ms),流畅时接近 0
|
|
301
|
+
- **网速**:KB/s 及缓存帧数
|
|
302
|
+
- **帧数 / 缓存队列**:本秒输出帧数与播放队列排队帧数
|
|
303
|
+
- **模式**:wasm / VideoDecoder
|
|
304
|
+
|
|
305
|
+
**示例:**
|
|
306
|
+
|
|
307
|
+
```javascript
|
|
308
|
+
player.init({
|
|
309
|
+
// ...其他参数
|
|
310
|
+
debug: true
|
|
311
|
+
});
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
如需自行展示,也可通过 `player.timerCtrl.perfSnapshot()` 获取 fps/延迟统计(返回 `{ fps, avgLatency, maxLatency, frames, cache }`),取完后调用 `player.timerCtrl.perfReset()` 重置统计窗口。
|
|
315
|
+
|
|
271
316
|
|
|
272
317
|
|
|
273
318
|
## 完整示例
|
|
@@ -275,7 +320,7 @@ player.timeCallBack((time) => {
|
|
|
275
320
|
### 实时播放示例
|
|
276
321
|
|
|
277
322
|
```javascript
|
|
278
|
-
import MnVideoPlayer from 'mn-video-player'
|
|
323
|
+
import MnVideoPlayer from 'mn-video-player-v2'
|
|
279
324
|
|
|
280
325
|
const player = new MnVideoPlayer();
|
|
281
326
|
|
|
@@ -301,7 +346,7 @@ player.play({
|
|
|
301
346
|
### 历史回放示例
|
|
302
347
|
|
|
303
348
|
```javascript
|
|
304
|
-
import MnVideoPlayer from 'mn-video-player'
|
|
349
|
+
import MnVideoPlayer from 'mn-video-player-v2'
|
|
305
350
|
|
|
306
351
|
const player = new MnVideoPlayer();
|
|
307
352
|
|
|
@@ -329,7 +374,7 @@ player.play({
|
|
|
329
374
|
### 完整控制示例
|
|
330
375
|
|
|
331
376
|
```javascript
|
|
332
|
-
import MnVideoPlayer from 'mn-video-player'
|
|
377
|
+
import MnVideoPlayer from 'mn-video-player-v2'
|
|
333
378
|
|
|
334
379
|
const player = new MnVideoPlayer();
|
|
335
380
|
|