@trtc/call-engine-lite-js 3.5.8 → 4.0.0

package/index.d.ts

@@ -130,6 +130,28 @@ interface IBeautyLevelParams {
     ruddinessLevel: number;
 }
 
+/**
+ * TUI 错误码枚举
+ * @memberof TUICallType
+ * @enum {number}
+ * @example
+ * // 处理通话错误
+ * tuiCallEngine.on(TUICallEvent.ERROR, (event) => {
+ *   switch (event.code) {
+ *     case TUIErrorCode.ERR_CAMERA_NOT_AUTHORIZED:
+ *       console.error('摄像头权限未授权');
+ *       break;
+ *     case TUIErrorCode.ERR_MICROPHONE_NOT_AUTHORIZED:
+ *       console.error('麦克风权限未授权');
+ *       break;
+ *     case TUIErrorCode.ERR_SDK_NOT_INITIALIZED:
+ *       console.error('SDK 未初始化，请先调用 init 方法');
+ *       break;
+ *     default:
+ *       console.error('通话错误:', event.message);
+ *   }
+ * });
+ */
 declare enum TUIErrorCode {
     ERR_SUCC = 0,
     ERR_FAILED = -1,
@@ -221,14 +243,8 @@ type TUIDeviceInfo = {
     };
 };
 /**
- * **TUIRoomEngine 事件列表**<br>
- * @namespace TUICallEvents
- * @example
- * import TUIRoomEngine, { TUICallEvents } from '@tencentcloud/tuiroom-engine-js';
- * const roomEngine = new TUIRoomEngine();
- * roomEngine.on(TUICallEvents.onError, (error) => {
- *  console.log('roomEngine.error', error);
- * })
+ * TUICallEvent 事件枚举，包含所有通话相关的事件类型
+ * @module TUICallEvent
  */
 declare enum TUICallEvent {
     /**
@@ -260,15 +276,13 @@ declare enum TUICallEvent {
      * };
      * tuiCallEngine.on(TUICallEvent.KICKED_OUT, handleOnKickedOut);
      */
-    KICKED_OUT = "onKickedOffLine",
+    KICKED_OUT = "onKickedOffline",
     /**
      * @description userSig 过期事件
      * @default 'onUserSigExpired'
-     * @event TUICallEvents#onUserSigExpired
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUICallEvents.onUserSigExpired, () => {
-     *   console.log('roomEngine.onUserSigExpired');
+     * tuiCallEngine.on(TUICallEvent.USER_SIG_EXPIRED, () => {
+     *   console.log('userSig expired');
      * });
      */
     onUserSigExpired = "onUserSigExpired",
@@ -534,7 +548,6 @@ declare enum TUIRoomDeviceMangerEvents {
     /**
      * @description 设备变更事件
      * @default 'onDeviceChange'
-     * @event TUIRoomDeviceMangerEvents#onDeviceChange
      * @param {object} options
      * @param {string} options.deviceId 设备 Id
      * @param {any} options.type 设备类型
@@ -552,24 +565,15 @@ declare enum TUICamera {
     kFront = 0,
     kBack = 1
 }
-/**
- * 切换摄像头参数
- * @memberof SDK
- *
- * @exports TUICallCameraPosition
- * @module TUICallCameraPosition
- */
 declare enum TUICallCameraPosition {
     /**
      * @description 摄像头类型 - 前置摄像头
-     * @memberOf module:TRTCCallCameraPosition
      * @example
      * tuiCallEngine.switchCamera(TUICallCameraPosition.FRONT); // 切换前置摄像头
      */
     FRONT = 0,
     /**
      * @description 摄像头类型 - 后置摄像头
-     * @memberOf module:TRTCCallCameraPosition
      * @example
      * tuiCallEngine.switchCamera(TUICallCameraPosition.BACK); // 切换后置摄像头
      */
@@ -582,49 +586,39 @@ declare enum AUDIO_PLAYBACK_DEVICE {
 /**
  * 接入侧需要的呼叫类型列表，详细如下：
  * @memberof SDK
- *
  * @exports TUICallType
  * @module TUICallType
+/**
+ * TUICallType 通话类型和设备类型常量定义
+ * @module TUICallType
  */
 declare const TUICallType: {
     /**
      * @description 通话类型 - 语音通话
      * @memberOf module:TUICallType
      * @example
-     * let onError = function(error) {
-     *   console.log(error)
-     * };
-     * tuiCallEngine.call({userID: 'user1', type: TUICallType.AUDIO_CALL})
+     * tuiCallEngine.calls({userIDList: ['user1', 'user2'], type: TUICallType.AUDIO_CALL})
      */
     AUDIO_CALL: number;
     /**
      * @description 通话类型 - 视频通话
      * @memberOf module:TUICallType
      * @example
-     * let onError = function(error) {
-     *   console.log(error)
-     * };
-     * tuiCallEngine.call({userID: 'user1', type: TUICallType.VIDEO_CALL})
+     * tuiCallEngine.calls({userIDList: ['user1', 'user2'], type: TUICallType.VIDEO_CALL})
      */
     VIDEO_CALL: number;
     /**
      * @description 设备类型 - 摄像头
      * @memberOf module:TUICallType
      * @example
-     * let onError = function(error) {
-     *   console.log(error)
-     * };
-     * tuiCallEngine.getDeviceList(TUICallType.DEVCIED_CARMERA) // 获取摄像头列表
+     * tuiCallEngine.getDeviceList(TUICallType.DEVCIED_CARMERA)
      */
     DEVCIED_CAMERA: string;
     /**
      * @description 设备类型 - 麦克风
      * @memberOf module:TUICallType
      * @example
-     * let onError = function(error) {
-     *   console.log(error)
-     * };
-     * tuiCallEngine.getDeviceList(TUICallType.DEVCIED_CARMERA) // 获取麦克风列表
+     * tuiCallEngine.getDeviceList(TUICallType.DEVCIED_CARMERA)
      */
     DEVCIED_MICROPHONES: string;
 };
@@ -646,11 +640,18 @@ declare enum CallEndReason {
     EndByServer = 9
 }
 
+/**
+ * TUICallEngine 主入口文件
+ * @fileoverview TUICallEngine SDK 主要功能实现
+ * @private
+ */
+
 declare const VIDEO_ENCODER_MAP: any;
 
 /**
- * TUICallEngine 提供了 Call 的基本能力
- * @class TUICallEngine
+ * @namespace TUICallEngine
+ * @description @trtc/call-engine-lite-js 是基于腾讯云 [即时通信 IM](https://cloud.tencent.com/document/product/269/42440) 和 [实时音视频 TRTC](https://cloud.tencent.com/document/product/647/16788) 两项付费 PaaS 服务构建出的音视频通信组件，支持双人和多人场景下的音视频通话。
+ *
  */
 declare class TUICallEngine {
     static className: string;
@@ -708,25 +709,31 @@ declare class TUICallEngine {
      * - 注：SDK 会先 logout，然后释放资源
      * @memberof TUICallEngine
      * @returns {Promise}
+     * @example
+     * try {
+     *   await tuiCallEngine.destroyInstance();
+     *   // success
+     * } catch (error) {
+     *   console.warn('destroyInstance error:', error);
+     * }
      */
     destroyInstance(): Promise<void>;
     /**
-     * 登录 TUICallEngine
-     * @param {object} options
-     * @param {number} options.sdkAppId sdkAppId <br>
-     * 在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 单击 **应用管理** > **创建应用** 创建新应用之后，即可在 **应用信息** 中获取 sdkAppId 信息。
-     * @param {string} options.userId 用户ID <br>
-     * 建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
-     * @param {string} options.userSig userSig 签名 <br>
-     * 计算 userSig 的方式请参考 [UserSig 相关](https://cloud.tencent.com/document/product/647/17275)。
-     * @returns {Promise<void>}
+     * 登录接口，所有功能需要先进行登录后才能使用
+     * @memberof TUICallEngine
+     * @param {Object} params - 登录配置
+     * @param {String} params.userID 当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（\_）
+     * @param {String} params.userSig 腾讯云设计的一种安全保护签名，获取方式请参考 [如何计算 UserSig](https://cloud.tencent.com/document/product/647/17275)。
+     * @param {String=} params.assetsPath AI 降噪依赖 denoiser-wasm.js，文件部署的 CDN 或者静态资源服务器的路径。具体详见：[使用 AI 降噪](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/tutorial-10-%E4%BD%BF%E7%94%A8_AI_%E9%99%8D%E5%99%AA.html)。
+     * @returns {Promise}
      * @example
-     * // 登录 TUICallEngine
-     * await TUICallEngine.login({
-     *  sdkAppId: 0,   // 填写您申请的 sdkAppId
-     *  userId: '',    // 填写您业务对应的 userId
-     *  userSig: '',   // 填写服务器或本地计算的 userSig
-     * })
+     * try {
+     *   await tuiCallEngine.login({userID: 'your userID', userSig: 'your userSig'});
+     *   // success
+     * } catch (error) {
+     *   console.warn('login error:', error);
+     * }
+     *
      */
     login(params: ILoginParams): Promise<void>;
     /**
@@ -734,150 +741,176 @@ declare class TUICallEngine {
      * @memberof TUICallEngine
      * @returns {Promise}
      * @example
-     * await tuiCallEngine.logout();
+     * try {
+     *   await tuiCallEngine.logout();
+     *   // success
+     * } catch (error) {
+     *   console.warn('logout error:', error);
+     * }
      */
     logout(): Promise<void>;
     /**
-     * C2C邀请通话，被邀请方会收到 TUICallEvent.INVITED 事件<br>
-     * - 注意：离线推送仅适用于终端（Android 或 iOS)，Web 和 微信小程序不支持。
-     * @memberof TUICallEngine
-     * @param {Object} params - 拨打通话配置
-     * @param {String} params.userID 被邀请方 userID
-     * @param {Number} params.type 0-未知， 1-语音通话，2-视频通话
-     * @param {Number=} params.timeout 0为不超时, 单位 s(秒)（选填） - 默认 30s
-     * @param {Number=} params.roomID 数字房间号, 范围 [1, 2147483647]。支持 v1.4.2+ 版本。
-     * @param {String=} params.userData 扩展字段: 用于在邀请信令中增加扩展信息。支持 v1.4.2+ 版本。
-     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）-- 需 tsignaling 版本 >= 0.8.0
-     * | name                 | Type    | Description    |
-     * | :---                 | :---    | :---    |
-     * | title                | string  | 离线推送标题（选填）  |
-     * | description          | string  | 离线推送内容（选填）  |
-     * | androidOPPOChannelID | string  | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID（选填）  |
-     * | extension            | string  | 离线推送透传内容（选填）（tsignaling 版本 >= 0.9.0）|
-     * @returns {Promise}
-     * @example
-     * await tuiCallEngine.call({userID: 'user1', type: 1});
-     */
-    call(params: ICallParam): Promise<any>;
+      * 监听事件
+      * @memberof TUICallEngine
+      * @param {String} eventName 事件名
+      * @param {Function} callback 事件响应回调
+      * @param {Any} context 期望 callback 执行时的上下文
+      * @example
+      * let onError = function(error) {
+      *   console.log(error);
+      * };
+      * tuiCallEngine.on(TUICallEvent.ERROR, onError, this);
+      */
+    on(event: TUICallEvent, callback: () => void, context: any): void;
     /**
-     * IM群组邀请通话，被邀请方会收到 TUICallEvent.INVITED 事件<br>
-     * 注意：离线推送仅适用于终端（Android 或 iOS)，Web 和 微信小程序不支持。
+     * 取消监听事件
      * @memberof TUICallEngine
-     * @param {Object} params - 群聊拨打通话配置
-     * @param {Array} params.userIDList 邀请列表
-     * @param {Number} params.type 0-未知， 1-语音通话，2-视频通话
-     * @param {String} params.groupID IM 群组 ID
-     * @param {Number=} params.timeout 0为不超时, 单位 s(秒)（选填） - 默认 30s
-     * @param {Number=} params.roomID 数字房间号, 范围 [1, 2147483647]
-     * @param {String=} params.userData 扩展字段: 用于在邀请信令中增加扩展信息
-     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）-- 需 tsignaling 版本 >= 0.8.0
-     * | name                 | Type    | Description    |
-     * | :---                 | :---    | :---    |
-     * | title                | string  | 离线推送标题（选填）  |
-     * | description          | string  | 离线推送内容（选填） |
-     * | androidOPPOChannelID | string  | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID （选填） |
-     * | extension            | string  | 离线推送透传内容（选填）（tsignaling 版本 >= 0.9.0）  |
-     * @returns {Promise}
+     * @param {String} eventName 事件名
+     * @param {Function} callback 事件响应回调
+     * @param {Any} context 期望 callback 执行时的上下文
      * @example
-     * await tuiCallEngine.groupCall({userIDList: ['user1', 'user2'], type: 1, groupID: 'IM群组 ID'});
+     * let onError = function(error) {
+     *   console.log(error)
+     * };
+     * tuiCallEngine.off(TUICallEvent.ERROR, onError, this);
      */
-    groupCall(params: IGroupCallParam): Promise<any>;
+    off(event: TUICallEvent, callback: () => void, context: any): void;
     /**
-     * 多人通话<br>
+     * 发起单人或多人通话<br>
      * 注意：离线推送仅适用于终端（Android 或 iOS)，Web 和 微信小程序不支持。
      * @memberof TUICallEngine
      * @param {Object} params - 群聊拨打通话配置
      * @param {Array} params.userIDList 邀请列表
-     * @param {Number} params.type 0-未知， 1-语音通话，2-视频通话
+     * @param {Number} params.type  1-语音通话，2-视频通话
      * @param {String=} params.chatGroupID IM 群组 ID
      * @param {Number=} params.timeout 0为不超时, 单位 s(秒)（选填） - 默认 30s
      * @param {Number=} params.roomID 数字房间号, 范围 [1, 2147483647]
+     * @param {String=} params.strRoomID 字符串房间号
      * @param {String=} params.userData 扩展字段: 用于在邀请信令中增加扩展信息
-     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）-- 需 tsignaling 版本 >= 0.8.0
+     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）
      * | name                 | Type    | Description    |
      * | :---                 | :---    | :---    |
      * | title                | string  | 离线推送标题（选填）  |
      * | description          | string  | 离线推送内容（选填） |
      * | androidOPPOChannelID | string  | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID （选填） |
-     * | extension            | string  | 离线推送透传内容（选填）（tsignaling 版本 >= 0.9.0）  |
+     * | extension            | string  | 离线推送透传内容（选填） |
+     * | ignoreIOSBadge       | boolean | 离线推送忽略 badge 计数（仅对 iOS 生效）（选填） |
+     * | iOSSound             | string  | 离线推送声音设置(仅对 iOS 生效)（选填） |
+     * | androidSound         | string  | 离线推送声音设置（仅对 Android 生效)（选填） |
+     * | androidVIVOClassification | number | VIVO 推送消息分类（选填） |
+     * | androidXiaoMiChannelID | string | 小米手机 8.0 系统及以上的渠道 ID（选填） |
+     * | androidFCMChannelID  | string  | FCM 通道手机 8.0 系统及以上的渠道 ID（选填） |
+     * | androidHuaWeiCategory | string | 华为推送消息分类（选填） |
+     * | isDisablePush        | boolean | 是否关闭推送（默认开启推送）（选填） |
+     * | iOSPushType          | number  | iOS 离线推送类型，默认：APNs（选填） |
      * @returns {Promise}
      * @example
-     * await tuiCallEngine.calls({userIDList: ['user1', 'user2'], type: 1, chatGroupID: 'IM群组 ID'});
+     * try {
+     *   await tuiCallEngine.calls({
+     *     userIDList: ['user1', 'user2'],
+     *     type: 1,
+     *   });
+     *   // success
+     * } catch (error) {
+     *   console.warn('calls error:', error);
+     * }
      */
     calls(params: ICallsParam): Promise<any>;
     /**
-     * 当您作为被邀请方收到 TUICallEvent.INVITED 事件的回调时，可以调用该接口接听来电
+     * 主动加入通话
+     * @param params
+     * @param {String} params.callId 当前通话的唯一 id
+     * @example
+     * try {
+     *   await tuiCallEngine.join({
+     *     callId: 'call_123456'
+     *   });
+     *   // success
+     * } catch (error) {
+     *   console.warn('join error:', error);
+     * }
+    */
+    join(params: IJoinParam): Promise<void>;
+    /**
+     * 当您作为被邀请方收到 TUICallEvent.ON_CALL_RECEIVED 事件的回调时，可以调用该接口接听来电
      * @memberof TUICallEngine
      * @returns {Promise}
      * @example
-     * tuiCallEngine.on(TUICallEvent.INVITED, () => {
-     *   tuiCallEngine.accept().then(() => {
-     *     //success
-     *   }).catch(error => {
+     * tuiCallEngine.on(TUICallEvent.ON_CALL_RECEIVED, async () => {
+     *   try {
+     *     await tuiCallEngine.accept();
+     *     // success
+     *   } catch (error) {
      *     console.warn('accept error:', error);
-     *   });
+     *   }
      * });
      */
     accept(): Promise<any>;
-    reject(): Promise<any>;
-    hangup(): Promise<any>;
     /**
-     * IM群组邀请通话，被邀请方会收到 TUICallEvent.INVITED 事件<br>
-     * 注意：离线推送仅适用于终端（Android 或 iOS)，Web 和 微信小程序不支持。
+     * 当您作为被邀请方收到 TUICallEvent.INVITED 事件的回调时，可以调用该接口拒绝来电
      * @memberof TUICallEngine
-     * @param {Object} params - 群聊拨打通话配置
-     * @param {Array} params.userIDList 邀请列表
-     * @param {Number} params.type 0-未知， 1-语音通话，2-视频通话
-     * @param {String} params.groupID IM 群组 ID
-     * @param {Number=} params.timeout 0为不超时, 单位 s(秒)（选填） - 默认 30s
-     * @param {Number=} params.roomID 数字房间号, 范围 [1, 2147483647]
-     * @param {String=} params.userData 扩展字段: 用于在邀请信令中增加扩展信息
-     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）-- 需 tsignaling 版本 >= 0.8.0
-     * | name                 | Type    | Description    |
-     * | :---                 | :---    | :---    |
-     * | title                | string  | 离线推送标题（选填）  |
-     * | description          | string  | 离线推送内容（选填） |
-     * | androidOPPOChannelID | string  | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID （选填） |
-     * | extension            | string  | 离线推送透传内容（选填）（tsignaling 版本 >= 0.9.0）  |
      * @returns {Promise}
      * @example
-     * await tuiCallEngine.groupCall({userIDList: ['user1', 'user2'], type: 1, groupID: 'IM群组 ID'});
+     * tuiCallEngine.on(TUICallEvent.INVITED, async () => {
+     *   try {
+     *     await tuiCallEngine.reject();
+     *     // success
+     *   } catch (error) {
+     *     console.warn('reject error:', error);
+     *   }
+     * });
      */
-    inviteUser(params: IInviteUserParam): Promise<void>;
+    reject(): Promise<any>;
     /**
-     * IM群组邀请通话，被邀请方会收到 TUICallEvent.INVITED 事件<br>
-     * 注意：离线推送仅适用于终端（Android 或 iOS)，Web 和 微信小程序不支持。
+     * 挂断当前通话，当您处于通话中，可以调用该函数结束通话；当您处于呼叫状态时，可以调用该函数取消通话
+     *  1. 当您处于通话中，可以调用该接口结束通话
+     *  2. 当未拨通时, 可用来取消通话
      * @memberof TUICallEngine
-     * @param {Object} params - 群聊拨打通话配置
-     * @param {Array} params.userIDList 邀请列表
-     * @param {Number} params.type 0-未知， 1-语音通话，2-视频通话
-     * @param {String} params.groupID IM 群组 ID
-     * @param {Number=} params.timeout 0为不超时, 单位 s(秒)（选填） - 默认 30s
-     * @param {Number=} params.roomID 数字房间号, 范围 [1, 2147483647]
-     * @param {String=} params.userData 扩展字段: 用于在邀请信令中增加扩展信息
-     * @param {Object=} params.offlinePushInfo  - 自定义离线消息推送（选填）-- 需 tsignaling 版本 >= 0.8.0
-     * | name                 | Type    | Description    |
-     * | :---                 | :---    | :---    |
-     * | title                | string  | 离线推送标题（选填）  |
-     * | description          | string  | 离线推送内容（选填） |
-     * | androidOPPOChannelID | string  | 离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID （选填） |
-     * | extension            | string  | 离线推送透传内容（选填）（tsignaling 版本 >= 0.9.0）  |
      * @returns {Promise}
      * @example
-     * await tuiCallEngine.groupCall({userIDList: ['user1', 'user2'], type: 1, groupID: 'IM群组 ID'});
+     * try {
+     *   await tuiCallEngine.hangup();
+     *   // success
+     * } catch (error) {
+     *   console.warn('hangup error:', error);
+     * }
      */
-    joinInGroupCall(params: IJoinInGroupCallParam): Promise<void>;
+    hangup(): Promise<any>;
     /**
-     * call 3.0 新增的 “中途加入” 接口
-     * @param params 入参
-     * @param {String} params.callId 当前通话的唯一 id
+     * 您可以调用该接口开启摄像头，处于通话中的用户会收到 USER_VIDEO_AVAILABLE 回调
+     * @memberof TUICallEngine
+     * @param {string} videoViewDomID 该用户数据将渲染到该 dom id 节点里
+     * @param {boolean=} isFrontCamera 前后置摄像头，true 表示前置摄像头。**仅支持移动端上使用**
+     * @returns {Promise}
+     * 注意：
+     * - 当传入 string 类型的 videoViewDomID 时，需要确保 videoViewDomID 在 DOM 中，否则调用接口会报错。
+     * - 业务侧可自行调整该 DOM 元素的 css 宽高来控制 video 标签显示的宽高。
+     * @example
+     * // 'localView' is the id value corresponding to the div tag
+     * try {
+     *   await tuiCallEngine.openCamera('localView');
+     *   // success
+     * } catch (error) {
+     *   console.warn('openCamera error:', error);
+     * }
      */
-    join(params: IJoinParam): Promise<void>;
     openCamera(videoViewDomID: string, isFrontCamera?: boolean): Promise<void>;
+    /**
+     * 关闭摄像头
+     * @memberof TUICallEngine
+     * @returns {Promise}
+     * @example
+     * try {
+     *   await tuiCallEngine.closeCamera();
+     *   // success
+     * } catch (error) {
+     *   console.warn('closeCamera error:', error);
+     * }
+     */
     closeCamera(): Promise<void>;
     /**
      * 切换前后置摄像头<br>
-     * **Note: v3.0.0+ 支持，且该接口仅在移动端使用生效。**
+     * - **注意**: 该接口仅在移动端使用生效。
      * @memberof TUICallEngine
      * @param {TUICallCameraPosition} cameraPosition 摄像头类型
      *  - TUICallCameraPosition.FRONT 前置摄像头
@@ -902,12 +935,13 @@ declare class TUICallEngine {
      * @returns {Promise}
      * @example
      * const profile = '720p';
-     * // 设置视频质量为 720p
-     * tuiCallEngine.setVideoQuality(profile).then(() => {
+     * // Set video quality to 720p
+     * try {
+     *   await tuiCallEngine.setVideoQuality(profile);
      *   // success
-     * }).catch(error => {
-     *   console.warn('setVideoQuality error:', error)
-     * });
+     * } catch (error) {
+     *   console.warn('setVideoQuality error:', error);
+     * }
      */
     setVideoQuality(profile: string): Promise<void>;
     /**
@@ -919,8 +953,6 @@ declare class TUICallEngine {
      *  - cover 优先保证视窗被填满。视频尺寸等比缩放，直至整个视窗被视频填满。如果视频长宽与显示窗口不同，则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。
      *  - fill 保证视窗被填满的同时保证视频内容全部显示，但是不保证视频尺寸比例不变。视频的宽高会被拉伸至和视窗尺寸一致。
      *    播放视频流默认使用 cover 模式。
-     * @param {String} params.muted 是否需要 mute 声音, **v3.0.0 废弃**
-     *  - 对于本地流，muted 默认为 true，防止播放从麦克风采集的声音。
      * @param {TRTCVideoMirrorType} params.mirror 是否开启视频镜像预览
      * @param {TRTCVideoRotation} params.rotation 视频画面旋转方向
      * 注意
@@ -928,7 +960,7 @@ declare class TUICallEngine {
      *   - 对于远端音视频流，默认关闭镜像预览。
      *   - 对于屏幕分享流，不支持开启镜像预览。
      *   - 该参数只对本地预览有效，推流是没有镜像效果的。
-     * @examples
+     * @example
      * const params = {
      *  userID: '132',
      *  rotation: 0, // 旋转
@@ -943,11 +975,12 @@ declare class TUICallEngine {
      * @memberof TUICallEngine
      * @returns {Promise}
      * @example
-     * tuiCallEngine.openMicrophone().then(() => {
+     * try {
+     *   await tuiCallEngine.openMicrophone();
      *   // success
-     * }).catch(error => {
-     *   console.warn('openMicrophone error:', error)
-     * });
+     * } catch (error) {
+     *   console.warn('openMicrophone error:', error);
+     * }
      */
     openMicrophone(): Promise<void>;
     /**
@@ -955,13 +988,32 @@ declare class TUICallEngine {
      * @memberof TUICallEngine
      * @returns {Promise}
      * @example
-     * tuiCallEngine.closeMicrophone().then(() => {
+     * try {
+     *   await tuiCallEngine.closeMicrophone();
      *   // success
-     * }).catch(error => {
-     *   console.warn('closeMicrophone error:', error)
-     * });
+     * } catch (error) {
+     *   console.warn('closeMicrophone error:', error);
+     * }
      */
     closeMicrophone(): Promise<void>;
+    /**
+     * 开始渲染远端用户视频流
+     * @memberof TUICallEngine
+     * @param {IStartRemoteViewParam} params 远端视频渲染参数
+     * @param {string} params.userID 远端用户ID
+     * @param {string} params.videoViewDomID 视频渲染的 DOM 元素 ID
+     * @returns {Promise}
+     * @example
+     * try {
+     *   await tuiCallEngine.startRemoteView({
+     *     userID: 'remote_user_123',
+     *     videoViewDomID: 'remoteVideo'
+     *   });
+     *   // success
+     * } catch (error) {
+     *   console.warn('startRemoteView error:', error);
+     * }
+     */
     startRemoteView(params: IStartRemoteViewParam): Promise<void>;
     /**
      * 停止远端画面渲染
@@ -970,17 +1022,17 @@ declare class TUICallEngine {
      * @param {String} params.userID 用户id
      * @returns {Promise}
      * @example
-     * let promise = tuiCallEngine.stopRemoteView({userID: 'user1'});
-     * promise.then(() => {
-     *   //success
-     * }).catch(error => {
-     *   console.warn('stopRemoteView error:', error)
-     * });
+     * try {
+     *   await tuiCallEngine.stopRemoteView({userID: 'user1'});
+     *   // success
+     * } catch (error) {
+     *   console.warn('stopRemoteView error:', error);
+     * }
      */
     stopRemoteView(params: IStopRemoteViewParam): Promise<void>;
     /**
      * 开关/设置背景虚化<br>
-     * **Note: v3.0.5+ 支持，暂不支持 H5，后续支持。**
+     * - **注意**: v3.0.5+ 支持，暂不支持 H5，后续支持。
      * @param {number} blurLevel 虚化等级, 0 - 表示关闭背景虚化。目前不支持 blurLevel 等级的设置，后续支持。使用时需要 blurLevel > 0
      * @memberof TUICallEngine
      * @returns {Promise}
@@ -990,7 +1042,7 @@ declare class TUICallEngine {
     setBlurBackground(blurLevel: number): Promise<void>;
     /**
      * 开关/设置图片背景虚化<br>
-     * **Note: v3.0.5+ 支持，暂不支持 H5，后续支持。**
+     * - **注意**: v3.0.5+ 支持，暂不支持 H5，后续支持。
      * @param {string} imagePath 图片路径（可以是 url，也可以是相对路径）。imagePath = '' 表示关闭图片背景虚化
      * @memberof TUICallEngine
      * @returns {Promise}
@@ -1031,13 +1083,12 @@ declare class TUICallEngine {
     }): Promise<void>;
     /**
      * 支持 webrtc 的基础美颜
-     * @param {TRTCBeautyStyle} style 磨皮算法，有“光滑”(TRTCBeautyStyleSmooth=0)和“自然”(TRTCBeautyStyleNature=1)两种算法, 默认为 TRTCBeautyStyleNature
+     * @param {TRTCBeautyStyle} style 磨皮算法，有"光滑"(TRTCBeautyStyleSmooth=0)和"自然"(TRTCBeautyStyleNature=1)两种算法, 默认为 TRTCBeautyStyleNature
      * @param {number} beautyLevel 美颜级别，取值范围 [0 - 9]，0表示关闭，1 - 9值越大，效果越明显。
      * @param {number} whitenessLevel 美白级别，取值范围 [0 - 9]，0表示关闭，1 - 9值越大，效果越明显。
      * @param {number} ruddinessLevel 红润级别，取值范围 [0 - 9]，0表示关闭，1 - 9值越大，效果越明显。
      * @returns {Promise}
      * @example
-     * import {} from '@trtc/call-engine-lite-js';
      * await setBeautyLevel({
      *  type: TRTCBeautyStyle.TRTCBeautyStyleSmooth,
      *  beautyLevel: 0.3,
@@ -1059,54 +1110,13 @@ declare class TUICallEngine {
      * tuiCallEngine.setLogLevel(0);
      */
     setLogLevel(level: LOG_LEVEL): void;
-    /**
-     * login() 方法的别名接口，参数一致
-     * @memberof TUICallEngine
-     * @returns {Promise}
-     */
-    init(params: ILoginParams): Promise<void>;
-    /**
-     * 监听 callEngine 的事件
-     * @param event TUICallEvent
-     * @param func function
-     * @returns {void}
-     * @example
-     * const callEngine = new TUICallEngine();
-     * callEngine.on(event, func);
-     */
-    on(event: TUICallEvent, callback: () => void, context: any): void;
-    /**
-     * 移除监听 callEngine 的事件
-     * @param event TUICallEvent
-     * @param func function
-     * @returns {void}
-     * @example
-     * const callEngine = new TUICallEngine();
-     * callEngine.off(event, func);
-     */
-    off(event: TUICallEvent, callback: () => void, context: any): void;
-    /**
-     * 获取 trtcCloud 实例
-     * @returns {TRTCCloud} trtcCloud
-     * web 端 trtcCloud 能力请查看：https://web.sdk.qcloud.com/trtc/webrtc/trtcCloud/doc/TRTCCloud.html
-     *
-     * @example
-     * const callEngine = new TUICallEngine();
-     * const trtcCloud = callEngine.getTRTCCloud();
-     */
     getTRTCCloudInstance(): TRTCCloud;
-    /**
-     * 获取 tim 实例
-     * @returns {TIM} tim
-     * web 端 tim 能力请查看：https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html
-     * @example
-     */
     getTim(): ChatSDK;
     /**
      * 静态实验性接口
      * @private
      * @param jsonStr jason 字符串
-     * @returns
+     * @returns {Promise<any>} 返回实验性 API 的执行结果
      */
     static callExperimentalAPI(jsonStr: string): Promise<void>;
     /**
@@ -1126,11 +1136,12 @@ declare class TUICallEngine {
      *  - 'microphones' 麦克风，后续废弃 'microphones'。v3.0.0+ 支持传入 'microphone'
      *  - 'speaker' 扬声器，v3.0.0+ 才支持该参数
      * @example
-     * tuiCallEngine.getDeviceList('camera').then((devices)=>{  // 获取摄像头列表
-     *  console.log(devices)
-     * }).catch(error => {
-     *   console.warn('getDeviceList error:', error)
-     * });
+     * try {
+     *   const devices = await tuiCallEngine.getDeviceList('camera'); // Get camera list
+     *   console.log(devices);
+     * } catch (error) {
+     *   console.warn('getDeviceList error:', error);
+     * }
      */
     getDeviceList(deviceType: DEVICE_TYPE): Promise<TRTCDeviceInfo[]>;
     /**
@@ -1140,36 +1151,26 @@ declare class TUICallEngine {
      * @param {string} params.deviceType 需要切换的设备类型
      * - 'video' 摄像头, 后续废弃 'video'。v3.0.0+ 支持传入 'camera' 切换摄像头。
      * - 'audio' 麦克风, 后续废弃 'audio'。v3.0.0+ 支持传入 'microphone' 切换麦克风。
-     * - 'speaker' 扬声器, v3.0.0+ 支持
+     * - 'speaker' 扬声器。
      * @param {string} params.deviceId 需要切换的设备ID
      * - 摄像头设备标识通过 {@link TUICallEngine.getDeviceList getDeviceList('camera')} 获取。
      * - 麦克风设备标识通过 {@link TUICallEngine.getDeviceList getDeviceList('microphone')} 获取。
      * - 扬声器设备标识通过 {@link TUICallEngine.getDeviceList getDeviceList('speaker')} 获取。
      * @example
-     * let promise = tuiCallEngine.switchDevice({deviceType: 'camera', deviceId: cameras[0].deviceId}) // 切换设备
-     * promise.then(() => {
+     * try {
+     *   await tuiCallEngine.switchDevice({deviceType: 'camera', deviceId: cameras[0].deviceId}); // Switch device
      *   // success
-     * }).catch(error => {
-     *   console.warn('switchDevice error:', error)
-     * });
+     * } catch (error) {
+     *   console.warn('switchDevice error:', error);
+     * }
      */
     switchDevice(params: ISwitchDeviceParams): Promise<boolean>;
     private _updateCurrentDevice;
-    /**
-     * 当前通话类型切换
-     * - 仅支持1v1通话过程中使用
-     * - 失败监听 ERROR 事件，code: 60001
-     * @memberof TUICallEngine
-     * @param {String} newMediaType 通话类型
-     *  - 1 语音通话
-     *  - 2 视频通话
-     * @example
-     * tuiCallEngine.switchCallMediaType(1).then(() => { // 视频通话切换语音通话
-     *   // success
-     * }).catch(error => {
-     *   console.warn('switchCallMediaType error:', error)
-     * });
-     */
+    init(params: ILoginParams): Promise<void>;
+    call(params: ICallParam): Promise<any>;
+    groupCall(params: IGroupCallParam): Promise<any>;
+    inviteUser(params: IInviteUserParam): Promise<void>;
+    joinInGroupCall(params: IJoinInGroupCallParam): Promise<void>;
     switchCallMediaType(newMediaType: number): Promise<void>;
     private _checkDevicePermission;
     private _getMediaDevicesAuth;
@@ -1188,5 +1189,4 @@ declare class TUICallEngine {
     private _setDevicePermission;
 }
 
-export { AUDIO_PLAYBACK_DEVICE, CallEndReason, TUIAudioQuality, TUICallCameraPosition, TUICallEngine, TUICallEvent, TUICallType, TUICamera, TUIErrorCode, TUIKickedOutOfRoomReason, TUINetworkQuality, TUIResolutionMode, TUIRoomDeviceMangerEvents, TUIVideoQuality, VIDEO_ENCODER_MAP, TUICallEngine as default };
-export type { ILoginParams, TUIDeviceInfo, TUINetwork, TUIVideoEncoderParams };
+export { AUDIO_PLAYBACK_DEVICE, CallEndReason, ILoginParams, TUIAudioQuality, TUICallCameraPosition, TUICallEngine, TUICallEvent, TUICallType, TUICamera, TUIDeviceInfo, TUIErrorCode, TUIKickedOutOfRoomReason, TUINetwork, TUINetworkQuality, TUIResolutionMode, TUIRoomDeviceMangerEvents, TUIVideoEncoderParams, TUIVideoQuality, VIDEO_ENCODER_MAP, TUICallEngine as default };