@tencentcloud/tuiroom-engine-js 4.0.6-beta.2 → 4.0.6-beta.3

package/index.d.ts

@@ -1288,6 +1288,7 @@ type TUILiveInfo = {
     backgroundUrl: string;
     categoryList: Array<number>;
     activityStatus: number;
+    cloudRecordPolicy: TUICloudRecordPolicy;
     readonly roomOwner?: string;
     readonly ownerName?: string;
     readonly ownerAvatarUrl?: string;
@@ -1317,6 +1318,7 @@ type StartLiveOptions = {
     backgroundUrl?: string;
     categoryList?: Array<number>;
     activityStatus?: number;
+    cloudRecordPolicy?: TUICloudRecordPolicy;
 };
 /**
  * 直播连线用户信息
@@ -1342,6 +1344,7 @@ declare enum TUIConnectionCode {
 }
 type TUILiveModifyInfo = {
     roomId: string;
+    name?: string;
     isPublicVisible?: boolean;
     activityStatus?: number;
     coverUrl?: string;
@@ -1514,6 +1517,11 @@ declare enum TUILiveStatisticsModifyFlag {
     kTotalLikesReceived = 16,
     kTotalMessageCount = 32
 }
+declare enum TUICloudRecordPolicy {
+    kFollowConsoleConfig = 0,
+    kEnable = 1,
+    kDisable = 2
+}
 /**
  * @since v3.0.5
  * **TUILiveConnectionManager** 事件列表<br>
@@ -2639,6 +2647,7 @@ declare class TUILiveListManager {
      *
      * @param {object} options
      * @param {string} options.roomId 直播房间 ID
+     * @param {string} options.name 可选，直播间名称
      * @param {number} options.activityStatus 可选，直播间活跃状态: 用户自定义标记
      * @param {Array<number>} options.categoryList 可选，直播间分类标签，单个房间最大支持3个标记
      * @param {string} options.coverUrl 可选，直播间封面图片 HTTP URL 地址，最大支持 200 个字节
@@ -2651,6 +2660,7 @@ declare class TUILiveListManager {
      * const liveListManager = roomEngine.getLiveListManager();
      * liveListManager.setLiveInfo({
      *   roomId: "141569",
+     *   name: "My Live Room",
      *   coverUrl: "https://qcloudimg.tencent-cloud.cn/image/document/live-cover.png",
      *   isPublicVisible: false,
      *   activityStatus: 1,
@@ -2660,6 +2670,7 @@ declare class TUILiveListManager {
      */
     setLiveInfo(options: {
         roomId: string;
+        name?: string;
         activityStatus?: number;
         categoryList?: Array<number>;
         coverUrl?: string;
@@ -2963,6 +2974,26 @@ declare class TUILiveConnectionManager {
      * liveConnectionManager.disconnect();
      */
     disconnect(): Promise<void>;
+    /**
+     * 静音/取消静音连线房间
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @param {boolean} options.mute 是否静音, true: 静音, false: 取消静音
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = TUIRoomEngine.getInstance();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.muteConnection({
+     *   roomId: 'roomId',
+     *   mute: true
+     * });
+     */
+    muteConnection(options: {
+        roomId: string;
+        mute: boolean;
+    }): Promise<void>;
     private JSCallNativeFunctionPromise;
     /**
      * 监听 TUILiveConnectionManager 事件
@@ -4871,5 +4902,5 @@ declare class TUIRoomEngine {
     private onAutoPlayFailed;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, TUIBattleStoppedReason, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIConnectionCode, TUIDeviceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, TUILiveGiftManagerEvents, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, TUILiveModifyFlag, TUILiveStatisticsModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUIMoveSeatPolicy, TUINetworkQuality, TUIRenderMode, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIUserInfoModifyFlag, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, TUIBattleStoppedReason, TUICaptureSourceType, TUIChangeReason, TUICloudRecordPolicy, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIConnectionCode, TUIDeviceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, TUILiveGiftManagerEvents, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, TUILiveModifyFlag, TUILiveStatisticsModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUIMoveSeatPolicy, TUINetworkQuality, TUIRenderMode, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIUserInfoModifyFlag, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
 export type { GiftCategory, GiftInfo, StartLiveOptions, TUIAutoPlayCallbackInfo, TUIBattleConfig, TUIBattleInfo, TUIBattleUser, TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIGiftCategory, TUIGiftInfo, TUIInvitation, TUILiveConnectionUser, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILiveStatisticsData, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLayout, TUISeatLockParams, TUISeatRegion, TUIUserInfo, TUIVideoEncoderParams };