ue-softphone-sdk 5.0.2 → 5.0.4

package/README.md

@@ -9,5 +9,100 @@
 > 4.0.24 不论监听与否都会连接通话socket
 > 4.0.27 修复退出登录时socket关闭错误，导致用户再次初始化状态异常
 > 4.0.30 登录增加passwordPk参数
-> 4.0.31 muteRing方法关闭铃声后，也不要挂断提示音
-> 5.0.0 新测试demo升级
+
+> 5.0.3
+## WebRTC麦克风控制
+
+### 1、开启或关闭麦克风
+
+该方法仅支持 `WEBRTC` 登录方式，并且需要在通话已建立、本地麦克风音轨存在时调用。其他登录方式调用时会返回失败提示。
+
+`ue.webrtc.setMicrophoneEnabled(Object object)`
+
+参数：
+
+| 属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
+| --- | --- | --- | --- | --- | --- |
+| success | function | - | - | 否 | 调用成功回调 |
+| fail | function | - | - | 否 | 调用失败回调 |
+| enabled | boolean | - | - | 是 | 是否开启麦克风 |
+
+object.enabled 的合法值
+
+| 值 | 说明 |
+| --- | --- |
+| true | 开启麦克风 |
+| false | 关闭麦克风 |
+
+调用成功返回：
+
+```js
+{
+  success: true,
+  message: "setMicrophoneEnabled success",
+  enabled: true
+}
+```
+
+非 WEBRTC 登录方式调用失败返回：
+
+```js
+{
+  success: false,
+  message: "当前登录方式不支持麦克风控制，请切换为 WEBRTC 登录方式!"
+}
+```
+
+示例：
+
+```js
+// 开启麦克风
+ue.webrtc.setMicrophoneEnabled({
+  enabled: true,
+  success: function (res) {
+    console.log(res, "开启麦克风成功");
+  },
+  fail: function (error) {
+    console.log(error, "开启麦克风失败");
+  }
+});
+
+// 关闭麦克风
+ue.webrtc.setMicrophoneEnabled({
+  enabled: false,
+  success: function (res) {
+    console.log(res, "关闭麦克风成功");
+  },
+  fail: function (error) {
+    console.log(error, "关闭麦克风失败");
+  }
+});
+```
+
+### 2、查询麦克风状态
+
+该方法用于查询当前 WEBRTC 本地麦克风音轨是否开启。需要在 `WEBRTC` 登录方式下，并且本地麦克风音轨已存在时调用。
+
+`ue.webrtc.isMicrophoneEnabled()`
+
+参数：
+
+无
+
+返回值：
+
+| 类型 | 说明 |
+| --- | --- |
+| boolean | `true` 表示麦克风已开启，`false` 表示麦克风已关闭或当前没有可用的本地麦克风音轨 |
+
+示例：
+
+```js
+const enabled = ue.webrtc.isMicrophoneEnabled();
+
+if (enabled) {
+  console.log("麦克风已开启");
+} else {
+  console.log("麦克风已关闭或暂无可用麦克风音轨");
+}
+```