ezuikit-js 8.1.9 → 8.1.10-beta.10

package/CHANGELOG.md

@@ -1,3 +1,67 @@
+### v8.1.10 (2025-04-27)
+
+#### Feat
+
+- 优化取流逻辑，
+  
+- 弃用 `host`, `host` 默认从播放地址中获取
+
+- 新增初始化 `videoLevelList` 参数进行自定义清晰度列表
+
+#### Fixed
+
+- 修复 `autoplay` 为 false 时， 不能播放问题
+
+- 修复多窗口下对讲回调只会触发最后初始化的播放器
+
+### v8.1.9 (2025-04-16)
+
+#### Feat
+
+- 新增日志打印配置项 `loggerOptions` 和 `setLoggerOptions` api, 具体请参考[参数说明](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm?tab=readme-ov-file#%E9%99%84%E5%BD%95-%E5%88%9D%E5%A7%8B%E5%8C%96%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E), [issues #202](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/202), [issues #176](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/176), [issues #205](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/205), [issues #81](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/81)
+
+- 新增一些事件， 如 `videoInfo` 、`audioInfo` 和 `firstFrameDisplay`等， 具体请参考[事件](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm?tab=readme-ov-file#%E4%BA%8B%E4%BB%B6)
+
+#### Fixed
+
+- 修复调用录制api, ui 没有同步问题
+- 修复调用对讲api, ui 没有同步问题
+- 修复了一些小bug [issues #178](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/178), [issues #199](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/199), [issues #206](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/issues/206),
+
+## v8.1.8（2025-03-19）
+
+#### Feat
+
+- 支持巡检模板
+
+- 兼容音频采样率异常设备录制
+
+#### Fixed
+
+- 修复部分AR设备获取标签信息报错
+
+## v8.1.7（2025-03-05）
+
+#### Feat
+
+- 电子放大模块重构，操作更丝滑~
+
+- 移动端支持双指操作电子放大功能
+
+## v8.1.6（2025-02-10）
+
+#### Feat
+
+- 初始化支持配置关闭结束录制的默认下载行为【downloadRecord: false】
+
+- 支持初始化设置【stopSaveCallBack】回调事件，在结束录制后通过该回调获取下载地址及文件数据
+
+#### Fixed
+
+- 修复了token为空时本地缓存地址依然可以播放的问题
+
+- 修复了一些小bug
+
 ## v8.1.5（2025-01-15）
 
 #### Feat

package/README.md

@@ -30,7 +30,21 @@ pnpm add ezuikit-js
 ### 引入 ezuikit-js
 
 ```js
-import EZUIKit from 'ezuikit-js';
+// >= v8.1.2  ESM
+import { EZUIKitPlayer } from "ezuikit-js";
+
+// < v8.1.2
+import EZUIKit from "ezuikit-js";
+```
+
+#### 不支持 ESM (not support ESM)
+
+```js
+// >= v8.1.2  CommonJS
+import { EZUIKitPlayer } from "ezuikit-js/index.js";
+
+// < v8.1.2 CommonJS
+import EZUIKit from "ezuikit-js/index.js";
 ```
 
 #### 如果你使用原生方法,可以通过标签引用
@@ -55,14 +69,16 @@ import EZUIKit from 'ezuikit-js';
 ### 直播
 
 ```js
-const player = new EZUIKit.EZUIKitPlayer({
-  id: 'video-container', // 视频容器ID
-  accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
-  url: 'ezopen://open.ys7.com/BD3957004/1.live',
+import { EZUIKitPlayer } from "ezuikit-js";
+const player = new EZUIKitPlayer({
+  id: "video-container", // 视频容器ID
+  accessToken:
+    "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
+  url: "ezopen://open.ys7.com/BD3957004/1.live",
   width: 600,
   height: 400,
   handleError: (err) => {
-    if (err.type === 'handleRunTimeInfoError' && err.data.nErrorCode === 5) {
+    if (err.type === "handleRunTimeInfoError" && err.data.nErrorCode === 5) {
       // 加密设备密码错误
     }
   },
@@ -72,12 +88,14 @@ const player = new EZUIKit.EZUIKitPlayer({
 ### 回放
 
 ```js
-const player = new EZUIKit.EZUIKitPlayer({
-  id: 'video-container', // 视频容器ID
+import { EZUIKitPlayer } from "ezuikit-js";
+const player = new EZUIKitPlayer({
+  id: "video-container", // 视频容器ID
   width: 600,
   height: 400,
-  accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
-  url: 'ezopen://open.ys7.com/BD3957004/1.rec',
+  accessToken:
+    "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
+  url: "ezopen://open.ys7.com/BD3957004/1.rec",
 });
 ```
 
@@ -95,10 +113,16 @@ alpha（功能测试）、beta（集成测试）为我们的非正式版本，
 
 > 如果使用 react + vite，可参考 demos => [with-react-vite](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-react-vite)
 
-> 如果使用 vue2，可参考 demos => [vue-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue-demo)
+> 如果使用 next.js，可参考 demos => [with-next](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-next)
+
+> 如果使用 electron，可参考 demos => [with-electron](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-electron)
 
 > 如果使用 vue3，可参考 demos => [vue3-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue3-demo)
 
+> 如果使用 vue2.7，可参考 demos => [vue-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue-demo)
+
+> 如果使用 vue2.6，可参考 demos => [with-vue2.6](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-vue2.6)
+
 #### tips
 
 为方便开发者快速接入
@@ -114,15 +138,16 @@ alpha（功能测试）、beta（集成测试）为我们的非正式版本，
 > 轻应用支持向接入萤石云海外环境的设备发起取流播放，需要在初始化时配置海外服务域名，示例：
 
 ```js
-const player = new EZUIKit.EZUIKitPlayer({
-  id: 'playWind',
+import { EZUIKitPlayer } from "ezuikit-js";
+const player = new EZUIKitPlayer({
+  id: "playWind",
   width: 600,
   height: 400,
-  template: 'pcLive',
-  url: '',
-  accessToken: '',
+  template: "pcLive",
+  url: "",
+  accessToken: "",
   env: {
-    domain: 'https://iusopen.ezvizlife.com', // 北美地区
+    domain: "https://iusopen.ezvizlife.com", // 北美地区
   },
 });
 ```
@@ -203,7 +228,7 @@ ezopen://open.ys7.com/${设备序列号}/{通道号}.hd.live<br/>
 
 ##### 云存储回放
 
-初始化参数 url 值为：<br/> ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhmmss视频 ezopen 协议播放地址 详见：<a href="https://open.ys7.com/help/23" target="_blank">ezopen 协议</a> </td><td>Y</td></tr>
+初始化参数 url 值为：<br/> ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhmmss 视频 ezopen 协议播放地址 详见：<a href="https://open.ys7.com/help/23" target="_blank">ezopen 协议</a> </td><td>Y</td></tr>
 
 <tr><td>audio</td><td>boolean</td><td>是否默认开启声音 true：打开（默认） false：关闭    </td><td>N</td></tr>
 <tr><td>width</td><td>int</td><td>视频宽度，默认值为容器容器DOM宽度    </td><td>Y</td></tr>
@@ -365,6 +390,8 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 <tr><td>quality</td><td>0 | 1 | 2 | 3 | 4 | 5 | 6 | pp | qp</td><td>预览初始化支持指定清晰度进行播放, 默认 undefined (v8.1.5版本及以上支持)， 0: 流畅； 1: 标清; 2: 高清; 3: 超清; 4: 极清; 5: 3K; 6: 4K ; "pp"： "性能优先 (Performance Priority)"; "qp": "画质优先(Quality Priority)"。</td><td>N</td></tr>
 <tr><td>loggerOptions</td><td> {name: string, level: "INFO" | "LOG" | "WARN" | "ERROR" , showTime: boolean}</td><td>本地日志设置， 默认值 {name: "ezuikit", level: "INFO", showTime: true}, 支持动态设置请参考 <a href="#日志设置">setLoggerOptions(options)</a> (v8.1.9版本及以上支持)</td><td>N</td></tr>
 <tr><td>streamInfoCBType</td><td>  0 | 1 </td><td>  流信息回调类型，监听 streamInfoCB 事件, 0 : 每次都回调（会影响性能）, 1 : 只回调一次, 默认值 1 (v8.1.9版本及以上支持)</td><td>N</td></tr>
+
+<tr><td>videoLevelList</td><td> <span>Array<{ </br>/** 清晰度 */</br>level: number, </br>/** 名称 */ </br>name: string, </br> /**1: 主码流,2: 子码流*/</br>streamTypeIn: 1 | 2 }> <span>| null </td><td>  自定义清晰度列表，默认null, 如果有值 sdk 内部不在进行获取, 为 null 使用接口获取的清晰度列表, videoLevelList.length === 0 不展示清晰度控件 sdk 内部不在进行获取, videoLevelList.length > 0 展示控件 sdk 内部不在进行获取 (v8.1.10版本及以上支持)</td><td>N</td></tr>
 </table>
 
 ### 方法调用
@@ -378,7 +405,7 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 player.play();
 // 方式2
 player.play().then(() => {
-  console.log('执行播放成功后其他动作');
+  console.log("执行播放成功后其他动作");
 });
 ```
 
@@ -389,7 +416,7 @@ player.play().then(() => {
 player.stop();
 // 方式2
 player.stop().then(() => {
-  console.log('执行停止成功后其他动作');
+  console.log("执行停止成功后其他动作");
 });
 ```
 
@@ -400,7 +427,7 @@ player.stop().then(() => {
 player.openSound();
 // 方式2
 player.openSound().then(() => {
-  console.log('执行开启声音成功后其他动作');
+  console.log("执行开启声音成功后其他动作");
 });
 ```
 
@@ -417,10 +444,10 @@ player.closeSound();
 
 ```js
 // 方式1
-player.startSave('唯一文件名');
+player.startSave("唯一文件名");
 // 方式2
-player.startSave('唯一文件名').then(() => {
-  console.log('执行开始录制成功后其他动作');
+player.startSave("唯一文件名").then(() => {
+  console.log("执行开始录制成功后其他动作");
 });
 ```
 
@@ -431,7 +458,7 @@ player.startSave('唯一文件名').then(() => {
 player.stopSave();
 // 方式2
 player.stopSave().then(() => {
-  console.log('执行停止录制成功后其他动作');
+  console.log("执行停止录制成功后其他动作");
 });
 ```
 
@@ -439,12 +466,12 @@ player.stopSave().then(() => {
 
 ```js
 // 方式1 - 下载到本地
-player.capturePicture('文件名');
+player.capturePicture("文件名");
 // 方式2 - 返回base64格式
 const capCallback = (data) => {
-  console.log('data', data);
+  console.log("data", data);
 };
-player.capturePicture('default', capCallback);
+player.capturePicture("default", capCallback);
 ```
 
 #### 开始对讲
@@ -497,7 +524,7 @@ player.setProfile({ microphoneId });
 #### 监听麦克风音量变化
 
 ```js
-player.eventEmitter.on('volumeChange', ({ data }) => {
+player.eventEmitter.on("volumeChange", ({ data }) => {
   // 动态显示音柱,100ms触发一次
   console.log(`${data * 100}%`);
 });
@@ -519,7 +546,7 @@ player.cancelFullScreen();
 
 ```js
 player.getOSDTime().then((time) => {
-  console.log('获取到的当前播放时间', time);
+  console.log("获取到的当前播放时间", time);
 });
 ```
 
@@ -529,7 +556,7 @@ player.getOSDTime().then((time) => {
 
 ```js
 player.changePlayUrl(options).then(() => {
-  console.log('切换成功');
+  console.log("切换成功");
 });
 ```
 
@@ -554,9 +581,9 @@ options 参数说明
 player.Theme.changeTheme(template);
 
 // 预览切回放场景示例
-player.changePlayUrl({ type: 'rec' }).then(() => {
-  console.log('地址切换成功，开始切换模板主题');
-  player.Theme.changeTheme('pcRec');
+player.changePlayUrl({ type: "rec" }).then(() => {
+  console.log("地址切换成功，开始切换模板主题");
+  player.Theme.changeTheme("pcRec");
 });
 ```
 
@@ -575,7 +602,7 @@ template 参数说明
 player.enableZoom();
 // 方式2
 player.enableZoom().then(() => {
-  console.log('开启电子放大成功');
+  console.log("开启电子放大成功");
 });
 ```
 
@@ -586,7 +613,7 @@ player.enableZoom().then(() => {
 player.closeZoom();
 // 方式2
 player.closeZoom().then(() => {
-  console.log('关闭电子放大成功');
+  console.log("关闭电子放大成功");
 });
 ```
 
@@ -632,7 +659,7 @@ options 参数说明
 
 ## 事件
 
-所有事件名 `EZUIKitPlayer.EVENTS`, 事件监听player.eventEmitter.on() 和事件取消 player.eventEmitter.off()
+所有事件名 `EZUIKitPlayer.EVENTS`, 事件监听 player.eventEmitter.on() 和事件取消 player.eventEmitter.off()
 
 #### 流信息事件
 
@@ -642,7 +669,7 @@ options 参数说明
 // 监听流信息事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.streamInfoCB, (info) => {
   // 包括 视频信息 音频信息
-  console.log('streamInfoCB', info);
+  console.log("streamInfoCB", info);
 });
 ```
 
@@ -661,7 +688,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.streamInfoCB, (info) => {
 // 监听音频信息变化
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.audioInfo, (info) => {
   // {"audioFormat":8193,"audioFormatName":"AAC","audioChannels":1,"audioBitsPerSample":16,"audioSamplesRate":16000,"audioBitRate":32000}
-  console.log('audioInfo', info);
+  console.log("audioInfo", info);
 });
 ```
 
@@ -682,7 +709,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.audioInfo, (info) => {
 // 监听视频信息变化
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.videoInfo, (info) => {
   // {"videoFormat":5,"videoFormatName":"H265","width":3840,"height":2160,"frameRate":15,"intervalOfIFrame":0}
-  console.log('videoInfo', info);
+  console.log("videoInfo", info);
 });
 ```
 
@@ -701,7 +728,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.videoInfo, (info) => {
 // 监听截图事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.capturePicture, (info) => {
   // {data: CapturePictureInfoDate}
-  console.log('capturePictureInfo', info);
+  console.log("capturePictureInfo", info);
 });
 ```
 
@@ -718,7 +745,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.capturePicture, (info) => {
 // 监听截图事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.capturePicture, (info) => {
   // {data: CapturePictureInfoData}
-  console.log('capturePictureInfo', info);
+  console.log("capturePictureInfo", info);
 });
 ```
 
@@ -735,7 +762,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.capturePicture, (info) => {
 // 监听截图事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.changeVideoLevel, (info) => {
   // {data: VideoLevelData}
-  console.log('changeVideoLevel', info);
+  console.log("changeVideoLevel", info);
 });
 ```
 
@@ -785,7 +812,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.destroy, () => {
 });
 ```
 
-### 全屏相关事件
+#### 全屏相关事件
 
 全屏事件 `EZUIKitPlayer.EVENTS.fullscreen`
 
@@ -815,7 +842,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.exitFullscreen, () => {
 // 监听全屏变化事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.fullscreenChange, (data) => {
   // {data: FullscreenChangeData}
-  console.log('fullscreenChange', data);
+  console.log("fullscreenChange", data);
 });
 ```
 
@@ -841,15 +868,15 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.init, () => {
 });
 ```
 
-#### resize事件
+#### resize 事件
 
-resize事件事件 `EZUIKitPlayer.EVENTS.resize`
+resize 事件事件 `EZUIKitPlayer.EVENTS.resize`
 
 ```js
 // 监听resize事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.resize, () => {
   // {data: {"width": number,"height":number}}
-  console.log('resize', data);
+  console.log("resize", data);
 });
 ```
 
@@ -886,9 +913,9 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.resume, () => {
 });
 ```
 
-#### seek事件
+#### seek 事件
 
-seek事件 `EZUIKitPlayer.EVENTS.seek`， 仅支持回放
+seek 事件 `EZUIKitPlayer.EVENTS.seek`， 仅支持回放
 
 ```js
 // 监听seek事件
@@ -960,7 +987,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.recTimeChange, () => {
 // 监听获取云存储回片段事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getCloudRecTimes, (list) => {
   // {data: {"width": number,"height":number}}
-  console.log('list', list);
+  console.log("list", list);
 });
 ```
 
@@ -968,10 +995,13 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getCloudRecTimes, (list) => {
 
 ```js
 // 监听获取云录制回片段事件
-player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getCloudRecordTimes, (list) => {
-  // {data: {"width": number,"height":number}}
-  console.log('list', list);
-});
+player.eventEmitter.on(
+  EZUIKitPlayer.EVENTS.http.getCloudRecordTimes,
+  (list) => {
+    // {data: {"width": number,"height":number}}
+    console.log("list", list);
+  }
+);
 ```
 
 获取本地录制回片段事件 `EZUIKitPlayer.EVENTS.http.getLocalRecTimes`
@@ -980,7 +1010,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getCloudRecordTimes, (list) =>
 // 监听获取本地录制回片段事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getLocalRecTimes, (list) => {
   // {data: {"width": number,"height":number}}
-  console.log('list', list);
+  console.log("list", list);
 });
 ```
 
@@ -990,7 +1020,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getLocalRecTimes, (list) => {
 // 监听获取设备信息事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getDeviceInfo, (info) => {
   // {"deviceSerial":"BC7799091","deviceName":"前端设备勿动 C6Wi(BC7799091)","localName":"C6Wi(BC7799091)","model":"CS-C6Wi-8D8W2DF","status":1,"defence":0,"isEncrypt":0,"alarmSoundMode":2,"offlineNotify":0,"category":"C6Wi","parentCategory":"IPC","updateTime":1741763026000,"netType":"wireless","signal":"0%","riskLevel":0,"netAddress":"125.121.197.61"}
-  console.log('info', info);
+  console.log("info", info);
 });
 ```
 
@@ -1000,7 +1030,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getDeviceInfo, (info) => {
 // 监听获取设备信息事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.http.getDeviceList, (info) => {
   // {"deviceSerial":"BC7799091","deviceName":"前端设备勿动 C6Wi(BC7799091)","localName":"C6Wi(BC7799091)","model":"CS-C6Wi-8D8W2DF","status":1,"defence":0,"isEncrypt":0,"alarmSoundMode":2,"offlineNotify":0,"category":"C6Wi","parentCategory":"IPC","updateTime":1741763026000,"netType":"wireless","signal":"0%","riskLevel":0,"netAddress":"125.121.197.61"}
-  console.log('info', info);
+  console.log("info", info);
 });
 ```
 
@@ -1086,7 +1116,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.talkSuccess, () => {
 // 监听对讲开启失败事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.talkError, (error) => {
   // ...
-  console.error('talkError', error);
+  console.error("talkError", error);
 });
 ```
 
@@ -1137,7 +1167,7 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.zoom.closeZoom, () => {
 // 监听电子放大变化事件
 player.eventEmitter.on(EZUIKitPlayer.EVENTS.zoom.onZoomChange, (info) => {
   // {"zoom": string,"reset"?:boolean}
-  console.log('onZoomChange', info);
+  console.log("onZoomChange", info);
 });
 ```
 
@@ -1194,10 +1224,13 @@ player.eventEmitter.on(EZUIKitPlayer.EVENTS.ptz.ptzDirection, () => {
 
 ```js
 // 监听点击云台控制控件方向事件
-player.eventEmitter.on(EZUIKitPlayer.EVENTS.timeLine.timeWidthChange, (widthType) => {
-  // ...
-  console.log('timeWidthChange', widthType); // 0 | 1 | 2 | 3
-});
+player.eventEmitter.on(
+  EZUIKitPlayer.EVENTS.timeLine.timeWidthChange,
+  (widthType) => {
+    // ...
+    console.log("timeWidthChange", widthType); // 0 | 1 | 2 | 3
+  }
+);
 ```
 
 #### 日期选择器相关事件