@tencentcloud/tuiroom-engine-js 3.2.1 → 3.2.2

package/dist/src/modules/liveLayoutManager.d.ts

@@ -0,0 +1,98 @@
+import { TUILiveLayoutManagerEvents } from '../types';
+import Logger from '../utils/logger';
+/**
+ * 直播自定义布局插件
+ * @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": 1080,               // 调整后的画面宽度
+     *         "ImageHeight": 960,               // 调整后的画面高度
+     *         "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>;
+}
+export default TUILiveLayoutManager;

package/dist/src/modules/liveListManager.d.ts

@@ -0,0 +1,120 @@
+import { TUILiveInfo, TUILiveListResult, TUILiveListManagerEvents } from '../types';
+import Logger from '../utils/logger';
+/**
+ * 直播列表
+ * @class TUILiveListManager
+ */
+declare class TUILiveListManager {
+    private liveListManagerWASM;
+    private logger;
+    private static liveListManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    /**
+     * 修改直播间信息
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @param {number} options.activityStatus 可选，直播间活跃状态: 用户自定义标记
+     * @param {Array<number>} options.categoryList 可选，直播间分类标签，单个房间最大支持3个标记
+     * @param {string} options.coverUrl 可选，直播间封面图片 HTTP URL 地址，最大支持 200 个字节
+     * @param {string} options.backgroundUrl 可选，直播间背景图片 HTTP URL 地址，最大支持 200 个字节
+     * @param {boolean} options.isPublicVisible 可选，直播间是否公开
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * liveListManager.setLiveInfo({
+     *   roomId: "141569",
+     *   coverUrl: "https://qcloudimg.tencent-cloud.cn/image/document/live-cover.png",
+     *   isPublicVisible: false,
+     *   activityStatus: 1,
+     *   categoryList: [1,2,3],
+     *   backgroundUrl: "https://qcloudimg.tencent-cloud.cn/image/document/live-cover.png"
+     * });
+     */
+    setLiveInfo(options: {
+        roomId: string;
+        activityStatus?: number;
+        categoryList?: Array<number>;
+        coverUrl?: string;
+        isPublicVisible?: boolean;
+        backgroundUrl?: string;
+    }): Promise<void>;
+    /**
+     * 获取直播间信息
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @returns {Promise<TUILiveInfo>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const result = await liveListManager.getLiveInfo({ roomId: "141569" });
+     */
+    getLiveInfo(options: {
+        roomId: string;
+    }): Promise<TUILiveInfo>;
+    /**
+     * 获取直播间列表
+     *
+     * @param {object} options
+     * @param {string} options.cursor 分页获取索引，第一次拉取填 ''，返回的数据中 cursor 不为 ''，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的cursor为 ''，表示数据已经全部拉取。
+     * @param {number} options.count  本次拉取数量
+     * @returns {Promise<TUILiveListResult>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const liveList = [];
+     * let cursor = '';
+     * let count = 20;
+     * let result;
+     * do {
+     *   result = await liveListManager.fetchLiveList({ cursor, count });
+     *   liveList.push(...result.liveInfoList);
+     *   cursor = result.cursor;
+     * } while(cursor !== '');
+     */
+    fetchLiveList(options: {
+        cursor: string;
+        count: number;
+    }): Promise<TUILiveListResult>;
+    private JSCallNativeFunctionPromise;
+    /**
+     * 监听 TUILiveListManager 事件
+     * @param {TUILiveListManagerEvents} event - 事件名
+     * @param {Function} func - 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const callback = ({ liveModifyInfo }) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
+     * };
+     * liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, callback);
+     */
+    on(event: TUILiveListManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消 TUILiveListManager 事件监听
+     * @param {TUILiveListManagerEvents} event - 事件名
+     * @param {Function} func - 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const callback = ({ liveModifyInfo }) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
+     * };
+     * liveListManager.off(TUILiveListManagerEvents.onLiveInfoChanged, callback);
+     */
+    off(event: TUILiveListManagerEvents, func: (...args: any[]) => void): void;
+    private observerFunction;
+    private handleLiveInfoChangeEvent;
+}
+export default TUILiveListManager;