@tencentcloud/tuiroom-engine-electron 3.0.0 → 3.0.6-beta.1

package/index.d.ts

@@ -1186,11 +1186,11 @@ declare enum TUILiveLayoutManagerEvents {
      * const roomEngine = new TUIRoomEngine();
      * const liveLayoutManager = roomEngine.getLiveLayoutManager();
      * const callback = (roomId, layoutInfo) => {
-     *   console.log('liveLayoutManager.onLiveVideoLayoutListChanged', roomId, layoutInfo);
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
      * };
-     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutListChanged, callback);
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
-    onLiveVideoLayoutListChanged = "onLiveVideoLayoutListChanged"
+    onLiveVideoLayoutChanged = "onLiveVideoLayoutChanged"
 }
 
 declare class Logger {
@@ -1894,6 +1894,102 @@ declare class TUILiveListManager {
     private handleLiveInfoChangeEvent;
 }
 
+/**
+ * 直播自定义布局插件
+ * @class TUILiveLayoutManager
+ */
+declare class TUILiveLayoutManager {
+    private liveLayoutManagerWASM;
+    private logger;
+    private static liveLayoutManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    private observerFunction;
+    private handleLiveLayoutChangeEvent;
+    private JSCallNativeFunctionPromise;
+    /**
+     * 监听 TUILiveLayoutManager 事件
+     * @param {TUILiveLayoutManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, layoutInfo) => {
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
+     * };
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    on(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消 TUILiveLayoutManager 事件监听
+     * @param {TUILiveLayoutManagerEvents} event 事件名
+     * @param {Function} func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, layoutInfo) => {
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
+     * };
+     * liveLayoutManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    off(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 设置自定义布局信息
+     *
+     * @param {string} roomId 直播房间 ID
+     * @param {string} layoutInfo 自定义布局信息, 格式为 JSON 字符串
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * liveLayoutManager.setLiveStreamLayoutInfo('roomId', '{
+     *   // 设置画布大小
+     *   "VideoEncode": {
+     *     "Width": 1920,
+     *     "Height": 1080,
+     *   },
+     *   "LayoutMode": 0, // 0~9 内置布局模板， 1000自定义布局， 只有1000时候才能修改LayoutInfo,目前只支持 0 和 1000
+     *   // 设置画面布局
+     *   "LayoutInfo": {
+     *     "LayoutList": [
+     *       {
+     *         "LocationX": 0,                   // 以画面左上角为原点的 x 坐标
+     *         "LocationY": 0,                   // 以画面左上角为原点的 y 坐标
+     *         "ImageWidth": 1920,               // 调整后的画面宽度
+     *         "ImageHeight": 1080,              // 调整后的画面高度
+     *         "ZOrder": 0,                      // 画面层级
+     *         "StreamType": 0,                  // 0 摄像头, 1 屏幕共享, 2 白板, 3 自定义
+     *         "Member_Account": "admin001",     // 该路流的用户ID
+     *         "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>;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -1908,6 +2004,7 @@ declare class TUIRoomEngine {
     private conferenceListManager;
     private conferenceInvitationManager;
     private liveListManager;
+    private liveLayoutManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -3236,6 +3333,17 @@ declare class TUIRoomEngine {
      * const liveListManager = roomEngine.getLiveListManager();
      */
     getLiveListManager(): TUILiveListManager;
+    /**
+     * v3.0.0 版本起支持 getLiveLayoutManager 获取 TUILiveLayoutManager 模块
+     *
+     * @since v3.0.0
+     * @returns {TUILiveLayoutManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     */
+    getLiveLayoutManager(): TUILiveLayoutManager;
     /**
      * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
      * @since v2.6.0
@@ -3278,4 +3386,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, 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, 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, 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, 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 };