Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 47ecd69

Browse files
committed
[CHG]更新使用文档使用方法readme
1 parent 4ba5e00 commit 47ecd69

File tree

1 file changed

+69
-2
lines changed

1 file changed

+69
-2
lines changed

README.md

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,69 @@
1-
# EZUIKit-JavaScript-npm
2-
轻应用npm版本,降低接入难度,适配自定义UI,适配主流框架
1+
# [EZUIKit-JavaScript-npm][ezuikit-js]
2+
>轻应用npm版本,降低接入难度,适配自定义UI,适配主流框架
3+
> 低延时预览,云存储回放,SD卡回放
4+
> 功能API丰富,如:播放控制,音频控制,视频截图,实时获取视频OSDTime,视频录制,设备对讲,电子放大,全屏等
5+
6+
7+
### 获取ezuikit-js
8+
9+
```
10+
$ npm install ezuikit-js
11+
```
12+
### 引入ezuikit-js
13+
14+
```
15+
import EZUIKit from 'ezuikit-js';
16+
```
17+
18+
>##### 如果你使用原生方法,可以通过标签引用
19+
```
20+
<script src="./ezuikit.js"></script>
21+
```
22+
23+
### 开始使用 - 初始化
24+
>基本使用
25+
26+
创建DOM
27+
28+
```
29+
<div id="video-container"></div>
30+
```
31+
32+
播放器初始化
33+
34+
```
35+
var player = new EZUIKit.EZUIKitPlayer({
36+
id: 'video-container', // 视频容器ID
37+
accessToken: 'at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz',
38+
url: 'ezopen://open.ys7.com/203751922/1.live',
39+
})
40+
```
41+
>初始化参数
42+
43+
### 方法调用
44+
> 示例: 停止播放
45+
46+
```
47+
player.stop();
48+
```
49+
50+
### 使用说明
51+
#### 初始化
52+
53+
|参数名|类型|描述|是否必选|
54+
|:--|:--|:--|:--|
55+
|id| String| 播放器容器DOM的id| Y|
56+
|accessToken| String| 授权过程获取的access_token| Y|
57+
|url |String| 视频ezopen协议播放地址 |Y|
58+
|| int |通道号,IPC设备填1 |Y|
59+
| |int |地址过期时间:`单位秒数,最大默认2592000(即30天),最小默认300(即5分钟)` |Y|
60+
61+
#### 方法集合
62+
63+
|方法名|类型|描述|使用示例|
64+
|:--|:--|:--|:--|
65+
|id| String| 播放器容器DOM的id| Y|
66+
|accessToken| String| 授权过程获取的access_token| Y|
67+
|url |String| 视频ezopen协议播放地址 |Y|
68+
|| int |通道号,IPC设备填1 |Y|
69+
| |int |地址过期时间:`单位秒数,最大默认2592000(即30天),最小默认300(即5分钟)` |Y|

0 commit comments

Comments
 (0)