Skip to content

Commit 686798f

Browse files
committed
docs: update README.md
1 parent a3cc9dd commit 686798f

File tree

1 file changed

+39
-40
lines changed

1 file changed

+39
-40
lines changed

Diff for: README.md

+39-40
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717

1818
### 获取 ezuikit-js
1919

20-
```
20+
```bash
21+
# npm
2122
npm install ezuikit-js
2223

2324
# yarn
@@ -31,13 +32,13 @@ pnpm add ezuikit-js
3132

3233
### 引入 ezuikit-js
3334

34-
```
35+
```js
3536
import EZUIKit from 'ezuikit-js';
3637
```
3738

3839
#### 如果你使用原生方法,可以通过标签引用
3940

40-
```
41+
```html
4142
<!-- umd -->
4243
<script src="./ezuikit.js"></script>
4344
```
@@ -48,7 +49,7 @@ import EZUIKit from 'ezuikit-js';
4849
4950
创建 DOM
5051

51-
```
52+
```html
5253
<div id="video-container"></div>
5354
```
5455

@@ -57,7 +58,7 @@ import EZUIKit from 'ezuikit-js';
5758
### 直播
5859

5960
```js
60-
var player = new EZUIKit.EZUIKitPlayer({
61+
const player = new EZUIKit.EZUIKitPlayer({
6162
id: "video-container", // 视频容器ID
6263
accessToken:
6364
"at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz",
@@ -75,7 +76,7 @@ var player = new EZUIKit.EZUIKitPlayer({
7576
### 回放
7677

7778
```js
78-
var player = new EZUIKit.EZUIKitPlayer({
79+
const player = new EZUIKit.EZUIKitPlayer({
7980
id: "video-container", // 视频容器ID
8081
width: 600,
8182
height: 400,
@@ -119,7 +120,7 @@ alpha(功能测试)、beta(集成测试)为我们的非正式版本,
119120
> 轻应用支持向接入萤石云海外环境的设备发起取流播放,需要在初始化时配置海外服务域名,示例:
120121
121122
```js
122-
EZOPENDemo = new EZUIKit.EZUIKitPlayer({
123+
const player = new EZUIKit.EZUIKitPlayer({
123124
id: "playWind",
124125
width: 600,
125126
height: 400,
@@ -473,46 +474,46 @@ player.stopTalk();
473474

474475
#### 对讲设置麦克风增益
475476

476-
```
477-
// 设置音频增益系数 0 ~ 10
478-
player.setVolumeGain(volume);
477+
```js
478+
// 设置音频增益系数 0 ~ 10
479+
player.setVolumeGain(volume);
479480
```
480481

481482
#### 获取麦克风权限
482483

483-
```
484-
player.getMicrophonePermission().then(data => {
485-
if (data.code === 0) {
486-
// 成功....
487-
}
488-
})
484+
```js
485+
player.getMicrophonePermission().then(data => {
486+
if (data.code === 0) {
487+
// 成功....
488+
}
489+
})
489490
```
490491

491492
#### 获取麦克风列表
492493

493-
```
494-
// 需要在麦克风已授权的情况下调用,才能获取到麦克风列表,可以和getMicrophonePermission配合使用,或在初始化后先调用getMicrophonePermission获取授权
495-
player.getMicrophonesList().then(data => {
496-
if (data.code === 0) {
497-
// 成功....
498-
}
499-
})
494+
```js
495+
// 需要在麦克风已授权的情况下调用,才能获取到麦克风列表,可以和getMicrophonePermission配合使用,或在初始化后先调用getMicrophonePermission获取授权
496+
player.getMicrophonesList().then(data => {
497+
if (data.code === 0) {
498+
// 成功....
499+
}
500+
})
500501
```
501502

502503
#### 切换麦克风
503504

504-
```
505-
// microphoneId 为获取到的麦克风列表中的deviceId,如果当前处于对讲中,调用setProfile会先关闭,重新发起对讲
506-
player.setProfile({ microphoneId })
505+
```js
506+
// microphoneId 为获取到的麦克风列表中的deviceId,如果当前处于对讲中,调用setProfile会先关闭,重新发起对讲
507+
player.setProfile({ microphoneId })
507508
```
508509

509510
#### 监听麦克风音量变化
510511

511-
```
512-
player.eventEmitter.on('volumeChange', ({ data }) => {
513-
// 动态显示音柱,100ms触发一次
514-
console.log(`${data * 100}%`)
515-
})
512+
```js
513+
player.eventEmitter.on('volumeChange', ({ data }) => {
514+
// 动态显示音柱,100ms触发一次
515+
console.log(`${data * 100}%`)
516+
})
516517
```
517518

518519
#### 全屏
@@ -555,7 +556,6 @@ options 参数说明
555556
| accessToken | String | N | 初始化时获取 | 授权过程获取的 access_token |
556557
| hd | boolean | N | 初始化时获取 | 是否为高清 true-主码流(高清) false-子码流(标清) |
557558
| validCode | String | N | 初始化时获取 | 设备验证码(加密设备播放需要输入验证码) |
558-
| validCode | String | N | 初始化时获取 | 设备验证码(加密设备播放需要输入验证码) |
559559
| begin | String | N | 初始化时获取 | type 类型为回放有效,开始时间 格式为“YYYYMMDDHHmmss” |
560560
| end | String | N | 初始化时获取 | type 类型为回放有效,结束时间 格式为 “YYYYMMDDHHmmss” |
561561

@@ -564,14 +564,13 @@ options 参数说明
564564
> 可用于在播放中切换模板主题,请切换播放地址成功后调用
565565
566566
```js
567-
player.Theme.changeTheme(template)
568-
569-
// 预览切回放场景示例
570-
player.changePlayUrl({type:"rec"});
571-
.then(()=>{
572-
console.log("地址切换成功,开始切换模板主题");
573-
player.Theme.changeTheme("pcRec");
574-
});
567+
player.Theme.changeTheme(template)
568+
569+
// 预览切回放场景示例
570+
player.changePlayUrl({type:"rec"}).then(()=>{
571+
console.log("地址切换成功,开始切换模板主题");
572+
player.Theme.changeTheme("pcRec");
573+
});
575574
```
576575

577576
template 参数说明

0 commit comments

Comments
 (0)