@tencentcloud/tuiroom-engine-js 2.0.3 → 2.2.0

package/index.d.ts

@@ -2,7 +2,9 @@ import TIM from '@tencentcloud/chat';
 import TencentCloudChat from '@tencentcloud/chat';
 import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-cloud-js-sdk';
 import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest, TUIVideoEncoderParams, TUIResolutionMode, TUISeatMode } from './types';
+import TUIRoomDeviceManager from './modules/deviceManager';
 export * from './types';
+export { TUIRoomDeviceManager };
 export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVolumeInfo, TRTCLogLevel, } from 'trtc-cloud-js-sdk';
 export { TRTCCloud, TIM, TencentCloudChat };
 /**
@@ -14,6 +16,8 @@ declare class TUIRoomEngine {
     static className: string;
     private static isReady;
     private roomEngineWASM;
+    private deviceManager;
+    private deviceManagerWASM;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -69,6 +73,7 @@ declare class TUIRoomEngine {
      * @param {object} options
      * @param {string} options.userName 用户名，必填
      * @param {string} options.avatarUrl 用户头像，必填
+     * @deprecated customInfo 字段自 v2.2.0 版本废弃
      * @param {object=} options.customInfo 用户自定义资料
      * App 管理员可以通过 [即时通信 IM 控制台 > 用户自定义字段](https://console.cloud.tencent.com/im/user-data) 新增自定义资料字段
      * 用户自定义字段生效以后，用户可以调用 setSelfInfo 接口设置自定义资料
@@ -128,6 +133,7 @@ declare class TUIRoomEngine {
      * 自由上麦模式，台下观众可以自由上麦，无需申请，seatMode 设置为 TUISeatMode.kFreeToTake
      * 申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦，seatMode 设置为 TUISeatMode.kApplyToTake
      * @param {boolean=} [options.isMicrophoneDisableForAllUser=false] 是否开启全员禁麦，默认不开启全员禁麦（创建房间可选参数）
+     * @param {boolean=} [options.isScreenShareDisableForAllUser=false] 是否开启禁止屏幕分享，默认不开启禁止屏幕分享权限（该属性自 v2.2.0 版本 以后支持，创建房间可选参数）
      * @param {boolean=} [options.isCameraDisableForAllUser=false] 是否开启全员禁画，默认不开启全员禁画（创建房间可选参数）
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
      * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）<br>
@@ -151,6 +157,7 @@ declare class TUIRoomEngine {
         isSeatEnabled?: boolean;
         seatMode?: TUISeatMode;
         isMicrophoneDisableForAllUser?: boolean;
+        isScreenShareDisableForAllUser?: boolean;
         isCameraDisableForAllUser?: boolean;
         isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
@@ -240,7 +247,7 @@ declare class TUIRoomEngine {
         seatMode: TUISeatMode;
     }): Promise<void>;
     /**
-     * 获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 100 个
+     * 获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 50 个
      *
      * @param {object=} options 获取用户列表的参数
      * @param {number=} options.nextSequence 偏移量，默认从 0 开始拉取用户<br/>
@@ -252,10 +259,12 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * const userList = [];
      * let result;
+     * let nextSequence = 0;
      * do {
-     *  result = await roomEngine.getUserList();
+     *  result = await roomEngine.getUserList({ nextSequence });
      *  userList.push(...result.userInfoList);
-     * } while (result.nextSequence !== 0)
+     *  nextSequence = result.nextSequence;
+     * } while (nextSequence !== 0)
      */
     getUserList(options?: {
         nextSequence?: number;
@@ -276,10 +285,33 @@ declare class TUIRoomEngine {
     getUserInfo(options: {
         userId: string;
     }): Promise<any>;
+    /**
+     * 设置用户的自定义信息，该接口需要在进房后调用；
+     * 主持人可以设置自己，管理员及普通用户的自定义信息；
+     * 管理员可以设置自己及普通用户的自定义信息；
+     * 普通用户仅可以设置自己的自定义信息；
+     * @param {object} options 设置用户的自定义信息
+     * @param {string} options.userId 用户 userId
+     * @param {object} options.customInfo 用户自定义信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.setCustomInfoForUser({
+     *   userId: 'user_12345',
+     *   customInfo: {
+     *     'key1': 'value1',
+     *     'key2': 'value2',
+     *   }
+     * });
+     */
+    setCustomInfoForUser(options: {
+        userId: string;
+        customInfo: Record<string, string>;
+    }): Promise<void>;
     /**
      * 设置本地视频流的渲染位置
      * @param {object} options 设置本地视频流的渲染位置的参数
-     * @param {string | Array<string>} options.view 本地视频流的渲染位置
+     * @param {string | Array<string> | null} options.view 本地视频流的渲染位置，如果传入 null 则不预览摄像头画面，但不影响摄像头采集，会正常推流。
      * @returns {Promise<void>}
      * @desc 自 v1.6.1 版本起，setLocalVideoView 不再需要传入 streamType 参数
      *
@@ -292,7 +324,7 @@ declare class TUIRoomEngine {
      * });
      */
     setLocalVideoView(options: {
-        view: string | Array<string>;
+        view: string | Array<string> | null;
         streamType?: TUIVideoStreamType;
     }): void;
     /**
@@ -838,8 +870,8 @@ declare class TUIRoomEngine {
     /**
      * 麦下用户可调用 takeSeat 成为麦上用户，仅麦上用户可发布本地音视频流。<br/>
      * 主持人&管理员调用 takeSeat 成功后即为麦上用户。<br/>
-     * roomInfo.SpeechMode 为 TUISpeechMode.kFreeToSpeak 模式时，普通用户调用 takeSeat 方法成功后即为麦上用户。<br/>
-     * roomInfo.SpeechMode 为 TUISpeechMode.kSpeakAfterTakingSeat 模式时，普通用户调用 takeSeat 方法需要等待主持人/管理员的同意后成为麦上用户。<br/>
+     * roomInfo.seatMode 为 TUISeatMode.kFreeToTake 模式时，普通用户调用 takeSeat 方法成功后即为麦上用户。<br/>
+     * roomInfo.seatMode 为 TUISeatMode.kApplyToTake 模式时，普通用户调用 takeSeat 方法需要等待主持人/管理员的同意后成为麦上用户。<br/>
      * 麦上用户的变更通过 TUIRoomEvents.onSeatListChanged 通知所有用户。<br/>
      * @param {object} options 获取麦位的参数
      * @param {number} options.seatIndex 麦位 index, 无麦位序号时设置为 -1
@@ -852,13 +884,13 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      *
      * // 情景一：主持人/管理员上麦
-     * // 情景二：roomInfo.SpeechMode 为 TUISpeechMode.kFreeToSpeak 模式时，普通用户上麦
+     * // 情景二：roomInfo.seatMode 为 TUISeatMode.kFreeToTake 模式时，普通用户上麦
      * await roomEngine.takeSeat({
      *  seatIndex: -1,
      *  timeout: 0,
      * });
      *
-     * // 情景三：roomInfo.SpeechMode 为 TUISpeechMode.kSpeakAfterTakingSeat 模式时，普通用户上麦
+     * // 情景三：roomInfo.seatMode 为 TUISeatMode.kApplyToTake 模式时，普通用户上麦
      * const request = await roomEngine.instance?.takeSeat({
      *  seatIndex: -1,
      *  timeout: 0,
@@ -985,6 +1017,16 @@ declare class TUIRoomEngine {
         seatIndex: number;
         lockParams: TUISeatLockParams;
     }): Promise<any>;
+    /**
+     * 主持人/管理员 获取房间内申请上麦用户的请求列表
+     * @returns {Promise<TUIRequest[]>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const seatList = await roomEngine.getSeatApplicationList();
+     * ;
+     */
+    getSeatApplicationList(): Promise<TUIRequest[]>;
     /**
      * 发送文本消息
      * @deprecated 该接口自 v2.0.0 版本废弃，请使用 {@link getTIM} 方法获取 tim 实例发送消息
@@ -1003,6 +1045,7 @@ declare class TUIRoomEngine {
     }): Promise<void>;
     /**
      * 发送自定义消息
+     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 {@link getTIM} 方法获取 tim 实例发送消息
      * @param {object} options
      * @param {string} options.messageText 自定义消息内容
      * @returns {Promise<void>}
@@ -1261,6 +1304,17 @@ declare class TUIRoomEngine {
      * 停止进行麦克风测试
      */
     stopMicDeviceTest(): Promise<void>;
+    /**
+     * v2.1.0 版本起支持使用 getMediaDeviceManager 获取 deviceManager 模块
+     * @since v2.1.0
+     * @example
+     * // 获取设备管理模块
+     * const deviceManager = roomEngine.getMediaDeviceManager();
+     *
+     * @returns {TUIRoomDeviceManager} deviceManager
+     */
+    getMediaDeviceManager(): TUIRoomDeviceManager;
+    private handleDeviceManagerWASM;
     /**
      * 获取 trtcCloud 实例
      * @returns {TRTCCloud} trtcCloud