@tencentcloud/tuiroom-engine-js 3.2.1-beta.1 → 3.3.0-beta.1

package/index.d.ts

@@ -8,6 +8,7 @@ declare enum TUIErrorCode {
     ERR_FAILED = -1,
     ERR_FREQ_LIMIT = -2,
     ERR_REPEAT_OPERATION = -3,
+    ERR_ROOM_MISMATCH = -4,
     ERR_SDKAPPID_NOT_FOUND = -1000,
     ERR_INVALID_PARAMETER = -1001,
     ERR_SDK_NOT_INITIALIZED = -1002,
@@ -53,9 +54,14 @@ declare enum TUIErrorCode {
     ERR_OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN = -2373,
     ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
     ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381,
+    ERR_ROOM_NOT_SUPPORT_PRELOADING = -4001,
+    ERR_CALL_IN_PROGRESS = -6001,
+    ERR_SERVER_SYSTEM_ERROR = 100001,
+    ERR_SERVER_INVALID_PARAMETER = 100002,
     ERR_ROOM_ID_OCCUPIED = 100003,
     ERR_ROOM_ID_NOT_EXIST = 100004,
     ERR_USER_NOT_ENTERED = 100005,
+    ERR_NO_PERMISSION = 100006,
     ERR_NEED_PASSWORD = 100018,
     ERR_WRONG_PASSWORD = 100019,
     ERR_ROOM_USER_FULL = 100008,
@@ -73,7 +79,13 @@ declare enum TUIErrorCode {
     ERR_BATTLE_ID_NOT_EXIST = 100411,
     ERR_ROOM_BATTLEID_IN_OTHER = 100415,
     ERR_ROOM_METADATA_EXCEED_KEY_COUNT_LIMIT = 100500,
-    ERR_ROOM_METADATA_EXCEED_VALUE_SIZE_LIMIT = 100501
+    ERR_ROOM_METADATA_EXCEED_VALUE_SIZE_LIMIT = 100501,
+    ERR_GIFT_ABILITY_NOT_ENABLED = 102001,
+    ERR_GIFT_NOT_EXIST = 102002,
+    ERR_GIFT_SERVER_PRE_VERIFICATION_FAILED = 102004,
+    ERR_MIX_STREAM_UPDATE_TOO_FREQ = 100427,
+    ERR_PUBLISH_STREAM_INFO_NOT_EXISTED = 100430,
+    ERR_PUBLISH_STREAM_NO_NEED_RECOVERY = 100431
 }
 type TUIRoomInfo = {
     roomId: string;
@@ -1170,15 +1182,43 @@ declare enum TUIConferenceInvitationManagerEvents {
     onInvitationStatusChanged = "onInvitationStatusChanged"
 }
 type TUILiveInfo = {
-    basicRoomInfo: TUIRoomInfo;
+    roomId: string;
+    roomType: TUIRoomType;
+    name: string;
+    notice: string;
+    isMessageDisableForAllUser: boolean;
     isGiftEnabled: boolean;
     isLikeEnabled: boolean;
     isPublicVisible: boolean;
-    activityStatus: number;
-    viewCount: number;
+    isSeatEnabled: boolean;
+    keepOwnerOnSeat: boolean;
+    seatLayoutTemplateId: number;
+    maxSeatCount: number;
+    seatMode: TUISeatMode;
     coverUrl: string;
     backgroundUrl: string;
     categoryList: Array<number>;
+    activityStatus: number;
+    readonly roomOwner?: string;
+    readonly ownerName?: string;
+    readonly ownerAvatarUrl?: string;
+    readonly createTime?: number;
+    readonly totalViewers?: number;
+    readonly isUnlimitedRoomEnabled?: boolean;
+    readonly cdnStreamUrl?: string;
+    readonly lebSecretKey?: string;
+    readonly lebEncrypted?: string;
+    readonly lebSignature?: string;
+};
+/**
+ * 直播连线用户信息
+ */
+type TUILiveConnectionUser = {
+    roomId: string;
+    userId: string;
+    userName: string;
+    avatarUrl: string;
+    joinConnectionTime: number;
 };
 type TUILiveModifyInfo = {
     roomId: string;
@@ -1187,16 +1227,22 @@ type TUILiveModifyInfo = {
     coverUrl?: string;
     backgroundUrl?: string;
     categoryList?: Array<number>;
+    seatLayoutTemplateId?: number;
 };
 declare enum TUILiveModifyFlag {
     kNone = 0,
-    kActivityStatus = 256,
-    kCoverUrl = 512,
-    kCategory = 1024,
-    kEnableGift = 2048,
-    kEnableLike = 4096,
-    kPublic = 8192,
-    kBackgroundUrl = 262144
+    kName = 1,
+    kNotice = 2,
+    kDisableMessage = 4,
+    kEnableGift = 8,
+    kEnableLike = 16,
+    kPublic = 32,
+    kTakeSeatMode = 64,
+    kCoverUrl = 128,
+    kBackgroundUrl = 256,
+    kCategory = 512,
+    kActivityStatus = 1024,
+    kSeatLayoutTemplateId = 2048
 }
 type TUILiveListResult = {
     cursor: string;
@@ -1233,8 +1279,101 @@ declare enum TUILiveLayoutManagerEvents {
      * };
      * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
-    onLiveVideoLayoutChanged = "onLiveVideoLayoutChanged"
+    onLiveVideoLayoutChanged = "onLiveVideoLayoutChanged",
+    /**
+     * @description 麦位排版信息发生变化事件回调
+     * @since v3.3.0
+     * @default 'onSeatLayoutChanged'
+     * @event TUILiveLayoutManagerEvents#onSeatLayoutChanged
+     * @param {object} option
+     * @param {string} option.roomId 房间 ID
+     * @param {TUISeatLayout} option.seatLayout 麦位排版信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, seatLayout) => {
+     *   console.log('liveLayoutManager.onSeatLayoutChanged', roomId, seatLayout);
+     * });
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onSeatLayoutChanged, callback);
+     */
+    onSeatLayoutChanged = "onSeatLayoutChanged"
+}
+declare enum TUIDeviceStatus {
+    TUIDeviceStatusOpened = 0,
+    TUIDeviceStatusClosedBySelf = 1,
+    TUIDeviceStatusClosedByAdmin = 2
+}
+/**
+ * 麦位排版信息
+ * @typedef {object} TUISeatRegion
+ * @property {string} roomId 直播间 ID
+ * @property {number} seatIndex 麦位序号
+ * @property {isSeatLocked} isSeatLocked 是否被锁定
+ * @property {string} userId 用户 ID
+ * @property {string} userName 用户名称
+ * @property {string} userAvatar 用户头像
+ * @property {TUIDeviceStatus} userMicrophoneStatus 用户麦克风状态
+ * @property {TUIDeviceStatus} userCameraStatus 用户摄像头状态
+ * @property {number} x 麦位 X 坐标
+ * @property {number} y 麦位 Y 坐标
+ * @property {number} width 麦位宽度
+ * @property {number} height 麦位高度
+ * @property {number} zorder 麦位 Z 轴顺序
+ */
+type TUISeatRegion = {
+    roomId: string;
+    seatIndex: number;
+    isSeatLocked: boolean;
+    userId: string;
+    userName: string;
+    userAvatar: string;
+    userMicrophoneStatus: TUIDeviceStatus;
+    userCameraStatus: TUIDeviceStatus;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    zorder: number;
+};
+/**
+ * 直播间麦位排版
+ * @typedef {object} TUISeatLayout
+ * @property {number} templateId 麦位排版模板 ID
+ * @property {number} canvasWidth 麦位排版画布宽度
+ * @property {number} canvasHeight 麦位排版画布高度
+ * @property {Array<TUISeatRegion>} regions 麦位排版区域列表
+ */
+type TUISeatLayout = {
+    templateId: number;
+    canvasWidth: number;
+    canvasHeight: number;
+    regions: Array<TUISeatRegion>;
+};
+declare enum TUISeatLayoutTemplate {
+    LandscapeDynamic_1v3 = 200,
+    PortraitDynamic_Grid9 = 600,
+    PortraitDynamic_1v6 = 601,
+    PortraitFixed_Grid9 = 800,
+    PortraitFixed_1v6 = 801,
+    PortraitFixed_6v6 = 802
 }
+/**
+ * 直播间统计信息
+ * @typedef {object} TUILiveStatisticsData
+ * @property {number} totalViewers 观众人数
+ * @property {number} totalGiftsSent 礼物发送总数
+ * @property {number} totalGiftCoins 礼物总价值
+ * @property {number} totalUniqueGiftSenders 礼物发送者总数
+ * @property {number} totalLikesReceived 点赞总数
+ */
+type TUILiveStatisticsData = {
+    totalViewers: number;
+    totalGiftsSent: number;
+    totalGiftCoins: number;
+    totalUniqueGiftSenders: number;
+    totalLikesReceived: number;
+};
 /**
  * @since v3.0.5
  * **TUILiveConnectionManager** 事件列表<br>
@@ -1244,18 +1383,16 @@ declare enum TUILiveConnectionManagerEvents {
      * @description 接收到连线请求的监听事件
      * @default 'onConnectionRequestReceived'
      * @event TUILiveConnectionManagerEvents#onConnectionRequestReceived
-     * @param {inviter} options 连线请求发起者
-     * @param {avatarUrl} options.avatarUrl 头像
-     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
-     * @param {roomId} options.roomId 房间号
-     * @param {userId} options.userId ID
-     * @param {userName} options.userName 用户名
+     * @param {object} options
+     * @param {TUILiveConnectionUser} options.inviter 连线邀请者
+     * @param {Array<TUILiveConnectionUser>} options.inviteeList 连线被邀请者列表
+     * @param {string} options.extensionInfo 扩展信息
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
-     *   console.log('liveConnectionManager.onConnectionRequestReceived', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ inviter, inviteeList, extensionInfo }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReceived', inviter, inviteeList, extensionInfo);
      * });
      */
     onConnectionRequestReceived = "onConnectionRequestReceived",
@@ -1264,9 +1401,9 @@ declare enum TUILiveConnectionManagerEvents {
      * @default 'onConnectionUserListChanged'
      * @event TUILiveConnectionManagerEvents#onConnectionUserListChanged
      * @param {object} options
-     * @param {connectedList} options.connectedList 包含连线房间所有主播列表
-     * @param {joinedList} options.joinedList 本次事件变更加入连线房间的主播列表
-     * @param {leavedList} options.leavedList 本次事件变更离开连线房间的主播列表
+     * @param {Array<TUILiveConnectionUser>} options.connectedList 包含连线房间所有主播列表
+     * @param {Array<TUILiveConnectionUser>} options.joinedList 本次事件变更加入连线房间的主播列表
+     * @param {Array<TUILiveConnectionUser>} options.leavedList 本次事件变更离开连线房间的主播列表
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -1280,18 +1417,14 @@ declare enum TUILiveConnectionManagerEvents {
      * @description 连线请求被取消的监听事件
      * @default 'onConnectionRequestCancelled'
      * @event TUILiveConnectionManagerEvents#onConnectionRequestCancelled
-     * @param {invitee} options 连线请求被邀请者
-     * @param {avatarUrl} options.avatarUrl 头像
-     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
-     * @param {roomId} options.roomId 房间号
-     * @param {userId} options.userId ID
-     * @param {userName} options.userName 用户名
+     * @param {object} options
+     * @param {TUILiveConnectionUser} options.inviter 连线邀请者
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
-     *   console.log('liveConnectionManager.onConnectionRequestCancelled', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ inviter }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestCancelled', inviter);
      * });
      */
     onConnectionRequestCancelled = "onConnectionRequestCancelled",
@@ -1299,18 +1432,14 @@ declare enum TUILiveConnectionManagerEvents {
      * @description 连线请求被同意的监听事件
      * @default 'onConnectionRequestAccept'
      * @event TUILiveConnectionManagerEvents#onConnectionRequestAccept
-     * @param {invitee} options 连线请求被邀请者
-     * @param {avatarUrl} options.avatarUrl 头像
-     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
-     * @param {roomId} options.roomId 房间号
-     * @param {userId} options.userId ID
-     * @param {userName} options.userName 用户名
+     * @param {object} options
+     * @param {TUILiveConnectionUser} options.invitee 连线被邀请者
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
-     *   console.log('liveConnectionManager.onConnectionRequestAccept', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ invitee }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestAccept', invitee);
      * });
      */
     onConnectionRequestAccept = "onConnectionRequestAccept",
@@ -1318,45 +1447,32 @@ declare enum TUILiveConnectionManagerEvents {
      * @description 连线请求被拒绝的监听事件
      * @default 'onConnectionRequestReject'
      * @event TUILiveConnectionManagerEvents#onConnectionRequestReject
-     * @param {invitee} options 连线请求被邀请者
-     * @param {avatarUrl} options.avatarUrl 头像
-     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
-     * @param {roomId} options.roomId 房间号
-     * @param {userId} options.userId ID
-     * @param {userName} options.userName 用户名
+     * @param {object} options
+     * @param {TUILiveConnectionUser} options.invitee 连线被邀请者
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
-     *   console.log('liveConnectionManager.onConnectionRequestReject', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ invitee }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReject', invitee);
      * });
      */
     onConnectionRequestReject = "onConnectionRequestReject",
     /**
-   * @description 邀请超时的监听事件
-   * @default 'onConnectionRequestTimeout'
-   * @event TUILiveConnectionManagerEvents#onConnectionRequestTimeout
-   * @param {invitee} invitee 连线请求被邀请者
-   * @param {avatarUrl} invitee.avatarUrl 头像
-   * @param {joinConnectionTime} invitee.joinConnectionTime 加入连线时间
-   * @param {roomId} invitee.roomId 房间号
-   * @param {userId} invitee.userId ID
-   * @param {userName} invitee.userName 用户名
-   * @param {inviter} inviter 连线请求邀请者
-   * @param {avatarUrl} inviter.avatarUrl 头像
-   * @param {joinConnectionTime} inviter.joinConnectionTime 加入连线时间
-   * @param {roomId} inviter.roomId 房间号
-   * @param {userId} inviter.userId ID
-   * @param {userName} inviter.userName 用户名
-   *
-   * @example
-   * const roomEngine = new TUIRoomEngine();
-   * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-   * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, (invitee, inviter) => {
-   *   console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
-   * });
-   */
+     * @description 邀请超时的监听事件
+     * @default 'onConnectionRequestTimeout'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestTimeout
+     * @param {object} option
+     * @param {TUILiveConnectionUser} option.inviter 连线邀请者
+     * @param {TUILiveConnectionUser} option.invitee 连线被邀请者
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, ({ invitee, inviter }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
+     * });
+     */
     onConnectionRequestTimeout = "onConnectionRequestTimeout"
 }
 
