@tencentcloud/tuiroom-engine-js 3.0.6 → 3.1.0-beta.1

package/index.d.ts

@@ -212,7 +212,10 @@ declare enum TUIChangeReason {
 declare enum TUIKickedOutOfRoomReason {
     kKickedByAdmin = 0,
     kKickedByLoggedOnOtherDevice = 1,
-    kKickedByServer = 2
+    kKickedByServer = 2,
+    kNetworkDisconnected = 3,
+    kJoinRoomStatusInvalidDuringOffline = 4,
+    kCountOfJoinedRoomsExceedLimit = 5
 }
 declare enum TUIRequestAction {
     kInvalidAction = 0,
@@ -262,7 +265,7 @@ type TUISeatInfo = {
     userName: string;
     nameCard: string;
     avatarUrl: string;
-    locked: boolean;
+    isLocked: boolean;
     isVideoLocked: boolean;
     isAudioLocked: boolean;
 };
@@ -1178,7 +1181,7 @@ declare enum TUILiveModifyFlag {
 }
 type TUILiveListResult = {
     cursor: string;
-    listInfoList: Array<TUILiveInfo>;
+    liveInfoList: Array<TUILiveInfo>;
 };
 /**
  * @since v2.9.0
@@ -1992,16 +1995,20 @@ declare class TUILiveLayoutManager {
      *         "BackgroundColor": "0x1F212C",
      *
      *       }
-     *     ]
-     *   },
-     *   // 设置最大画面，只能有一路
-     *   "MaxUserLayout": {
-     *     "ZOrder": 0,        //层级
-     *     "StreamType": 0,    // 0为摄像头， 1为屏幕共享
-     *     "Member_Account": "admin001",
-     *     "BackgroundImageUrl": "ImageUrl", //可以设置看看，可能在最大画面时候没作用
-     *     "RoomId":"roomId",
-     *     "BackgroundColor":"0x1F212C"
+     *     ],
+     *    // 设置最大画面，只能有一路
+     *    "MaxUserLayout": {
+     *      "LocationX": 0,                      // 以画面左上角为原点的 x 坐标
+     *      "LocationY": 0,                      // 以画面左上角为原点的 y 坐标
+     *      "ImageWidth": 1920,                  // 调整后的画面宽度
+     *      "ImageHeight": 1080,                 // 调整后的画面高度
+     *      "ZOrder": 0,                         // 层级
+     *      "StreamType": 0,                     // 0为摄像头， 1为屏幕共享
+     *      "Member_Account": "admin001",
+     *      "BackgroundImageUrl": "ImageUrl",    // 可以设置看看，可能在最大画面时候没作用
+     *      "RoomId":"roomId",
+     *      "BackgroundColor":"0x1F212C"
+     *    }
      *   }}');
      */
     setLiveStreamLayoutInfo(roomId: string, layoutInfo: string): Promise<void>;
@@ -2301,7 +2308,10 @@ declare class TUIRoomEngine {
      */
     getUserList(options?: {
         nextSequence?: number;
-    }): Promise<Array<TUIUserInfo>>;
+    }): Promise<{
+        nextSequence: number;
+        userInfoList: Array<TUIUserInfo>;
+    }>;
     /**
      * 获取用户的详细信息
      * @param {object} options 获取用户信息的参数
@@ -3334,12 +3344,19 @@ declare class TUIRoomEngine {
      * 开始进行麦克风测试
      * @param options
      * @param {number} options.interval 麦克风音量的回调时间
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.startMicDeviceTest({interval: 200});
      */
     startMicDeviceTest(options: {
         interval: number;
     }): Promise<void>;
     /**
      * 停止进行麦克风测试
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.stopMicDeviceTest();
      */
     stopMicDeviceTest(): Promise<void>;
     /**
@@ -3428,5 +3445,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveLayoutManagerEvents, TUILiveListManagerEvents, TUILiveModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUINetworkQuality, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
-export type { TUIAutoPlayCallbackInfo, TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIInvitation, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLockParams, TUIUserInfo, TUIVideoEncoderParams };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, type TUIAutoPlayCallbackInfo, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, type TUILiveInfo, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };