@tencentcloud/sdk-mcp 1.6.4 → 1.6.6

package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md

@@ -0,0 +1,390 @@
+TUICallEngine API 是音视频通话组件的**无 UI 接口**，如果 TUICallKit 的交互并不满足您的需求，您可以使用这套 API 根据您的业务需求自定义封装。
+
+由于小程序开发的限制，需要先给 live-pusher 绑定事件，具体请参见 [TUICallKit](https://cloud.tencent.com/document/product/647/78760)。
+
+> **说明：**
+>
+> - 为提供更优质的音视频通信能力，原 @trtc/call-engine-lite-wx 包已正式停止维护，建议开发者迁移至 [@trtc/call-engine-lite-wx](https://www.npmjs.com/package/@trtc/call-engine-lite-wx) 新包。
+> - 新包对接口进行了优化调整，部分旧版接口不再兼容，同步提供更简洁、稳定的新接口方案。
+
+## API 概览
+
+### 创建实例和事件回调
+
+|API|描述|
+|---------|---------|
+|createInstance|创建 TUICallEngine 实例（静态方法）|
+|destroyInstance|销毁 TUICallEngine 实例（静态方法）|
+|on|增加事件监听|
+|off|取消事件监听|
+
+### 通话操作相关接口函数
+
+|API|描述|
+|---------|---------|
+|calls|发起 1v1 通话|
+|inviteUser|在群组通话中，邀请其他人加入|
+|join|主动加入当前的群组通话中|
+|accept|接听通话|
+|reject|拒绝通话|
+|hangup|结束通话|
+
+### 设备控制相关接口函数
+
+|API|描述|
+|---------|---------|
+|openCamera|开启摄像头|
+|closeCamera|关闭摄像头|
+|switchCamera|切换前后摄像头|
+|openMicrophone|打开麦克风|
+|closeMicrophone|关闭麦克风|
+|selectAudioPlaybackDevice|选择音频播放设备（听筒/扬声器）|
+
+### 其他接口函数
+
+|API|描述|
+|---------|---------|
+|setSelfInfo|设置用户的头像、昵称|
+|setLogLevel|设置日志等级|
+|setBeautyLevel|设置美颜级别，支持关闭默认美颜|
+
+## API 详情
+``` javascript
+ import TUICallEngine, { TUICallEvent } from '@trtc/call-engine-lite-wx ';
+```
+
+### createInstance
+
+创建 TUICallEngine 的单例。
+``` javascript
+ wx.$TUICallEngine = TUICallEngine.createInstance({
+    tim,
+    sdkAppID,
+ });
+```
+
+**说明**
+
+|参数|类型|说明|是否必传|
+|---------|---------|---------|---------|
+|sdkAppID|Number|SDKAppId 是腾讯云用于区分客户的唯一标识|是|
+|tim|ChatSDK|TIM 实例|否|
+
+### destroyInstance
+
+销毁 TUICallEngine 的单例。
+``` javascript
+TUICallEngine.destroyInstance();
+```
+
+### on
+
+通过 on 方法可以监听 TUICallEngine 所有的事件。
+``` javascript
+let handleNewInvitationReceived = function(event) {
+    // 收到邀请
+};
+wx.$TUICallEngine.on(TUICallEvent.ON_CALL_RECEIVED, handleNewInvitationReceived, this);
+```
+
+**说明**
+
+|参数|类型|说明|是否必传|
+|---------|---------|---------|---------|
+|eventName|TUICallEvent|事件名|是|
+|handler|Function|事件的回调函数|是|
+|context|Any|当前执行上下文（this）|是|
+
+### off
+
+移除事件监听。
+``` javascript
+let handleNewInvitationReceived = function(event) {
+    // 收到邀请
+};
+wx.$TUICallEngine.off(TUICallEvent.ON_CALL_RECEIVED, handleNewInvitationReceived);
+```
+
+**说明**
+
+|参数|类型|说明|是否必传|
+|---------|---------|---------|---------|
+|eventName|TUICallEvent|事件名|是|
+|handler|Function|事件的回调函数|是|
+
+### login
+
+登录接口。
+``` swift
+const params = {
+    userID: 'john', // 您的用户 ID
+    userSig: 'xxxx', // 签名
+};
+let promise = wx.$TUICallEngine.login(params);
+promise.then(() => {
+    //success
+}).catch(error => {
+    console.warn('login error:', error);
+});
+```
+
+**参数如下表所示：**
+
+|参数|类型|含义|是否必传|
+|---------|---------|---------|---------|
+|userID|String|当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）|是|
+|userSig|String|腾讯云设计的一种安全保护签名，获取方式请参考 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。|是|
+
+### logout
+
+登出接口。
+``` swift
+let promise = wx.$TUICallEngine.logout();
+promise.then(() => {
+    // logout success
+}).catch(error => {
+    console.warn('logout error:', error);
+});
+```
+
+### calls
+
+发起单人或多人通话。
+
+> **注意**
+>
+> 离线推送仅适用于终端（Android 或 iOS），Web 和 微信小程序不支持。
+>
+
+``` javascript
+import { CallMediaType } from '@trtc/call-engine-lite-wx';
+let promise = wx.$TUICallEngine.groupCall({
+    userIDList: ['user1', 'user2'],
+    type: CallMediaType.AUDIO,
+});
+promise.then(() => {
+    // groupCall success
+}).catch(error => {
+    console.warn('groupCall error:', error);
+});
+```
+
+**参数如下表所示：**
+
+|参数|类型|含义|是否必传|
+|---------|---------|---------|---------|
+|userIDList|Array<String>|被呼叫者的 userID 列表|是|
+|type|[CallMediaType](https://cloud.tencent.com/document/product/647/78759#CallMediaType)|通话的媒体类型|是|
+|chatGroupID|String|与 chat 结合使用时， chat 群组的群ID|是|
+|timeout|Number|超时时长，单位：秒|否|
+|roomID|Number|此次通话的音视频房间 ID，目前仅支持数字房间号，后续版本会支持字符串房间号|否|
+|userData|String|扩展字段: 用于在邀请信令中增加扩展信息|否|
+
+### inviteUser
+
+邀请用户加入此次群组通话。
+
+使用场景：一个群组通话中的用户主动邀请其他人时使用。
+``` java
+const userIDList = ['jack', 'john'];
+const params = {
+    userIDList
+};
+wx.$TUICallEngine.inviteUser(params).then(() => {
+    // success
+}).catch(error => {
+    console.error('inviteUser error:', error);
+});
+```
+
+参数如下表所示：
+
+|参数|类型|含义|是否必传|
+|---------|---------|---------|---------|
+|params|Object|邀请参数|是|
+|params.userIDList|Array<String>|被叫用户的 userID 列表|是|
+
+### join
+
+主动加入此次群组通话。
+``` java
+const params = { callId: xxx };
+wx.$TUICallEngine.join(params).then(() => {
+    // success
+}).catch(error => {
+    console.error('join error:', error);
+});
+```
+
+参数如下表所示：
+
+|参数|类型|含义|是否必传|
+|---------|---------|---------|---------|
+|params|Object|主动加入参数|是|
+|params.callId|String|是|此次通话的唯一 ID。|
+
+### accept
+
+接受当前通话，当您作为被叫方收到 `EVENT.ON_CALL_RECEIVED` 事件的回调时，可以调用该接口接听来电。
+``` javascript
+wx.$TUICallEngine.on(TUICallEvent.ON_CALL_RECEIVED, () => {
+    wx.$TUICallEngine.accept().promise.then(() => {
+        // accept success
+    }).catch(error => {
+        console.warn('accept error:', error);
+    });
+});
+```
+
+### reject
+
+拒绝当前通话，当您作为被叫收到 `EVENT.ON_CALL_RECEIVED`  的回调时，可以调用该函数拒绝来电。
+``` javascript
+wx.$TUICallEngine.on(TUICallEvent.ON_CALL_RECEIVED, () => {
+    wx.$TUICallEngine.reject().then(() => {
+        // reject success
+    }).catch(error => {
+        console.warn('reject error:', error);
+    });
+});
+```
+
+### hangup
+
+挂断当前通话，当您处于通话中，可以调用该函数结束通话。
+``` javascript
+wx.$TUICallEngine.hangup().then(() => {
+     // hangup success
+ }).catch(error => {
+     console.warn('hangup error:', error);
+ });
+```
+
+### openCamera
+
+您可以调用该函数开启摄像头。
+``` javascript
+wx.$TUICallEngine.openCamera().then(() => {
+    // openCamera success
+}).catch(error => {
+    console.warn('openCamera error:', error);
+});
+```
+
+### closeCamera
+
+您可以调用该函数关闭摄像头，处于通话中的用户会收到回调。
+``` javascript
+wx.$TUICallEngine.closeCamera().then(() => {
+    // closeCamera success
+}).catch(error => {
+    console.warn('closeCamera error:', error);
+});
+```
+
+### switchCamera
+
+切换前后摄像头。
+``` javascript
+wx.$TUICallEngine.switchCamera().then(() => {
+    // switchCamera success
+}).catch(error => {
+    console.warn('openMicrophone error:', error);
+});
+```
+
+### openMicrophone
+
+您可以调用该函数打开麦克风，处于通话中的用户会收到回调。
+``` javascript
+wx.$TUICallEngine.openMicrophone().then(() => {
+    // openMicrophone success
+}).catch(error => {
+    console.warn('openMicrophone error:', error);
+});
+```
+
+### closeMicrophone
+
+您可以调用该函数关闭麦克风，处于通话中的用户会收到回调。
+``` javascript
+wx.$TUICallEngine.closeMicrophone().then(() => {
+    // closeMicrophone success
+}).catch(error => {
+    console.warn('closeMicrophone error:', error);
+});
+```
+
+### selectAudioPlaybackDevice
+
+选择音频播放设备，目前支持听筒、扬声器，在通话场景中，可以使用这个接口来开启/关闭免提模式。
+``` javascript
+wx.$TUICallEngine.selectAudioPlaybackDevice(AUDIO_PLAYBACK_DEVICE.EAR).then(() => {
+    // selectAudioPlaybackDevice success
+}).catch(error => {
+    console.warn('selectAudioPlaybackDevice error:', error);
+});
+```
+
+参数如下表所示：
+
+|参数|类型|含义|是否必传|
+|---------|---------|---------|---------|
+|type|[AUDIO_PLAYBACK_DEVICE](https://cloud.tencent.com/document/product/647/78759#AUDIO_PLAYBACK_DEVICE)|扬声器：AUDIO_PLAYBACK_DEVICE.SPEAKER<br>听筒：AUDIO_PLAYBACK_DEVICE.EAR|是|
+
+### setSelfInfo
+
+设置用户头像、昵称。
+``` javascript
+wx.$TUICallEngine.setSelfInfo("昵称", "头像 URL").then(() => {
+    // setSelfInfo success
+}).catch(error => {
+    console.warn('setSelfInfo error:', error);
+});
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|nickName|String|设置昵称|
+|avatar|String|头像地址|
+
+### setLogLevel
+
+设置日志级别，低于 level 的日志将不会输出。
+``` javascript
+wx.$TUICallEngine.setLogLevel(level)
+```
+
+参数如下表所示：
+| 参数 | 值 | 含义 |
+| --- | --- | --- |
+| level | 0 | 普通级别，日志量较多，接入时建议使用 |
+| 1 | release 级别，SDK 输出关键信息，生产环境时建议使用 |  |
+| 2 | 告警级别，SDK 只输出告警和错误级别的日志 |  |
+| 3 | 错误级别，SDK 只输出错误级别的日志 |  |
+| 4 | 无日志级别，SDK 将不打印任何日志 |  |
+
+### setBeautyLevel
+
+设置美颜，支持关闭默认美颜。
+``` javascript
+const params = {
+  style: 0, // 0-光滑; 1-自然
+  beautyLevel: 5,
+  whitenessLevel: 6,
+};
+
+wx.$TUICallEngine.setBeautyLevel(params);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|style|number|美颜磨皮模式，0-光滑; 1-自然。默认：0。|
+|beautyLevel|number|美颜级别，取值范围 [0 - 9]，0 表示关闭，1 - 9 值越大，效果越明显。|
+|whitenessLevel|number|美白级别，取值范围 [0 - 9]，0 表示关闭，1 - 9 值越大，效果越明显。|
+
+##

package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md

@@ -0,0 +1,317 @@
+TUICallEvent API 是音视频通话组件的事件接口。
+
+> **说明：**
+>
+> - 为提供更优质的音视频通信能力，原 [tuicall-engine-wx](https://www.npmjs.com/package/tuicall-engine-wx) 包已正式停止维护，建议开发者迁移至 [@trtc/call-engine-lite-wx](https://www.npmjs.com/package/@trtc/call-engine-lite-wx) 新包。
+> - 新包对接口进行了优化调整，部分旧版接口不再兼容，同步提供更简洁、稳定的新接口方案。
+
+## TUICallEvent 概览
+
+|事件名|说明|
+|---------|---------|
+|ON_CALL_RECEIVED|通话请求的事件。|
+|USER_ACCEPT|用户接听，**v4.x.x 已废弃。**|
+|USER_ENTER|用户进入通话。|
+|USER_LEAVE|用户离开通话。|
+|USER_UPDATE|用户更新。|
+|REJECT|用户拒绝通话。|
+|NO_RESP|用户无响应。|
+|LINE_BUSY|用户忙线。|
+|ON_CALL_NOT_CONNECTED|通话未建立时，通话的各端都会抛出该事件。|
+|ON_CALL_BEGIN|通话接通时抛出的事件。|
+|ON_CALL_END|通话结束。|
+|KICKED_OUT|被踢下线。|
+|ERROR|错误信息。|
+|ON_USER_NETWORK_QUALITY_CHANGED|所有用户网络质量的事件。|
+|USER_VIDEO_AVAILABLE|xxxx 用户是否有视频流的事件。|
+|USER_AUDIO_AVAILABLE|xxxx 用户是否有音频流的事件。|
+
+## TUICallEvent 详情
+``` javascript
+ import TUICallEngine, { TUICallEvent } from '@trtc/call-engine-lite-wx';
+```
+
+### ON_CALL_RECEIVED
+
+收到一个新的来电请求事件，被叫会收到，您可以通过监听这个事件，来决定是否显示通话接听界面。
+``` javascript
+let handleOnCallReceived = function(event) {
+    console.log(event)
+};
+tuiCallEngine.on(TUICallEvent.ON_CALL_RECEIVED, handleOnCallReceived, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|sponsor|String|邀请者。|
+|userIDList|Array<String>|同时还被邀请的人。|
+|isFromGroup|Boolean|是否是群组通话。|
+|inviteData|Object|呼叫数据。|
+|inviteID|String|邀请 ID，标识一次邀请。|
+|userData|String|扩展字段：用于在邀请信令中增加扩展信息。|
+|callId|String|本次通话的唯一 ID。|
+|roomID|Number|此次通话的音视频房间 ID。|
+|callMediaType|Number|通话的媒体类型，视频通话、语音通话。|
+|callRole|String|角色，枚举类型：主叫、被叫。|
+
+### USER_ACCEPT
+
+> **注意：**
+>
+> **该事件在 v4.x.x 已废弃。**
+>
+
+如果有用户接听，其他用户会收到该事件。
+``` javascript
+let handleUserAccept = function(event) {
+    console.log('用户接听')
+}
+tuiCallEngine.on(TUICallEvent.USER_ACCEPT, this.handleUserAccept, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|userID|String|接听的用户 ID。|
+|userList|Array|未接听用户的信息**（后续将废弃）。**|
+
+### USER_ENTER
+
+如果有用户同意进入通话，其他用户会收到该事件。
+``` javascript
+let handleUserEnter = function(event) {
+    console.log('用户进入通话')
+}
+tuiCallEngine.on(TUICallEvent.USER_ENTER, this.handleUserEnter, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|userID|String|进房的用户 ID。|
+|playerList|Array|房间中用户的推流信息。|
+
+### USER_LEAVE
+
+有用户离开此次通话时，通话中的其他用户会收到该事件。
+``` javascript
+let handleUserLeave = function(event) {
+    console.log('用户离开通话')
+}
+tuiCallEngine.on(TUICallEvent.USER_LEAVE, this.handleUserLeave, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|userID|String|退房的用户 ID。|
+|playerList|Array|房间中用户的推流信息。|
+
+### USER_UPDATE
+
+用户更新。
+``` javascript
+let handleUserUpdate = function(event) {
+    console.log('用户更新')
+}
+tuiCallEngine.on(TUICallEvent.USER_UPDATE, this.handleUserUpdate, this)
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|pusher|String|更新后的自身推流信息。|
+|playerList|Array|更新后其他用户的推流信息。|
+
+### REJECT
+
+通话被拒绝事件，在 1v1 通话中，只有主叫方会收到拒绝事件，在群组通话中，所有被邀请者都可以收到该事件。
+``` javascript
+let handleInviteeReject = function(event) {
+    console.log('用户拒绝通话')
+}
+tuiCallEngine.on(TUICallEvent.REJECT, this.handleInviteeReject, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|userID|String|拒绝通话的用户 ID。|
+|invitee|String|拒绝通话的用户 ID**（后续将废弃）。**|
+|inviteID|String|邀请 ID, 标识一次邀请。|
+|reason|String|reject  表示拒绝。|
+
+### NO_RESP
+
+邀请用户无应答。
+- 在C2C通话中，只有发起方会收到无人应答的回调 例如 A 邀请 B、C 进入通话，B不应答，A可以收到该回调，但C不行。
+
+- 在IM群组通话中，所有被邀请人均能收到该回调 例如 A 邀请 B、C 进入通话，B不应答，A、C均能收到该回调。
+
+   ``` javascript
+   let handleNoResponse = function(event) {
+       console.log('用户无响应')
+   }
+   tuiCallEngine.on(TUICallEvent.NO_RESP, this.handleNoResponse, this);
+   ```
+
+   参数如下表所示：
+
+   |参数|类型|含义|
+   |---------|---------|---------|
+   |groupID|String|群 ID，唯一标识。|
+   |sponsor|String|发起方的用户 ID。|
+   |userIDList|Array<String>|触发超时无响应的用户列表。|
+   |inviteID|String|邀请 ID，标识一次邀请。|
+
+### LINE_BUSY
+
+用户忙线。
+``` javascript
+let handleLineBusy = function(event) {
+    console.log('用户忙线')
+}
+tuiCallEngine.on(TUICallEvent.LINE_BUSY, this.handleLineBusy, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|userID|String|忙线用户 ID。|
+|inviteID|String|邀请 ID，标识一次邀请。|
+|reason|String|line busy  表示忙线。|
+
+### ON_CALL_NOT_CONNECTED
+
+**如果通话未建立，都会抛出该事件**。
+``` javascript
+let handleOnCallCanceled = function(event) {
+  console.log(event.userID);
+};
+tuiCallEngine.on(TUICallEvent.ON_CALL_CANCELED, handleOnCallCanceled, this);
+```
+
+参数如下表所示：
+| 参数 | 类型 | 含义 |
+| --- | --- | --- |
+| userID | String | 通话取消的用户 ID。 |
+| callId | String | 本次通话的唯一 ID。 |
+| roomID | Number | 此次通话的音视频房间 ID。 |
+| callMediaType | Number | 通话的媒体类型，视频通话、语音通话。 |
+| callRole | String | 角色，枚举类型：主叫、被叫。 |
+| reason | Number | 通话未建立原因：<br>- 0 - 未知。<br>- 1 - 挂断。<br>- 2 - 拒绝。<br>- 3 - 无响应。<br>- 4 - 离线。<br>- 5 - 忙线。<br>- 6 - 取消通话。<br>- 7 - 其它设备接听。<br>- 8 - 其它设备拒绝。<br>- 9 - 后台结束。 |
+
+### ON_CALL_BEGIN
+
+表示通话接通，主叫和被叫都可以收到，您可以通过监听这个事件来开启云端录制、内容审核等流程。
+``` javascript
+let handleOnCallBegin = function(event) {
+    console.log(event)
+};
+tuiCallEngine.on(TUICallEvent.ON_CALL_BEGIN, handleOnCallBegin, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|callId|String|本次通话的唯一 ID。|
+|roomID|Number|此次通话的音视频房间 ID。|
+|callMediaType|Number|通话的媒体类型，视频通话、语音通话。|
+|callRole|String|角色，类型：主叫、被叫。|
+
+### ON_CALL_END
+
+表示通话挂断，主叫和被叫都可以收到，您可以通过监听这个事件来显示通话时长、通话类型等信息，或者来停止云端的录制流程。
+``` javascript
+let handleCallingEnd = function(event) {
+    console.log('通话结束')
+}
+tuiCallEngine.on(TUICallEvent.ON_CALL_END, this.handleCallingEnd, this);
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|roomID|Number|此次通话的音视频房间 ID，目前仅支持数字房间号，后续版本会支持字符串房间号。|
+|callMediaType|Number|通话的媒体类型，视频通话、语音通话。|
+|callRole|String|角色，枚举类型：主叫（'inviter'）、被叫（'invitee'）、未知（''）。|
+|totalTime|Number|此次通话的时长，单位: 秒。|
+|userID|String|表示引起通话结束的 userID。|
+|callId|String|本次通话的唯一 ID。|
+
+### KICKED_OUT
+
+被踢下线。
+``` javascript
+let handleKickedOut = function(event) {
+    console.log('被踢下线')
+}
+tuiCallEngine.on(TUICallEvent.KICKED_OUT, this.handleKickedOut, this);
+```
+
+### ERROR
+
+监听 SDK 的错误信息。
+``` javascript
+let handleError = function(event) {
+    console.log('错误信息')
+}
+tuiCallEngine.on(TUICallEvent.ERROR, this.handleError, this);
+```
+
+### ON_USER_NETWORK_QUALITY_CHANGED
+
+所有用户网络质量的事件。
+``` javascript
+let handleOnUserNetworkQualityChange = function(event) {
+  console.log(event.networkQualityList);
+};
+tuiCallEngine.on(TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED, this.handleOnUserNetworkQualityChange, this);
+```
+
+参数如下表所示：
+| 参数 | 类型 | 含义 |
+| --- | --- | --- |
+| networkQualityList | Array<Object> | 网络状态，根据 userID 可以获取对应用户当前的网络质量。例如：<code>networkQualityList: [{ userId: quality }]</code>。<br><strong>网络质量说明：</strong><br>- quality = 0，网络状况未知。<br>- quality = 1，网络状况极佳。<br>- quality = 2，网络状况较好。<br>- quality = 3，网络状况一般。<br>- quality = 4，网络状况差。<br>- quality = 5，网络状况极差。<br>- quality = 6，网络连接已断开。 |
+
+### USER_VIDEO_AVAILABLE
+
+视频通话中一个用户开启/关闭了摄像头, 通话的其他用户都会抛出该事件。例如：A 和 B 在进行视频通话，A 开/关摄像头，B 会抛出该事件。
+``` javascript
+let handleUserVideoChange = function(event) {
+  console.log(event.userID, event.isVideoAvailable);
+};
+tuiCallEngine.on(TUICallEvent.USER_VIDEO_AVAILABLE, handleUserVideoChange);
+```
+
+参数如下表所示：
+| 参数 | 类型 | 含义 |
+| --- | --- | --- |
+| userID | String | 开/关摄像头的用户 ID。 |
+| isVideoAvailable | Boolean | - true 用户打开摄像头。<br>- false 用户关闭摄像头。 |
+
+### USER_AUDIO_AVAILABLE
+
+音视频通话中一个用户开启/关闭了麦克风, 通话的其他用户都会抛出该事件。例如：A 和 B 在进行音视频通话，A 开/关麦克风，B 会抛出该事件。
+``` javascript
+let handleUserAudioChange = function(event) {
+  console.log(event.userID, event.isAudioAvailable);
+};
+tuiCallEngine.on(TUICallEvent.USER_AUDIO_AVAILABLE, handleUserAudioChange);
+```
+
+参数如下表所示：
+| 参数 | 类型 | 含义 |
+| --- | --- | --- |
+| userID | String | 开/关麦克风的用户 ID。 |
+| isAudioAvailable | Boolean | - true 用户打开麦克风。<br>- false 用户关闭麦克风。 |