@@ -1948,6 +2064,7 @@ declare class TUIConferenceInvitationManager {
  * @class TUILiveListManager
  */
 declare class TUILiveListManager {
+    private roomEngineWASM;
     private liveListManagerWASM;
     private logger;
     private static liveListManager;
@@ -1956,6 +2073,10 @@ declare class TUILiveListManager {
         logger: Logger;
         roomEngineWASM: any;
     });
+    startLive(liveInfo: TUILiveInfo): Promise<TUILiveInfo>;
+    stopLive(): Promise<TUILiveStatisticsData>;
+    joinLive(roomId: string): Promise<TUILiveInfo>;
+    leaveLive(): Promise<void>;
     /**
      * 修改直播间信息
      *
@@ -1987,6 +2108,7 @@ declare class TUILiveListManager {
         coverUrl?: string;
         isPublicVisible?: boolean;
         backgroundUrl?: string;
+        seatLayoutTemplateId?: number;
     }): Promise<void>;
     /**
      * 获取直播间信息
@@ -2028,6 +2150,35 @@ declare class TUILiveListManager {
         cursor: string;
         count: number;
     }): Promise<TUILiveListResult>;
+    /**
+     * 进房前预览视频流
+     * @since 3.3.0
+     * @param options
+     * @param options.roomId 房间 Id
+     * @param options.isMuteAudio 是否静音预览
+     * @param options.view 播放视频流区域
+     */
+    startPreloadVideoStream(options: {
+        roomId: string;
+        isMuteAudio: boolean;
+        view: string;
+    }): Promise<void>;
+    /**
+     * 停止预览视频流
+     * @since 3.3.0
+     * @param options
+     * @param options.roomId 房间 Id
+     */
+    stopPreloadVideoStream(options: {
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * @private
+     * 调用 TUIRoomEngineWASM 的 CallAPI 方法
+     * @param funcName
+     * @param jsonString
+     */
+    private JSCallNativeCallAPIPromise;
     private JSCallNativeFunctionPromise;
     /**
      * 监听 TUILiveListManager 事件
@@ -2261,7 +2412,6 @@ declare class TUILiveConnectionManager {
     disconnect(): Promise<void>;
     private JSCallNativeFunctionPromise;
     private observerFunction;
-    private handleLiveConnectionEvent;
 }
 
 /**
@@ -3753,4 +3903,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-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, TUILiveConnectionManagerEvents, type TUILiveInfo, TUILiveLayoutManager, 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 };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, type TUIAutoPlayCallbackInfo, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, 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 TUISeatLayout, TUISeatLayoutTemplate, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };