ezuikit-js 8.0.11-alpha.1 → 8.0.12-alpha.1

package/README.md

@@ -1,11 +1,5 @@
 #  [EZUIKit-JavaScript-npm][ezuikit-js]
 
-![Download](https://img.shields.io/npm/dm/ezuikit-js.svg)
-![Version](https://img.shields.io/npm/v/ezuikit-js.svg)
-![License](https://img.shields.io/npm/l/ezuikit-js.svg)
-![Build Demos](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/workflows/build-demos/badge.svg)
-
-
 > 轻应用npm版本，降低接入难度，适配自定义UI，适配主流框架
 
 > 低延时预览，云存储回放，SD卡回放
@@ -17,15 +11,7 @@
 ### 获取ezuikit-js
 
 ```
-npm install ezuikit-js
-
-# yarn
-
-yarn add ezuikit-js
-
-# pnpm
-
-pnpm add ezuikit-js
+$ npm install ezuikit-js
 ```
 ### 引入ezuikit-js
 
@@ -34,15 +20,12 @@ import EZUIKit from 'ezuikit-js';
 ```
 
 #### 如果你使用原生方法,可以通过标签引用
-
 ```
-  <!-- umd -->
   <script src="./ezuikit.js"></script>
 ```
 
 ### 开始使用 - 初始化
-
-> 基本使用
+>基本使用
 
 创建DOM
 
@@ -51,62 +34,51 @@ import EZUIKit from 'ezuikit-js';
 ```
 
 ## 播放器初始化
-
 ### 直播
-
-```js
+```
     var player = new EZUIKit.EZUIKitPlayer({
       id: 'video-container', // 视频容器ID
       accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
-      url: 'ezopen://open.ys7.com/G39444019/1.live',
+      url: 'ezopen://open.ys7.com/AA2615287/1.live',
       width: 600,
       height: 400,
-      handleError: (err) => {
-        if (err.type === "handleRunTimeInfoError" && err.data.nErrorCode === 5) {
-          // 加密设备密码错误
-        }
-      },
     })
 ```
-
 ### 回放
-
-```js
+```
     var player = new EZUIKit.EZUIKitPlayer({
       id: 'video-container', // 视频容器ID
       width: 600,
       height: 400,
       accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
-      url: 'ezopen://open.ys7.com/G39444019/1.rec'
+      url: 'ezopen://open.ys7.com/AA2615287/1.rec'
     })
 ```
 #### tips
-
 为方便开发者快速接入  
 
 我们提供了测试accessToken,测试播放地址，并提供了几种常用场景使用示例。你可以通过使用示例，使用测试播放地址，测试accessToken，在你的应用快速接入。  
 
-<b>测试播放地址：</b> ezopen://open.ys7.com/G39444019/1.live  
+<b>测试播放地址：</b> ezopen://open.ys7.com/AA2615287/1.live  
 
-你可以通过以下地址获取到测试accessToken <a href="https://open.ys7.com/jssdk/ezopen/demo/token" target="_blank">获取测试accessToken</a> 用来播放上述测试播放地址。
-当前设备有可能下线或被移除了， 如果自己有设备优先使用自己的设备进行测试。
+你可以通过以下地址获取到测试accessToken <a href="https://open.ys7.com/jssdk/ezopen/demo/token" target="_blank">获取测试accessToken</a> 用来播放上述测试播放地址。 
 
 #### 最佳实践tips
 
 1. 我们在v0.6.2及以上版本持用户通过开启谷歌实验室特性启动多线程解码，多线程模式将大大提升解码效率，降低解码内存消耗。  
 
-> [开启多线程方式1](https://open.ys7.com/help/384)(https://open.ys7.com/help/384)
+>>[开启多线程方式1](https://open.ys7.com/help/384)  (https://open.ys7.com/help/384)
 
-> [开启多线程方式2](https://open.ys7.com/help/385)(https://open.ys7.com/help/385)  
+>>[开启多线程方式2](https://open.ys7.com/help/385)(https://open.ys7.com/help/385)  
 
 2. 视频解码库默认从开放平台远程拉取，你可以将解码库放到本地或者你的服务内，可以提升加载解码库速度。 
 
- > <b>使用本地解码库提升加载速度</b>  开发者需要自己设置静态资源文件地址， 参考 `staticPath`的配置
+ >> <b>使用本地解码库提升加载速度</b>  <a href="https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/blob/master/demos/base-demo/localDecoder.html" target="_blank">本地解码库示例</a> 
 
 ### 使用示例
 > 1. 快速创建视频播放页面  
 
-&emsp;&emsp;&emsp;&emsp;<b>基本使用：</b>  <a href="https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/blob/master/demos/base-demo/index.html" target="_blank">基本使用示例</a>  
+&emsp;&emsp;&emsp;&emsp;<b>基本使用：</b>  <a href="https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/blob/master/demos/base-demo/base.html" target="_blank">基本使用示例</a>  
 
 > 2. 前往[开放平台轻应用模板管理页](https://open.ys7.com/console/ezuikit/template.html)创建一个主题，可以动态配置你的播放主题，控件，示例展示了获取一个主题后使用示例。  
 
@@ -157,11 +129,10 @@ ezopen://open.ys7.com/${设备序列号}/{通道号}.rec?begin=yyyyMMddhhmmss
 ##### 云存储回放
 初始化参数 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>
+视频ezopen协议播放地址 详见：<a href="http://open.ys7.com/doc/zh/readme/ezopen.html" 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>
 <tr><td>height</td><td>int</td><td>视频高度，默认值为容器容器DOM高度</td><td>Y</td></tr>
-<tr><td>staticPath</td><td>string</td><td>设置静态资源地址, 自定义可以自行下载 `ezuikit_static`放置在自己的服务器下， 设置 {staticPath: "/ezuikit_static"} </td><td>N</td></tr>
 <tr><td>template</td><td>String</td><td>  
 
 
@@ -181,7 +152,7 @@ ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhm
 <tr><td>自定义themeId</td><td>自定义主题，<a href="https://open.ys7.com/console/ezuikit/template.html" target="_blank">前往开放平台控制台配置页面获取</a><br />（v0.6.2版本及以上支持，建议使用 自定义themeId，或者使用themeData本地<br />配置）;</td></tr>
 </table>
 
-</td><td>N</td></tr>
+</td></tr>
 <tr><td>themeData</td><td>Object</td><td>
 themeData将主题数据本地化，设置本地数据，需要删除template参数 <br /> 
 你可以通过themeData修改按钮位置，颜色，头部底部颜色等配置。  
@@ -311,20 +282,16 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 </td><td>N</td></tr>
 <tr><td>plugin</td><td>String</td><td>按需加载插件，可选值： talk：对讲，示例：plugin:["talk"] </td><td>N</td></tr>
 <tr><td>handleSuccess</td><td>function</td><td>自动播放成功回调</td><td>N</td></tr>
-<tr><td>handleError</td><td>function</td><td>错误回调</td><td>N</td></tr>
 <tr><td>seekFrequency </td><td>function</td><td>为避免频繁拖动播放异常，可设置模板回放时间轴拖动防抖间隔，默认值为2000（2秒），可取2000（2秒），3000（3秒），4000（4秒），5000（5秒）</td><td>N</td></tr>
-<tr><td>language</td><td>String</td><td>多语言 （zh | en）, 默认zh (v8.0.8版本及以上支持)</td><td>N</td></tr>
 </table>
 
 
 ### 方法调用
-
 > 同步方法（方式1）
 > 方法支持通过promise回调，可通过回调方式执行下一步动作（方式2）。
 
 #### 开始播放
-
-```js
+```
   // 方式1
   player.play();
   // 方式2
@@ -333,10 +300,9 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
     console.log("执行播放成功后其他动作");
   });
 ```
-
 #### 停止播放
 
-```js
+```
   // 方式1
   player.stop();
   // 方式2
@@ -345,10 +311,9 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
     console.log("执行停止成功后其他动作");
   });
 ```
-
 #### 开启声音
 
-```js
+```
   // 方式1
   player.openSound();
   // 方式2
@@ -357,19 +322,10 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
     console.log("执行开启声音成功后其他动作");
   });
 ```
-
-#### 关闭声音
-
-```js
-  // 方式1
-  player.closeSound();
-```
-
 #### 开始录制
 > 因录制解码库加载限制，录制库加载需要3S秒左右，请保证录制时长需要大于5秒。
 > 录制文件需要使用播放器，播放器下载地址 <a href="https://service.ys7.com/downloadInfoSite/admin">播放器下载</a>
-
-```js
+```
   // 方式1
   player.startSave("唯一文件名");
   // 方式2
@@ -380,7 +336,7 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 ```
 #### 停止录制并下载文件
 
-```js
+```
   // 方式1
   player.stopSave();
   // 方式2
@@ -389,10 +345,9 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
     console.log("执行停止录制成功后其他动作");
   });
 ```
-
 #### 抓图
 
-```js
+```
   // 方式1 - 下载到本地
   player.capturePicture("文件名");
   // 方式2 - 返回base64格式
@@ -403,74 +358,29 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 ```
 #### 开始对讲
 
-```js
+```
   player.startTalk();
 ```
 
 #### 结束对讲
 
-```js
-  player.stopTalk();
-```
-
-#### 对讲设置麦克风增益
-
-```
-  // 设置音频增益系数 0 ~ 10
-  player.setVolumeGain(volume);
-```
-
-#### 获取麦克风权限
-
-```
-  player.getMicrophonePermission().then(data => {
-    if (data.code === 0) {
-      // 成功....
-    }
-  })
-```
-
-#### 获取麦克风列表
-
-```
-  // 需要在麦克风已授权的情况下调用，才能获取到麦克风列表，可以和getMicrophonePermission配合使用，或在初始化后先调用getMicrophonePermission获取授权
-  player.getMicrophonesList().then(data => {
-    if (data.code === 0) {
-      // 成功....
-    }
-  })
-```
-
-#### 切换麦克风
-
-```
-  // microphoneId 为获取到的麦克风列表中的deviceId，如果当前处于对讲中，调用setProfile会先关闭，重新发起对讲
-  player.setProfile({ microphoneId })
-```
-
-#### 监听麦克风音量变化
 ```
-  player.eventEmitter.on('volumeChange', ({ data }) => {
-    // 动态显示音柱,100ms触发一次
-    console.log(`${data * 100}%`)
-  })
+  player.stopTalk();
 ```
 
 #### 全屏
 
-```js
+```
   player.fullScreen();
 ```
-
 #### 取消全屏
 
-```js
+```
   player.cancelFullScreen();
 ```
-
 #### 获取OSD时间
 
-```js
+```
    player.getOSDTime()
   .then((time)=>{
     console.log("获取到的当前播放时间", time);
@@ -481,7 +391,7 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 
 > 可用于在播放中切换设备，切换播放参数，以及直播切换回放等。请注意，频繁切换可能导致异常，切换间隔至少需要1秒
 
-```js
+```
   player.changePlayUrl(options)
   .then(()=>{
     console.log("切换成功")
@@ -504,11 +414,10 @@ options参数说明
 
   
 
-#### 切换模板主题 
-
+#### 切换模板主题  
 > 可用于在播放中切换模板主题，请切换播放地址成功后调用
 
-```js
+```
   player.Theme.changeTheme(template)
 
   // 预览切回放场景示例
@@ -520,7 +429,6 @@ options参数说明
   
 
 ```
-
 template参数说明
 
 |参数名|类型|描述|是否必选|
@@ -529,10 +437,9 @@ template参数说明
 
 
 #### 开启电子放大
-
 >建议使用模板，模板中的电子放大功能更全
 
-```js
+```
   // 方式1
   player.enableZoom();
   // 方式2
@@ -541,10 +448,9 @@ template参数说明
     console.log("开启电子放大成功");
   });
 ```
-
 #### 关闭电子放大
 
-```js
+```
   // 方式1
   player.closeZoom();
   // 方式2
@@ -556,40 +462,14 @@ template参数说明
 
 #### 重置画面宽高
 
-```js
-  player.reSize(width, height);
 ```
-
-#### 鱼眼矫正（软解 开启 [SharedArrayBuffer](https://open.ys7.com/help/1772?h=SharedArrayBuffer)）
-
-```js
-// {1, 0}  壁装鱼眼 不矫正
-// {1, 1}  壁装360°全景
-// {1, 2}  壁装4分屏
-// {1, 4}  壁装广角
-// {3, 0}  顶装鱼眼 不矫正
-// {3, 1}  顶装360°全景
-// {3, 4}  顶装4分屏
-// {3, 5}  顶装柱状
-// 顶装4分屏
-player.setFECCorrectType({place: 3 , type：4}, "cavnas1,canvas2,canvas3") // cavnas1,canvas2,canvas3 是分屏是需要的
+  player.reSize(width, height);
 ```
 
-
-
-### 非正式版说明
-
-非正式版需要配置  `staticPath`
-
 ### 使用示例
 
-> 如果使用原生js，可参考demos => [base-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/base-demo)
-
-> 如果使用react，可参考demos => [react-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/react-demo)
-
-> 如果使用react + vite，可参考demos => [with-react-vite](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-react-vite)
-
+> 如果使用原生js，可参考demos => base-demo
 
-> 如果使用vue2，可参考demos => [vue-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue-demo)
+> 如果使用react，可参考demos => react-demo
 
-> 如果使用vue3，可参考demos => [vue3-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue3-demo)
+> 如果使用vue，可参考demos => vue-demo