ezuikit-js 8.1.1-alpha.2 → 8.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.
Files changed (3) hide show
  1. package/README.md +70 -40
  2. package/ezuikit.js +15 -23
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -61,7 +61,7 @@ var player = new EZUIKit.EZUIKitPlayer({
61
61
  id: "video-container", // 视频容器ID
62
62
  accessToken:
63
63
  "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
64
- url: "ezopen://open.ys7.com/G39444019/1.live",
64
+ url: "ezopen://open.ys7.com/BD3957004/1.live",
65
65
  width: 600,
66
66
  height: 400,
67
67
  handleError: (err) => {
@@ -81,21 +81,69 @@ var player = new EZUIKit.EZUIKitPlayer({
81
81
  height: 400,
82
82
  accessToken:
83
83
  "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
84
- url: "ezopen://open.ys7.com/G39444019/1.rec",
84
+ url: "ezopen://open.ys7.com/BD3957004/1.rec",
85
85
  });
86
86
  ```
87
87
 
88
+ #### 非正式版说明
89
+
90
+ alpha（功能测试）、beta（集成测试）为我们的非正式版本，可能存在功能或使用上的问题，若您遇到了任何问题，欢迎向我们反馈。
91
+
92
+ 非正式版本没有CDN资源，使用时需要配置 `staticPath`，引用本地的解码库资源。
93
+
94
+ ### 使用示例
95
+
96
+ > 如果使用原生 js，可参考 demos => [base-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/base-demo)
97
+
98
+ > 如果使用 react，可参考 demos => [react-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/react-demo)
99
+
100
+ > 如果使用 react + vite，可参考 demos => [with-react-vite](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-react-vite)
101
+
102
+ > 如果使用 vue2，可参考 demos => [vue-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue-demo)
103
+
104
+ > 如果使用 vue3，可参考 demos => [vue3-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue3-demo)
105
+
88
106
  #### tips
89
107
 
90
108
  为方便开发者快速接入
91
109
 
92
110
  我们提供了测试 accessToken,测试播放地址，并提供了几种常用场景使用示例。你可以通过使用示例，使用测试播放地址，测试 accessToken，在你的应用快速接入。
93
111
 
94
- <b>测试播放地址：</b> ezopen://open.ys7.com/G39444019/1.live
112
+ <b>测试播放地址：</b> ezopen://open.ys7.com/BD3957004/1.live
95
113
 
96
114
  你可以通过以下地址获取到测试 accessToken <a href="https://open.ys7.com/jssdk/ezopen/demo/token" target="_blank">获取测试 accessToken</a> 用来播放上述测试播放地址。
97
115
  当前设备有可能下线或被移除了， 如果自己有设备优先使用自己的设备进行测试。
98
116
 
117
+ ### 轻应用 - 海外版本
118
+
119
+ > 轻应用支持向接入萤石云海外环境的设备发起取流播放，需要在初始化时配置海外服务域名，示例：
120
+
121
+ ```js
122
+ EZOPENDemo = new EZUIKit.EZUIKitPlayer({
123
+ id: 'playWind',
124
+ width: 600,
125
+ height: 400,
126
+ template:"pcLive",
127
+ url: '',
128
+ accessToken: '',
129
+ env:{
130
+ domain: "https://iusopen.ezvizlife.com" // 北美地区
131
+ }
132
+ });
133
+ ```
134
+
135
+ 各地区的域名分别为：
136
+
137
+ | 区域 | 域名 |
138
+ | --- | -------------------------------- |
139
+ | 北美 | https://iusopen.ezvizlife.com |
140
+ | 南美 | https://isaopen.ezvizlife.com |
141
+ | 欧洲 | https://ieuopen.ezvizlife.com |
142
+ | 新加坡 | https://isgpopen.ezvizlife.com |
143
+ | 印度 | https://iindiaopen.ezvizlife.com |
144
+
145
+
146
+
99
147
  #### 最佳实践 tips
100
148
 
101
149
  1. 我们在 v0.6.2 及以上版本持用户通过开启谷歌实验室特性启动多线程解码，多线程模式将大大提升解码效率，降低解码内存消耗。
@@ -172,8 +220,8 @@ ezopen://open.ys7.com/${设备序列号}/{通道号}.rec?begin=yyyyMMddhhmmss
172
220
  ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhmmss
173
221
  视频 ezopen 协议播放地址 详见：<a href="https://open.ys7.com/help/23" target="_blank">ezopen 协议</a> </td><td>Y</td></tr>
174
222
 
175
- <tr><td>audio</td><td>boolean</td><td>是否默认开启声音 true：打开（默认） false：关闭 </td><td>N</td></tr>
176
- <tr><td>width</td><td>int</td><td>视频宽度，默认值为容器容器DOM宽度 </td><td>Y</td></tr>
223
+ <tr><td>audio</td><td>boolean</td><td>是否默认开启声音 true：打开（默认） false：关闭 </td><td>N</td></tr>
224
+ <tr><td>width</td><td>int</td><td>视频宽度，默认值为容器容器DOM宽度 </td><td>Y</td></tr>
177
225
  <tr><td>height</td><td>int</td><td>视频高度，默认值为容器容器DOM高度</td><td>Y</td></tr>
178
226
  <tr><td>staticPath</td><td>string</td><td>设置静态资源地址, 自定义可以自行下载 `ezuikit_static`放置在自己的服务器下， 设置 {staticPath: "/ezuikit_static"} </td><td>N</td></tr>
179
227
  <tr><td>template</td><td>String</td><td>
@@ -187,9 +235,9 @@ ezopen://open.ys7.com/${设备序列号}/{通道号}.cloud.rec?begin=yyyyMMddhhm
187
235
 
188
236
  <tr><td>security</td><td>安防版(预览回放); *固定模板 包含视频窗口，叠加了录制，全屏控件，<br />标清/高清切换，预览录制切换控件*</td></tr>
189
237
  <tr><td>voice</td><td>语音版; *固定模板 包含视频窗口，叠加了录制，全屏控件，语音播报，语音<br />对讲控件*</td></tr>
190
- <tr><td>pcLive</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定，可用于pc端预览，如需<br />修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用<br />themeData本地配置*</td></tr>
191
- <tr><td>pcRec</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定， 可用于pc端回放，如需<br />修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用themeData<br />本地配置*</td></tr>
192
- <tr><td>mobileLive</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定，可用于移动端预<br />览，如需修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用themeData<br />本地配置*</td></tr>
238
+ <tr><td>pcLive</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定，可用于pc端预览，如需<br />修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用<br />themeData本地配置*</td></tr>
239
+ <tr><td>pcRec</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定， 可用于pc端回放，如需<br />修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用themeData<br />本地配置*</td></tr>
240
+ <tr><td>mobileLive</td><td> *固定模板 按钮列表，颜色，底部头部背景色固定，可用于移动端预<br />览，如需修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用themeData<br />本地配置*</td></tr>
193
241
  <tr><td>mobileRec</td><td>*固定模板 按钮列表，颜色，底部头部背景色固定， 可用于移动端回放，<br />如需修改按钮配置，头部底部背景色，可参考 {{自定义themeId}}，或者使用themeData<br />本地配置*</td></tr>
194
242
  <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>
195
243
  </table>
@@ -499,17 +547,17 @@ player.changePlayUrl(options).then(() => {
499
547
 
500
548
  options 参数说明
501
549
 
502
- | 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
503
- | :----------- | :------ | :------- | :----------- | :-------------------------------------------------------------- |
504
- | type | String | Y | 无 | 播放地址类型，"live":预览，"rec"：回放；“cloud.rec”：云存储回放 |
505
- | deviceSerial | String | Y | 无 | 设备序列号,存在英文字母的设备序列号，字母需为大写 |
506
- | channelNo | int | Y | 无 | 通道号 |
507
- | accessToken | String | N | 初始化时获取 | 授权过程获取的 access_token |
508
- | hd | boolean | N | 初始化时获取 | 是否为高清 true-主码流（高清） false-子码流(标清) |
509
- | validCode | String | N | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码） |
510
- | validCode | String | N | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码） |
511
- | begin | String | N | 初始化时获取 | type 类型为回放有效，开始时间 格式为“YYYYMMDDHHmmss” |
512
- | end | String | N | 初始化时获取 | type 类型为回放有效，结束时间 格式为 “YYYYMMDDHHmmss” |
550
+ | 参数名 | 类型 | 是否必选 | 默认值 | 描述 |
551
+ |:------------ |:------- |:---- |:------ |:------------------------------------------- |
552
+ | type | String | Y | 无 | 播放地址类型，"live":预览，"rec"：回放；“cloud.rec”：云存储回放 |
553
+ | deviceSerial | String | Y | 无 | 设备序列号,存在英文字母的设备序列号，字母需为大写 |
554
+ | channelNo | int | Y | 无 | 通道号 |
555
+ | accessToken | String | N | 初始化时获取 | 授权过程获取的 access_token |
556
+ | hd | boolean | N | 初始化时获取 | 是否为高清 true-主码流（高清） false-子码流(标清) |
557
+ | validCode | String | N | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码） |
558
+ | validCode | String | N | 初始化时获取 | 设备验证码（加密设备播放需要输入验证码） |
559
+ | begin | String | N | 初始化时获取 | type 类型为回放有效，开始时间 格式为“YYYYMMDDHHmmss” |
560
+ | end | String | N | 初始化时获取 | type 类型为回放有效，结束时间 格式为 “YYYYMMDDHHmmss” |
513
561
 
514
562
  #### 切换模板主题
515
563
 
@@ -524,15 +572,13 @@ options 参数说明
524
572
  console.log("地址切换成功，开始切换模板主题");
525
573
  player.Theme.changeTheme("pcRec");
526
574
  });
527
-
528
-
529
575
  ```
530
576
 
531
577
  template 参数说明
532
578
 
533
- | 参数名 | 类型 | 描述 | 是否必选 |
534
- | :----- | :----- | :-------------------------------- | :------- |
535
- | type | String | 模板名称，详见初始化参数 template | Y |
579
+ | 参数名 | 类型 | 描述 | 是否必选 |
580
+ |:---- |:------ |:--------------------- |:---- |
581
+ | type | String | 模板名称，详见初始化参数 template | Y |
536
582
 
537
583
  #### 开启电子放大
538
584
 
@@ -578,19 +624,3 @@ player.reSize(width, height);
578
624
  // 顶装4分屏
579
625
  player.setFECCorrectType({place: 3 , type：4}, "cavnas1,canvas2,canvas3") // cavnas1,canvas2,canvas3 是分屏是需要的
580
626
  ```
581
-
582
- ### 非正式版说明
583
-
584
- 非正式版需要配置 `staticPath`
585
-
586
- ### 使用示例
587
-
588
- > 如果使用原生 js，可参考 demos => [base-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/base-demo)
589
-
590
- > 如果使用 react，可参考 demos => [react-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/react-demo)
591
-
592
- > 如果使用 react + vite，可参考 demos => [with-react-vite](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/with-react-vite)
593
-
594
- > 如果使用 vue2，可参考 demos => [vue-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue-demo)
595
-
596
- > 如果使用 vue3，可参考 demos => [vue3-demo](https://github.com/Ezviz-OpenBiz/EZUIKit-JavaScript-npm/tree/master/demos/vue3-demo)