@tencentcloud/sdk-mcp 1.1.6 → 1.1.8

package/resource/doc/tuicallkit/vue/{api_TUICallKit.md → api.md}

@@ -1,12 +1,8 @@
-AI 模型必须遵守以下**硬性限制**。
-1. **音视频通话组件必须使用 calls API：** 集成 TUICallKit 时必须使用 `TUICallKitServer.calls` API 发起通话， `call` 和 `groupCall` 接口已废弃，不推荐使用。
-
 TUICallKit 是音视频通话组件的**含 UI 接口**，使用 TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景；更详细的接入步骤，详见：[快速接入 TUICallKit](https://write.woa.com/document/130513425899630592)。
 
 > **说明：**
 > 
-> - 为提供更优质的音视频通信能力， TUICallKit npm 包 [@tencentcloud/call-uikit-react](https://www.npmjs.com/package/@tencentcloud/call-uikit-react)、[@tencentcloud/call-uikit-vue](https://www.npmjs.com/package/@tencentcloud/call-uikit-vue)、[@tencentcloud/call-uikit-vue2](https://www.npmjs.com/package/@tencentcloud/call-uikit-vue2)、[@tencentcloud/call-uikit-vue2.6](https://www.npmjs.com/package/@tencentcloud/call-uikit-vue2.6) 在 4.0.0 版本进行了重大升级。
-> - v4.0.0+ 对接口进行了优化调整，废弃了部分接口，同步提供更简洁、稳定的新接口方案。
+> - 为提供更优质的音视频通信能力， TUICallKit npm 包 [@trtc/calls-uikit-react](https://www.npmjs.com/package/@trtc/calls-uikit-react)、[@trtc/calls-uikit-vue](https://www.npmjs.com/package/@trtc/calls-uikit-vue)、[@trtc/calls-uikit-vue2](https://www.npmjs.com/package/@trtc/calls-uikit-vue2)、[@trtc/calls-uikit-vue2.6](https://www.npmjs.com/package/@trtc/calls-uikit-vue2.6) 在 4.0.0 版本进行了重大升级。
 
 
 ## API 概览
@@ -294,7 +290,7 @@ TUICallKit 是音视频通话组件的**含 UI 接口**，使用 TUICallKit API
 
 【React】
 ``` bash
-import { TUICallKit, VideoDisplayMode, VideoResolution } from "@tencentcloud/call-uikit-react";
+import { TUICallKit, VideoDisplayMode, VideoResolution } from "@trtc/calls-uikit-react";
 
 <TUICallKit
     videoDisplayMode={VideoDisplayMode.CONTAIN}
@@ -329,7 +325,7 @@ function handleAfterCalling() {
 </template>
 
 <script lang="ts" setup>
-import { TUICallKit, TUICallKitServer, VideoDisplayMode, VideoResolution, STATUS } from "@tencentcloud/call-uikit-vue";
+import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue";
 
 function beforeCalling(type: string, error: any) {
   console.log("[TUICallkit Demo] beforeCalling:", type, error);
@@ -371,7 +367,7 @@ function statusChanged(args: { oldStatus: string; newStatus: string; }) {
 </template>
 
 <script lang="ts" setup>
-import { TUICallKit, TUICallKitServer, VideoDisplayMode, VideoResolution, STATUS } from "@tencentcloud/call-uikit-vue2";
+import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue2";
 
 function beforeCalling(type: string, error: any) {
   console.log("[TUICallkit Demo] beforeCalling:", type, error);
@@ -412,7 +408,7 @@ function statusChanged(args: { oldStatus: string; newStatus: string; }) {
 </template>
 
 <script lang="ts" setup>
-import { TUICallKit, TUICallKitServer, VideoDisplayMode, VideoResolution, STATUS } from "@tencentcloud/call-uikit-vue2.6";
+import { TUICallKit, TUICallKitAPI, VideoDisplayMode, VideoResolution, STATUS } from "@trtc/calls-uikit-vue2.6";
 
 function beforeCalling(type: string, error: any) {
   console.log("[TUICallkit Demo] beforeCalling:", type, error);
@@ -435,32 +431,32 @@ function statusChanged(args: { oldStatus: string; newStatus: string; }) {
 </script>
 ```
 
-## TUICallKitServer API 详情
+## TUICallKitAPI API 详情
 
 
 
 
 【React】
 ``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-react"; 
+import { TUICallKitAPI } from "@trtc/calls-uikit-react"; 
 ```
 
 
 【Vue3】
 ``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-vue"; 
+import { TUICallKitAPI } from "@trtc/calls-uikit-vue"; 
 ```
 
 
 【Vue2.7】
 ``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-vue2"; 
+import { TUICallKitAPI } from "@trtc/calls-uikit-vue2"; 
 ```
 
 
 【Vue2.6】
 ``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-vue2.6";
+import { TUICallKitAPI } from "@trtc/calls-uikit-vue2.6";
 ```
 
 ### init
@@ -468,9 +464,9 @@ import { TUICallKitServer } from "@tencentcloud/call-uikit-vue2.6";
 初始化 TUICallKit。
 ``` javascript
 try {
-  await TUICallKitServer.init({ SDKAppID, userID, userSig });
+  await TUICallKitAPI.init({ SDKAppID, userID, userSig });
   // If you already have a tim instance in your project, you need to pass it in here.
-  // await TUICallKitServer.init({ tim, SDKAppID, userID, userSig}); 
+  // await TUICallKitAPI.init({ tim, SDKAppID, userID, userSig}); 
   console.log("[TUICallKit] init succeeds.");
 } catch (error: any) {
   console.error(`[TUICallKit] init failed. Reason: ${error}`);
@@ -534,18 +530,11 @@ try {
 ### calls
 
 发起单人或多人通话。
-
-> **说明：**
-> 
-
-> **v4.0.0+ 支持。**
-> 
-
 ``` javascript
 try {
-  await TUICallKitServer.calls({ 
+  await TUICallKitAPI.calls({ 
     userIDList: ['jack', 'tom'], 
-    type: TUICallType.VIDEO_CALL 
+    type: CallMediaType.VIDEO_CALL 
   });
 } catch (error: any) {
   console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
@@ -577,11 +566,11 @@ try {
 <tr>
 <td rowspan="1" colSpan="1" >type</td>
 
-<td rowspan="1" colSpan="1" >[TUICallType](https://cloud.tencent.com/document/product/647/81015#TUICallType)</td>
+<td rowspan="1" colSpan="1" >[CallMediaType](https://cloud.tencent.com/document/product/647/81015#TUICallType)</td>
 
 <td rowspan="1" colSpan="1" >是</td>
 
-<td rowspan="1" colSpan="1" >通话的媒体类型，参数值说明参见 [TUICallType 通话类型](https://cloud.tencent.com/document/product/647/81015#TUICallType)<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)</td>
+<td rowspan="1" colSpan="1" >通话的媒体类型，参数值说明参见 [CallMediaType 通话类型](https://cloud.tencent.com/document/product/647/81015#TUICallType)<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)</td>
 </tr>
 
 <tr>
@@ -649,16 +638,9 @@ try {
 ### join
 
 加入群组中已有的音视频通话。
-
-> **说明：**
-> 
-
-> **v4.0.0+ 支持。**
-> 
-
 ``` javascript
 try {
-  await TUICallKitServer.join({callId: xx});
+  await TUICallKitAPI.join({callId: xx});
 } catch (error: any) {
   console.error(`[TUICallKit] Failed to call the join API. Reason: ${error}`);
 }
@@ -692,7 +674,7 @@ try {
 
 设置语言，目前支持：中文、英文、日文。
 ``` javascript
-TUICallKitServer.setLanguage("zh-cn"); // "en" | "zh-cn" | "ja_JP"
+TUICallKitAPI.setLanguage("zh-cn"); // "en" | "zh-cn" | "ja_JP"
 ```
 
 参数如下表所示：
@@ -726,12 +708,12 @@ TUICallKitServer.setLanguage("zh-cn"); // "en" | "zh-cn" | "ja_JP"
 > **注意：**
 > 
 
-> **v2.2.0+ 支持**。**通话中使用该接口修改用户信息，UI 不会立即更新，需要等到下次通话才能看到变化**。
+> **通话中使用该接口修改用户信息，UI 不会立即更新，需要等到下次通话才能看到变化**。
 > 
 
 ``` javascript
 try {
-  await TUICallKitServer.setSelfInfo({ nickName: "xxx", avatar: "http://xxx" });
+  await TUICallKitAPI.setSelfInfo({ nickName: "xxx", avatar: "http://xxx" });
 } catch (error: any) {
   console.error(`[TUICallKit] Failed to call the setSelfInfo API. Reason: ${error}`;
 }
@@ -782,7 +764,7 @@ try {
 
    ``` javascript
    try {
-     await TUICallKitServer.setCallingBell(filePath?: string)
+     await TUICallKitAPI.setCallingBell(filePath?: string)
    } catch (error: any) {
      console.error(`[TUICallKit] Failed to call the setCallingBell API. Reason: ${error}`);
    }
@@ -818,7 +800,7 @@ try {
 开启/关闭悬浮窗功能。默认为 false，通话界面左上角的悬浮窗按钮隐藏，设置为 true 后显示。
 ``` javascript
 try {
-  await TUICallKitServer.enableFloatWindow(enable: Boolean)
+  await TUICallKitAPI.enableFloatWindow(enable: Boolean)
 } catch (error: any) {
   console.error(`[TUICallKit] Failed to call the enableFloatWindow API. Reason: ${error}`);
 }
@@ -829,7 +811,7 @@ try {
 开启/关闭来电铃声。开启后，收到通话请求时，不会播放来电铃声。
 ``` javascript
 try {
-  await TUICallKitServer.enableMuteMode(enable: boolean)
+  await TUICallKitAPI.enableMuteMode(enable: boolean)
 } catch (error: any) {
   console.error(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);
 }
@@ -862,17 +844,10 @@ try {
 ### enableVirtualBackground
 
 开启/关闭模糊背景功能。如果想设置图片背景模糊参见 [Web](https://cloud.tencent.com/document/product/647/106071)。通过调用接口，您可以在 UI 上显示模糊背景的功能按钮，点击按钮可直接启用模糊背景功能。
-
-> **注意：**
-> 
-
-> **v3.2.4+ 支持。**
-> 
-
 ``` javascript
-import { TUICallKitServer } from "@tencentcloud/call-uikit-react";
+import { TUICallKitAPI } from "@trtc/calls-uikit-react";
 const enable = true;
-TUICallKitServer.enableVirtualBackground(enable);
+TUICallKitAPI.enableVirtualBackground(enable);
 ```
 
 参数列表：
@@ -906,7 +881,7 @@ TUICallKitServer.enableVirtualBackground(enable);
 该方法不会自动退出`tim`，需要手动退出`tim.logout();`。
 ``` javascript
 try {
-  await TUICallKitServer.destroyed();
+  await TUICallKitAPI.destroyed();
 } catch (error: any) {
   alert(`[TUICallKit] Failed to call the destroyed API. Reason: ${error}`);
 }
@@ -916,29 +891,22 @@ try {
 
 隐藏功能按钮，目前仅支持 摄像头，麦克风和切换前后置按钮。
 
-> **注意：**
-> 
-
-> **v3.2.9+ 支持。**
-> 
-
-
 
 
 
 【Vue】
 ``` javascript
-import { TUICallKitServer, FeatureButton } from "@tencentcloud/call-uikit-vue";
+import { TUICallKitAPI, FeatureButton } from "@trtc/calls-uikit-vue";
 
-TUICallKitServer.hideFeatureButton(FeatureButton.Camera);
+TUICallKitAPI.hideFeatureButton(FeatureButton.Camera);
 ```
 
 
 【React】
 ``` javascript
-import { TUICallKitServer, FeatureButton } from "@tencentcloud/call-uikit-react";
+import { TUICallKitAPI, FeatureButton } from "@trtc/calls-uikit-react";
 
-TUICallKitServer.hideFeatureButton(FeatureButton.Camera);
+TUICallKitAPI.hideFeatureButton(FeatureButton.Camera);
 ```
 
 参数列表：
@@ -968,15 +936,8 @@ TUICallKitServer.hideFeatureButton(FeatureButton.Camera);
 ### setLocalViewBackgroundImage
 
 设置本地用户通话背景。
-
-> **注意：**
-> 
-
-> **v3.2.9+ 支持。**
-> 
-
 ``` typescript
-TUICallKitServer.setLocalViewBackgroundImage('http://xxx.png');
+TUICallKitAPI.setLocalViewBackgroundImage('http://xxx.png');
 ```
 
 参数列表：
@@ -1006,17 +967,10 @@ TUICallKitServer.setLocalViewBackgroundImage('http://xxx.png');
 ### setRemoteViewBackgroundImage
 
 设置远端用户通话背景。
-
-> **注意：**
-> 
-
-> **v3.2.9+ 支持。**
-> 
-
 ``` javascript
 const userId = 'xxx';
 const url = 'http://xxx.png';
-TUICallKitServer.setRemoteViewBackgroundImage(userId, url);
+TUICallKitAPI.setRemoteViewBackgroundImage(userId, url);
 ```
 
 参数列表：
@@ -1057,27 +1011,20 @@ TUICallKitServer.setRemoteViewBackgroundImage(userId, url);
 
 设置通话界面布局模式。
 
-> **注意：**
-> 
-
-> **v3.3.0+ 支持。**
-> 
-
-
 
 
 
 【Vue】
 ``` javascript
-import { TUICallKitServer, LayoutMode } from "@tencentcloud/call-uikit-vue";
-TUICallKitServer.setLayoutMode(LayoutMode.LocalInLargeView);
+import { TUICallKitAPI, LayoutMode } from "@trtc/calls-uikit-vue";
+TUICallKitAPI.setLayoutMode(LayoutMode.LocalInLargeView);
 ```
 
 
 【React】
 ``` javascript
-import { TUICallKitServer, LayoutMode } from "@tencentcloud/call-uikit-react";
-TUICallKitServer.setLayoutMode(LayoutMode.LocalInLargeView);
+import { TUICallKitAPI, LayoutMode } from "@trtc/calls-uikit-react";
+TUICallKitAPI.setLayoutMode(LayoutMode.LocalInLargeView);
 ```
 
 参数列表：
@@ -1107,15 +1054,8 @@ TUICallKitServer.setLayoutMode(LayoutMode.LocalInLargeView);
 ### setCameraDefaultState
 
 设置摄像头是否默认打开。
-
-> **注意：**
-> 
-
-> **v3.3.0+ 支持。**
-> 
-
 ``` javascript
-TUICallKitServer.setCameraDefaultState(true);
+TUICallKitAPI.setCameraDefaultState(true);
 ```
 
 参数列表：
@@ -1145,15 +1085,8 @@ TUICallKitServer.setCameraDefaultState(true);
 ### getTUICallEngineInstance
 
 获取 TUICallEngine 实例。
-
-> **注意：**
-> 
-
-> v2.4.3+ 支持。
-> 
-
 ``` javascript
-TUICallKitServer.getTUICallEngineInstance();
+TUICallKitAPI.getTUICallEngineInstance();
 ```
 
 ## TUICallKit 类型定义
@@ -1255,7 +1188,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
    **常见问题：**
 
-- iOS 13&14不支持编码高于 720P 的视频，建议在这两个系统版本限制最高采集 720P。参见 [iOS Safari 已知问题 case 12](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-02-info-webrtc-issues.html#h2-4)。
+- iOS 13&14不支持编码高于 720p 的视频，建议在这两个系统版本限制最高采集 720P。参见 [iOS Safari 已知问题 case 12](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-02-info-webrtc-issues.html#h2-4)。
 
 - Firefox 不支持自定义视频帧率（默认为 30fps）。
 
@@ -1320,22 +1253,22 @@ TUICallKitServer.getTUICallEngineInstance();
 </table>
 
 
-### **TUICallType**
+### **CallMediaType**
 <table>
 <tr>
-<td rowspan="1" colSpan="1" >TUICallType 类型</td>
+<td rowspan="1" colSpan="1" >CallMediaType 类型</td>
 
 <td rowspan="1" colSpan="1" >描述</td>
 </tr>
 
 <tr>
-<td rowspan="1" colSpan="1" >TUICallType.AUDIO_CALL </td>
+<td rowspan="1" colSpan="1" >CallMediaType.AUDIO</td>
 
 <td rowspan="1" colSpan="1" >语音通话</td>
 </tr>
 
 <tr>
-<td rowspan="1" colSpan="1" >TUICallType.VIDEO_CALL </td>
+<td rowspan="1" colSpan="1" >CallMediaType.VIDEO</td>
 
 <td rowspan="1" colSpan="1" >视频通话</td>
 </tr>
@@ -1401,7 +1334,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >离线推送忽略 badge 计数（仅对 iOS 生效）， 如果设置为 true，在 iOS 接收端，这条消息不会使 APP 的应用图标未读计数增加<br>**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >离线推送忽略 badge 计数（仅对 iOS 生效）， 如果设置为 true，在 iOS 接收端，这条消息不会使 App 的应用图标未读计数增加。</td>
 </tr>
 
 <tr>
@@ -1411,7 +1344,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >离线推送声音设置（仅对 iOS 生效）。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >离线推送声音设置（仅对 iOS 生效）。</td>
 </tr>
 
 <tr>
@@ -1421,7 +1354,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >离线推送声音设置（仅对 Android 生效）。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >离线推送声音设置（仅对 Android 生效）。</td>
 </tr>
 
 <tr>
@@ -1431,7 +1364,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >VIVO 推送消息分类。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >VIVO 推送消息分类。</td>
 </tr>
 
 <tr>
@@ -1441,7 +1374,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >小米手机 8.0 系统及以上的渠道 ID。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >小米手机 8.0 系统及以上的渠道 ID。</td>
 </tr>
 
 <tr>
@@ -1451,7 +1384,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >FCM 通道手机 8.0 系统及以上的渠道 ID。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >FCM 通道手机 8.0 系统及以上的渠道 ID。</td>
 </tr>
 
 <tr>
@@ -1461,7 +1394,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >华为推送消息分类。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >华为推送消息分类。</td>
 </tr>
 
 <tr>
@@ -1471,7 +1404,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >是否关闭推送（默认开启推送）。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >是否关闭推送（默认开启推送）。</td>
 </tr>
 
 <tr>
@@ -1481,7 +1414,7 @@ TUICallKitServer.getTUICallEngineInstance();
 
 <td rowspan="1" colSpan="1" >否</td>
 
-<td rowspan="1" colSpan="1" >iOS 离线推送类型。0-普通推送；1-VoIP推送。默认：0。**v3.3.0+ 支持**</td>
+<td rowspan="1" colSpan="1" >iOS 离线推送类型。0-普通推送；1-VoIP推送。默认：0。</td>
 </tr>
 </table>
 
@@ -1561,352 +1494,3 @@ offlinePushInfo.extension = JSON.stringify(extension);
 <td rowspan="1" colSpan="1" >远端用户在大窗显示</td>
 </tr>
 </table>
-
-
-# 废弃接口
-
-### <TUICallKitMini/>
-
-`<TUICallKitMini/>`：TUICallKit UI 通话悬浮窗，当`<TUICallKit :allowedMinimized="true"/>`时，`<TUICallKitMini/>`必须被放置在页面中。
-
-> **说明：**
-> 
-> - `<TUICallKitMini/>`UI 通话悬浮窗，**≥ v2.3.2 废弃，不再提供该组件**。
-> - 由`<TUICallKit/>` UI 通话组件主体，实现悬浮窗样式，减少使用复杂度。
-
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >属性</td>
-
-<td rowspan="1" colSpan="1" >描述</td>
-
-<td rowspan="1" colSpan="1" >类型</td>
-
-<td rowspan="1" colSpan="1" >是否必填</td>
-
-<td rowspan="1" colSpan="1" >默认值</td>
-
-<td rowspan="1" colSpan="1" >支持 vue</td>
-
-<td rowspan="1" colSpan="1" >支持 react</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" ><br>@kicked-out</td>
-
-<td rowspan="1" colSpan="1" >**注意：**<br>**≥ v2.3.2 废弃**<br><br>组件抛出的事件，当前登录用户被踢出登录时会触发该事件，通话也会自动结束</td>
-
-<td rowspan="1" colSpan="1" >function()</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >-</td>
-
-<td rowspan="1" colSpan="1" >√</td>
-
-<td rowspan="1" colSpan="1" >×</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" ><br>@status-changed</td>
-
-<td rowspan="1" colSpan="1" >**注意：**<br>**≥ v2.3.2 废弃**<br><br>组件抛出的事件，当通话状态发生变化时，会触发该事件，通话状态种类详见，[STATUS 值说明](https://cloud.tencent.com/document/product/647/81015#STATUS)</td>
-
-<td rowspan="1" colSpan="1" >function({oldStatus, newStatus})</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >-</td>
-
-<td rowspan="1" colSpan="1" >√</td>
-
-<td rowspan="1" colSpan="1" >×</td>
-</tr>
-</table>
-
-
-### call
-
-
-
-拨打 1v1 通话，**建议使用 calls 接口。**
-``` javascript
-import { TUICallKitServer, TUICallType } from '@tencentcloud/call-uikit-react';
-try {
-  await TUICallKitServer.call({ 
-    userID: 'mike', // username being called 
-    type: TUICallType.VIDEO_CALL,
-  });
-} catch (error: any) {
-  console.error(`[TUICallKit] Call failed. Reason: ${error}`);
-}
-```
-
-参数如下表所示：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >参数</td>
-
-<td rowspan="1" colSpan="1" >类型</td>
-
-<td rowspan="1" colSpan="1" >是否必填</td>
-
-<td rowspan="1" colSpan="1" >含义</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >被呼叫用户的用户名</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >type</td>
-
-<td rowspan="1" colSpan="1" >[TUICallType](https://cloud.tencent.com/document/product/647/81015#TUICallType)</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >通话的媒体类型，参数值说明参见 [TUICallType 通话类型](https://write.woa.com/document/90294110881382400)<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >roomID</td>
-
-<td rowspan="1" colSpan="1" >Number</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >数字房间号，范围 [1, 2147483647]</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >strRoomID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >字符串房间号。**v3.3.1+ 支持**<br>1. roomID 与 strRoomID 是互斥的，若您选用 strRoomID，则 roomID 需要填写为 0。若两者都填，SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID，因为它们之间是不互通的，例如数字 123 和字符串 "123" 是两个完全不同的房间。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >timeout</td>
-
-<td rowspan="1" colSpan="1" >Number</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >通话超时时间，默认：30s，单位：秒。timeout = 0，设置为不超时</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userData</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >发起通话时自定义扩展字段，被呼叫用户在 [ON_CALL_RECEIVED](https://write.woa.com/document/86735802757361664) 事件中有该参数</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[offlinePushInfo](https://cloud.tencent.com/document/product/647/81015#offlinePushInfo)</td>
-
-<td rowspan="1" colSpan="1" >Object</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >自定义离线消息推送参数</td>
-</tr>
-</table>
-
-
-### groupCall
-
-
-
-发起群组通话，**建议使用 calls 接口。**
-``` javascript
-try {
-  await TUICallKitServer.groupCall({ 
-    userIDList: ['jack', 'tom'], 
-    groupID: "xxx", 
-    type: TUICallType.VIDEO_CALL 
-  });
-} catch (error: any) {
-  console.error(`[TUICallKit] Failed to call the groupCall API. Reason:${error}`);
-}
-```
-
-参数如下表所示：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >参数</td>
-
-<td rowspan="1" colSpan="1" >类型</td>
-
-<td rowspan="1" colSpan="1" >是否必填</td>
-
-<td rowspan="1" colSpan="1" >含义</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userIDList</td>
-
-<td rowspan="1" colSpan="1" >Array<String></td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >被呼叫的用户列表</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >type</td>
-
-<td rowspan="1" colSpan="1" >[TUICallType](https://write.woa.com/document/90294110881382400)</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >通话的媒体类型，参数值说明参见 [TUICallType 通话类型](https://write.woa.com/document/90294110881382400)<br>兼容旧版本：语音通话(type = 1)、视频通话(type = 2)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >groupID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >通话群组 ID，groupID 的创建可参见 [chat-createGroup API](https://web.sdk.qcloud.com/im/doc/v3/zh-cn/SDK.html#createGroup)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >roomID</td>
-
-<td rowspan="1" colSpan="1" >Number</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >数字房间号，范围 [1, 2147483647]</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >strRoomID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >字符串房间号。**v3.3.1+ 支持**<br>1. roomID 与 strRoomID 是互斥的，若您选用 strRoomID，则 roomID 需要填写为 0。若两者都填，SDK 将优先选用 roomID。<br>2. 不要混用 roomID 和 strRoomID，因为它们之间是不互通的，例如数字 123 和字符串 "123" 是两个完全不同的房间。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >timeout</td>
-
-<td rowspan="1" colSpan="1" >Number</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >通话超时时间，默认：30s，单位：秒。timeout = 0，设置为不超时</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >userData</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >发起通话时自定义扩展字段，被呼叫用户在 [ON_CALL_RECEIVED](https://write.woa.com/document/86735802757361664) 事件中有该参数</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[offlinePushInfo](https://cloud.tencent.com/document/product/647/81015#offlinePushInfo)</td>
-
-<td rowspan="1" colSpan="1" >Object</td>
-
-<td rowspan="1" colSpan="1" >否</td>
-
-<td rowspan="1" colSpan="1" >自定义离线消息推送参数</td>
-</tr>
-</table>
-
-
-### joinInGroupCall
-
-
-
-加入群组中已有的音视频通话，**建议使用 join 接口。**
-
-> **注意：**
-> 
-
-> **v3.1.2+ 支持。**
-> 
-
-
-> **说明：**
-> 
-> - 加入群组中已有的音视频通话前，需要提前创建或加入IM 群组，并且群组中已有用户在通话中，如果已经创建，请忽略。
-> - 群组的创建详见： [IM 群组管理](https://cloud.tencent.com/document/product/269/75395#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/68493)，一站式集成聊天、通话等场景。
-
-``` javascript
-try {
-  const params = {
-    type: TUICallType.VIDEO_CALL,
-    groupID: "xxx",
-    roomID: 0,
-  };
-  await TUICallKitServer.joinInGroupCall(params);
-} catch (error: any) {
-  console.error(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);
-}
-```
-
-参数列表：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >参数</td>
-
-<td rowspan="1" colSpan="1" >类型</td>
-
-<td rowspan="1" colSpan="1" >是否必填</td>
-
-<td rowspan="1" colSpan="1" >含义</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >type</td>
-
-<td rowspan="1" colSpan="1" >[TUICallType](https://cloud.tencent.com/document/product/647/81015#TUICallType)</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >通话的媒体类型，例如视频通话、语音通话</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >groupID</td>
-
-<td rowspan="1" colSpan="1" >String</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >此次群组通话的群 ID</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >roomID</td>
-
-<td rowspan="1" colSpan="1" >number</td>
-
-<td rowspan="1" colSpan="1" >是</td>
-
-<td rowspan="1" colSpan="1" >此次通话的音视频房间 ID</td>
-</tr>
-</table>