@tencentcloud/tuiroom-engine-js 2.0.2 → 2.1.0

package/index.d.ts

@@ -252,10 +252,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;
@@ -279,7 +281,7 @@ declare class TUIRoomEngine {
     /**
      * 设置本地视频流的渲染位置
      * @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 +294,7 @@ declare class TUIRoomEngine {
      * });
      */
     setLocalVideoView(options: {
-        view: string | Array<string>;
+        view: string | Array<string> | null;
         streamType?: TUIVideoStreamType;
     }): void;
     /**
@@ -985,6 +987,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 实例发送消息