ezuikit-js 8.1.1 → 8.1.2-beta.1

package/README.md

@@ -17,7 +17,8 @@
 
 ### 获取 ezuikit-js
 
-```
+```bash
+# npm
 npm install ezuikit-js
 
 # yarn
@@ -31,13 +32,13 @@ pnpm add ezuikit-js
 
 ### 引入 ezuikit-js
 
-```
+```js
 import EZUIKit from 'ezuikit-js';
 ```
 
 #### 如果你使用原生方法,可以通过标签引用
 
-```
+```html
   <!-- umd -->
   <script src="./ezuikit.js"></script>
 ```
@@ -48,7 +49,7 @@ import EZUIKit from 'ezuikit-js';
 
 创建 DOM
 
-```
+```html
   <div id="video-container"></div>
 ```
 
@@ -57,7 +58,7 @@ import EZUIKit from 'ezuikit-js';
 ### 直播
 
 ```js
-var player = new EZUIKit.EZUIKitPlayer({
+const player = new EZUIKit.EZUIKitPlayer({
   id: "video-container", // 视频容器ID
   accessToken:
     "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
@@ -75,7 +76,7 @@ var player = new EZUIKit.EZUIKitPlayer({
 ### 回放
 
 ```js
-var player = new EZUIKit.EZUIKitPlayer({
+const player = new EZUIKit.EZUIKitPlayer({
   id: "video-container", // 视频容器ID
   width: 600,
   height: 400,
@@ -89,7 +90,7 @@ var player = new EZUIKit.EZUIKitPlayer({
 
 alpha（功能测试）、beta（集成测试）为我们的非正式版本，可能存在功能或使用上的问题，若您遇到了任何问题，欢迎向我们反馈。
 
-非正式版本没有CDN资源，使用时需要配置 `staticPath`，引用本地的解码库资源。
+非正式版本没有 CDN 资源，使用时需要配置 `staticPath`，引用本地的解码库资源。
 
 ### 使用示例
 
@@ -119,30 +120,28 @@ alpha（功能测试）、beta（集成测试）为我们的非正式版本，
 > 轻应用支持向接入萤石云海外环境的设备发起取流播放，需要在初始化时配置海外服务域名，示例：
 
 ```js
-EZOPENDemo = new EZUIKit.EZUIKitPlayer({
-  id: 'playWind',
+const player = new EZUIKit.EZUIKitPlayer({
+  id: "playWind",
   width: 600,
   height: 400,
-  template:"pcLive",
-  url: '',
-  accessToken: '',
-  env:{
-    domain: "https://iusopen.ezvizlife.com" // 北美地区
-  }
+  template: "pcLive",
+  url: "",
+  accessToken: "",
+  env: {
+    domain: "https://iusopen.ezvizlife.com", // 北美地区
+  },
 });
 ```
 
 各地区的域名分别为：
 
-| 区域  | 域名                               |
-| --- | -------------------------------- |
-| 北美  | https://iusopen.ezvizlife.com    |
-| 南美  | https://isaopen.ezvizlife.com    |
-| 欧洲  | https://ieuopen.ezvizlife.com    |
+| 区域   | 域名                             |
+| ------ | -------------------------------- |
+| 北美   | https://iusopen.ezvizlife.com    |
+| 南美   | https://isaopen.ezvizlife.com    |
+| 欧洲   | https://ieuopen.ezvizlife.com    |
 | 新加坡 | https://isgpopen.ezvizlife.com   |
-| 印度  | https://iindiaopen.ezvizlife.com |
-
-
+| 印度   | https://iindiaopen.ezvizlife.com |
 
 #### 最佳实践 tips
 
@@ -375,6 +374,8 @@ themeData将主题数据本地化，设置本地数据，需要删除template参
 <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>
+<tr><td>debugDownloadData</td><td>boolean</td><td>下载原始码流， 调试码流使用, 默认 false (v8.1.1版本及以上支持)</td><td>N</td></tr>
+<tr><td>disableRenderPrivateData</td><td>boolean</td><td>禁止渲染私有数据(如智能分析， 移动侦测， 火点信息等), 默认 false (v8.1.1版本及以上支持)</td><td>N</td></tr>
 </table>
 
 ### 方法调用
@@ -473,46 +474,46 @@ player.stopTalk();
 
 #### 对讲设置麦克风增益
 
-```
-  // 设置音频增益系数 0 ~ 10
-  player.setVolumeGain(volume);
+```js
+// 设置音频增益系数 0 ~ 10
+player.setVolumeGain(volume);
 ```
 
 #### 获取麦克风权限
 
-```
-  player.getMicrophonePermission().then(data => {
-    if (data.code === 0) {
-      // 成功....
-    }
-  })
+```js
+player.getMicrophonePermission().then(data => {
+  if (data.code === 0) {
+    // 成功....
+  }
+})
 ```
 
 #### 获取麦克风列表
 
-```
-  // 需要在麦克风已授权的情况下调用，才能获取到麦克风列表，可以和getMicrophonePermission配合使用，或在初始化后先调用getMicrophonePermission获取授权
-  player.getMicrophonesList().then(data => {
-    if (data.code === 0) {
-      // 成功....
-    }
-  })
+```js
+// 需要在麦克风已授权的情况下调用，才能获取到麦克风列表，可以和getMicrophonePermission配合使用，或在初始化后先调用getMicrophonePermission获取授权
+player.getMicrophonesList().then(data => {
+  if (data.code === 0) {
+    // 成功....
+  }
+})
 ```
 
 #### 切换麦克风
 
-```
-  // microphoneId 为获取到的麦克风列表中的deviceId，如果当前处于对讲中，调用setProfile会先关闭，重新发起对讲
-  player.setProfile({ microphoneId })
+```js
+// microphoneId 为获取到的麦克风列表中的deviceId，如果当前处于对讲中，调用setProfile会先关闭，重新发起对讲
+player.setProfile({ microphoneId })
 ```
 
 #### 监听麦克风音量变化
 
-```
-  player.eventEmitter.on('volumeChange', ({ data }) => {
-    // 动态显示音柱,100ms触发一次
-    console.log(`${data * 100}%`)
-  })
+```js
+player.eventEmitter.on('volumeChange', ({ data }) => {
+  // 动态显示音柱,100ms触发一次
+  console.log(`${data * 100}%`)
+})
 ```
 
 #### 全屏
@@ -547,38 +548,36 @@ player.changePlayUrl(options).then(() => {
 
 options 参数说明
 
-| 参数名          | 类型      | 是否必选 | 默认值    | 描述                                          |
-|:------------ |:------- |:---- |:------ |:------------------------------------------- |
-| type         | String  | Y    | 无      | 播放地址类型，"live":预览，"rec"：回放；“cloud.rec”：云存储回放 |
-| deviceSerial | String  | Y    | 无      | 设备序列号,存在英文字母的设备序列号，字母需为大写                   |
-| channelNo    | int     | Y    | 无      | 通道号                                         |
-| accessToken  | String  | N    | 初始化时获取 | 授权过程获取的 access_token                        |
-| hd           | boolean | N    | 初始化时获取 | 是否为高清 true-主码流（高清） false-子码流(标清)            |
-| validCode    | String  | N    | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码）                        |
-| validCode    | String  | N    | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码）                        |
-| begin        | String  | N    | 初始化时获取 | type 类型为回放有效，开始时间 格式为“YYYYMMDDHHmmss”       |
-| end          | String  | N    | 初始化时获取 | type 类型为回放有效，结束时间 格式为 “YYYYMMDDHHmmss”      |
+| 参数名       | 类型    | 是否必选 | 默认值       | 描述                                                            |
+| :----------- | :------ | :------- | :----------- | :-------------------------------------------------------------- |
+| type         | String  | Y        | 无           | 播放地址类型，"live":预览，"rec"：回放；“cloud.rec”：云存储回放 |
+| deviceSerial | String  | Y        | 无           | 设备序列号,存在英文字母的设备序列号，字母需为大写               |
+| channelNo    | int     | Y        | 无           | 通道号                                                          |
+| accessToken  | String  | N        | 初始化时获取 | 授权过程获取的 access_token                                     |
+| hd           | boolean | N        | 初始化时获取 | 是否为高清 true-主码流（高清） false-子码流(标清)               |
+| validCode    | String  | N        | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码）                        |
+| begin        | String  | N        | 初始化时获取 | type 类型为回放有效，开始时间 格式为“YYYYMMDDHHmmss”            |
+| end          | String  | N        | 初始化时获取 | type 类型为回放有效，结束时间 格式为 “YYYYMMDDHHmmss”           |
 
 #### 切换模板主题
 
 > 可用于在播放中切换模板主题，请切换播放地址成功后调用
 
 ```js
-  player.Theme.changeTheme(template)
-
-  // 预览切回放场景示例
-  player.changePlayUrl({type:"rec"});
-  .then(()=>{
-    console.log("地址切换成功，开始切换模板主题");
-    player.Theme.changeTheme("pcRec");
-  });
+player.Theme.changeTheme(template)
+
+// 预览切回放场景示例
+player.changePlayUrl({type:"rec"}).then(()=>{
+  console.log("地址切换成功，开始切换模板主题");
+  player.Theme.changeTheme("pcRec");
+});
 ```
 
 template 参数说明
 
-| 参数名  | 类型     | 描述                    | 是否必选 |
-|:---- |:------ |:--------------------- |:---- |
-| type | String | 模板名称，详见初始化参数 template | Y    |
+| 参数名 | 类型   | 描述                              | 是否必选 |
+| :----- | :----- | :-------------------------------- | :------- |
+| type   | String | 模板名称，详见初始化参数 template | Y        |
 
 #### 开启电子放大