zego-express-engine-electron-plugin-blend-image-private 1.2.13 → 1.3.0

package/index.d.ts

@@ -12,13 +12,14 @@ declare const ZegoExpressPluginBlendImageLogLevel: {
 };
 declare const ZGCustomCaptureSourceType: {
     IMAGE_TYPE: number;
-    CAMERA_TYPE: number;
-    VIDEO_FILE_TYPE: number;
-    SCREEN_TYPE: number;
+    RTC_CAMERA: number;
+    RTC_VIDEO: number;
+    RTC_SCREEN: number;
+    RTC_WINDOW: number;
     IMAGE_GIF_TYPE: number;
     COMPLEX_TYPE: number;
-    WINDOW_TYPE: number;
     CUSTOM_DATA_TYPE: number;
+    TEXT_TYPE: number;
 };
 /**
  * ZegoExpressPluginCustomSourceLayer
@@ -68,168 +69,10 @@ declare const ZegoBlendImageViewMode: {
      */
     ScaleToFill: number;
 };
-/**
- * ZegoExpressPluginScreenCaptureWindowMode
- * @enum {number}
- */
-declare const ZegoExpressPluginScreenCaptureWindowMode: {
-    /**
-     * @description Capture the target window even when it's covered by other window.
-     */
-    ScreenCaptureWindowModeNormal: number;
-    /**
-     * @description After the target window is covered, the covered area uses content of the upper window.
-     */
-    ScreenCaptureWindowModeUseUpper: number;
-    /**
-     * @description Capture the whole screen of the window, compared with ScreenCaptureWindowModeNormal, there is no window switching process in this mode(only for windows).
-     */
-    ScreenCaptureWindowModeNormal2: number;
-};
-declare const ZegoExpressPluginScreenCaptureWindowStatus: {
-    /**
-     * @description the target window has no change.
-     */
-    ScreenCaptureWindowStatusNoChange: number;
-    /**
-     * @description the target window is destroyed.
-     */
-    ScreenCaptureWindowStatusDestroy: number;
-    /**
-     * @description the target window is maximized.
-     */
-    ScreenCaptureWindowStatusMaximize: number;
-    /**
-     * @description the target window is minimized.
-     */
-    ScreenCaptureWindowStatusMinimize: number;
-    /**
-     * @description the target window is actived.
-     */
-    ScreenCaptureWindowStatusActive: number;
-    /**
-     * @description the target window is deactived
-     */
-    ScreenCaptureWindowStatusDeactive: number;
-    /**
-     * @description the target window is is showed
-     */
-    ScreenCaptureWindowStatusShow: number;
-    /**
-     * @description the target window is hided
-     */
-    ScreenCaptureWindowStatusHide: number;
-    /**
-     * @description the target window is movded
-     */
-    ScreenCaptureWindowStatusMove: number;
-    /**
-     * @description the target window is covered
-     */
-    ScreenCaptureWindowStatusCover: number;
-    /**
-     * @description the target window is uncovered
-     */
-    ScreenCaptureWindowStatusUnCover: number;
-};
-/**
- * Screen item
- */
-interface IZegoExpressPluginScreenCaptureScreenItem {
-    /**
-     * identification for the screen
-     */
-    screenID: any;
-    /**
-     * is the primary screen
-     */
-    isPrimary: boolean;
-}
-/**
- * Window item
- */
-interface IZegoExpressPluginScreenCaptureWindowItem {
-    /**
-     * identification for the window
-     */
-    handle: any;
-    /**
-     * window title
-     */
-    title: string;
-    /**
-     * The path of process binary that the window corresponds to
-     * support only on windows
-     */
-    imagePath: string;
-}
-interface IZegoExpressPluginScreenCaptureThumbnailBitmap {
-    /**
-     * with
-     */
-    width: number;
-    /**
-     * height
-     */
-    height: number;
-    /**
-     * the base64 data of the image
-     * example: h5.img.setAttribute('src', "data:image/png;base64," + png)
-     */
-    png: any;
-}
-/**
- * Screen thumbnail item
- */
-interface IZegoExpressPluginScreenCaptureScreenThumbnailItem {
-    /**
-     * identification for the screen
-     */
-    screenID: any;
-    /**
-     * screen thumbnail
-     */
-    imageThumbnail: IZegoExpressPluginScreenCaptureThumbnailBitmap;
-}
-/**
- * Window thumbnail item
- */
-interface IZegoExpressPluginScreenCaptureWindowThumbnailItem {
-    /**
-     * identification for the window
-     */
-    handle: any;
-    /**
-     * window thumbnail
-     * could be null if sdk cannot get the imageThumnail from the system.
-     */
-    imageThumbnail: IZegoExpressPluginScreenCaptureThumbnailBitmap;
-    /**
-     * window icon thumbnail
-     */
-    iconThumbnail: IZegoExpressPluginScreenCaptureThumbnailBitmap;
-}
-/**
- * Rect
- *
- * (x,y)
- * ---------------
- * |             |
- * |             | height
- * |             |
- * ---------------
- *      width
- */
-interface IZegoExpressPluginScreenCaptureRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
 /**
  * IZegoExpressPluginErrorInfo
  *
- * @remark use by onScreenCaptureError(callback) and onLoadSourceParamError(callback)
+ * @remark use by onLoadSourceParamError(callback)
  *
  * @param error, error code
  * @param source, return by the function "createCustomCaptureSource()"
@@ -245,15 +88,6 @@ interface IZegoExpressPluginErrorInfo {
  * ZegoExpressPluginBlendImageEventHandler
  */
 interface ZegoExpressPluginBlendImageEventHandler {
-    /**
-     * onScreenCaptureError
-     *
-     * @remark this callback will trigger when capture error occurred, source always is zero
-     *
-     * @param {IZegoExpressPluginErrorInfo} errorInfo - the error struct
-     *
-     */
-    onScreenCaptureError: (errorInfo: IZegoExpressPluginErrorInfo) => void;
     /**
      * onLoadSourceParamError
      *
@@ -262,16 +96,6 @@ interface ZegoExpressPluginBlendImageEventHandler {
      * @param {IZegoExpressPluginErrorInfo} errorInfo - the error struct
      */
     onLoadSourceParamError: (errorInfo: IZegoExpressPluginErrorInfo) => void;
-    /**
-     * onScreenCaptureWindowStatusChanged
-     *
-     * @remark this callback will trigger when the status of the window captured changed
-     *
-     * @param {any} handle - identification for the window
-     * @param {ZegoExpressPluginScreenCaptureWindowStatus} windowStatus - the status of the window
-     * @param {IZegoExpressPluginScreenCaptureRect} windowRect - the rect of the window
-     */
-    onScreenCaptureWindowStatusChanged: (handle: any, windowStatus: number, windowRect: IZegoExpressPluginScreenCaptureRect) => void;
 }
 /**
  * ZegoExpressPluginBlendImage
@@ -304,39 +128,6 @@ declare class ZegoExpressPluginBlendImage extends EventEmitter {
      * Uninit screen capture.
      */
     uninit(): void;
-    /**
-     * Get screen list.
-     *
-     * @return {Array<IZegoExpressPluginScreenCaptureScreenItem>} - the screen list
-     */
-    enumScreenList(): Array<IZegoExpressPluginScreenCaptureScreenItem>;
-    /**
-     * Get screen thumbnail list.
-     *
-     * @return {Promise<Array<IZegoExpressPluginScreenCaptureScreenThumbnailItem>>} - the screen thumbnail list
-     */
-    enumScreenThumbnail(): Promise<Array<IZegoExpressPluginScreenCaptureScreenThumbnailItem>>;
-    /**
-     * Get window list.
-     *
-     * @param {boolean} isIncludeIconic - include the iconic window or not
-     *
-     * @return {Array<IZegoExpressPluginScreenCaptureWindowItem>} - the window list
-     */
-    enumWindowList(isIncludeIconic?: boolean): Array<IZegoExpressPluginScreenCaptureWindowItem>;
-    /**
-     * Get window thumbnail list.
-     *
-     * @return {Promise<Array<IZegoExpressPluginScreenCaptureWindowThumbnailItem>>} - the window thumbnail list
-     */
-    enumWindowThumbnail(): Promise<Array<IZegoExpressPluginScreenCaptureWindowThumbnailItem>>;
-    /**
-     * 检测窗口是否可以采集，若还未获取辅助功能权限，则调用该函数会申请辅助功能，Windows和Mac均可调用，只有Mac生效；
-     * @param {object} option - 参数对象
-     * @param {number} option.handle - 窗口句柄，目标窗口句柄，从接口enumWindowList 返回的对象数组列表中每项的handle字段
-     * @return {boolean} 是否可以采集该窗口
-     */
-    checkWindowSourceAuthorityPermission(handle: number): boolean;
     /**
      * 预览源数据，同一时间只允许预览一个源数据(变更源可以直接切换到其他源预览，不支持合图源)，如果需要预览时不合图，可以调用setCustomCaptureSourceVisible
      * @param {number} captureSrc
@@ -357,17 +148,6 @@ declare class ZegoExpressPluginBlendImage extends EventEmitter {
      * @return {number} -1 - 失败， 结果大于0 返回自定义采集源句柄
      */
     createCustomCaptureSource(captureType: number, dataPlugin?: any): number;
-    /**
-     * 设置窗口采集源的参数
-     * @param {object} option - 参数对象
-     * @param {number} option.captureSrc - 窗口采集源，填写通过createCustomCaptureSource接口创建返回的窗口采集源
-     * @param {boolean} option.activateWindowWhenCapturing - 在目标窗口模式下，初次选择窗口时，设置是否激活窗口，true - 激活窗口，false - 不激活窗口 (仅windows有效)
-     * @param {number} option.targetWindow - 设置采集目标窗口句柄，从接口enumWindowList 返回的对象数组列表中每项的handle字段
-     * @param {number} option.fps - 设置采集的帧率
-     * @param {number} option.targetWindowMode 1 - 窗口截屏，带窗口标题栏， 2 - 窗口客户区截屏，不带窗口标题栏，3 - 截取窗口对应屏幕区域 (窗口被覆盖后继续捕获对应区域). 4 - 截取窗口对应屏幕区域(窗口被覆盖后继续捕获，覆盖区域涂黑.  5 -截取窗口对应屏幕区域(窗口被覆盖后继续捕获，过滤上层覆盖的窗口，win8及以后系统生效)
-     *
-     */
-    setWindowCaptureSourceParam(captureSrc: number, activateWindowWhenCapturing?: boolean, targetWindow?: number, fps?: number, targetWindowMode?: number): boolean;
     /**
      *
      * @param captureSrc 自定义采集源对象
@@ -398,23 +178,6 @@ declare class ZegoExpressPluginBlendImage extends EventEmitter {
      * @return {boolean} true - 成功， false - 失败，输入的源无效
      */
     setImageGifCaptureSourceParam(captureSrc: number, imagePath: string): boolean;
-    /**
-     * 设置屏幕分享源的参数
-     * @param {object} option - 参数对象
-     * @param {number} option.captureSrc - 屏幕采集源，填写通过createCustomCaptureSource接口创建返回的屏幕采集源
-     * @param {string} option.targetScreen - 设置采集目标屏幕名，从接口enumScreenList 返回的对象数组列表中每项的screen_name字段
-     * @param {number} option.fps - 设置采集的帧率
-     * @param {boolean} option.fullScreen -设置采集主屏幕全屏，true - 采集全屏
-     * @param {boolean} option.virtualFullScreen - 设置采集虚拟桌面全屏，true - 采集虚拟全屏。在full_screen为false时有效
-     * @param {boolean} option.cursorVisible - 是否显示光标，true - 显示，false - 不显示
-     * @param {boolean} option.clickAnimation - 是否显示鼠标点击动画，true - 显示鼠标点击动画, false - 不显示鼠标点击动画
-     * @param {number} option.targetRectLeft - 设置采集目标区域，单位为像素，支持高DPI，目标区域左上角横坐标
-     * @param {number} option.targetRectTop - 目标区域左上角纵坐标
-     * @param {number} option.targetRectWidth - 目标区域宽
-     * @param {number} option.targetRectHeight - 目标区域高
-     *
-     */
-    setScreenCaptureSourceParam(captureSrc: number, targetScreen?: string, fps?: number, fullScreen?: boolean, virtualFullScreen?: boolean, cursorVisible?: boolean, clickAnimation?: boolean, targetRectLeft?: number, targetRectTop?: number, targetRectWidth?: number, targetRectHeight?: number): boolean;
     /**
     * 设置组合源输出大小
     * @param {object} option - 参数对象
@@ -518,4 +281,4 @@ declare class ZegoExpressPluginBlendImage extends EventEmitter {
     private callEmit;
 }
 declare const ZegoExpressPluginBlendImageInstance: ZegoExpressPluginBlendImage;
-export { ZegoExpressPluginBlendImageLogLevel, ZGCustomCaptureSourceType, ZegoExpressPluginCustomSourceLayer, ZegoBlendImageViewMode, ZegoExpressPluginScreenCaptureWindowMode, ZegoExpressPluginScreenCaptureWindowStatus, IZegoExpressPluginScreenCaptureRect, IZegoExpressPluginScreenCaptureScreenItem, IZegoExpressPluginScreenCaptureWindowItem, ZegoExpressPluginBlendImageEventHandler, ZegoExpressPluginBlendImageInstance };
+export { ZegoExpressPluginBlendImageLogLevel, ZGCustomCaptureSourceType, ZegoExpressPluginCustomSourceLayer, ZegoBlendImageViewMode, ZegoExpressPluginBlendImageEventHandler, ZegoExpressPluginBlendImageInstance };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZegoExpressPluginBlendImageInstance = exports.ZegoExpressPluginScreenCaptureWindowStatus = exports.ZegoExpressPluginScreenCaptureWindowMode = exports.ZegoBlendImageViewMode = exports.ZegoExpressPluginCustomSourceLayer = exports.ZGCustomCaptureSourceType = exports.ZegoExpressPluginBlendImageLogLevel = void 0;
+exports.ZegoExpressPluginBlendImageInstance = exports.ZegoBlendImageViewMode = exports.ZegoExpressPluginCustomSourceLayer = exports.ZGCustomCaptureSourceType = exports.ZegoExpressPluginBlendImageLogLevel = void 0;
 let os = require("os");
 let ZegoBlendImageNodeArch = "";
 if (os.platform() === "win32") {
@@ -31,13 +31,14 @@ const ZegoExpressPluginBlendImageLogLevel = {
 exports.ZegoExpressPluginBlendImageLogLevel = ZegoExpressPluginBlendImageLogLevel;
 const ZGCustomCaptureSourceType = {
     IMAGE_TYPE: 0,
-    CAMERA_TYPE: 1,
-    VIDEO_FILE_TYPE: 2,
-    SCREEN_TYPE: 3,
-    IMAGE_GIF_TYPE: 4,
-    COMPLEX_TYPE: 5,
-    WINDOW_TYPE: 6,
+    RTC_CAMERA: 1,
+    RTC_VIDEO: 2,
+    RTC_SCREEN: 3,
+    RTC_WINDOW: 4,
+    IMAGE_GIF_TYPE: 5,
+    COMPLEX_TYPE: 6,
     CUSTOM_DATA_TYPE: 7,
+    TEXT_TYPE: 8
 };
 exports.ZGCustomCaptureSourceType = ZGCustomCaptureSourceType;
 /**
@@ -90,72 +91,6 @@ const ZegoBlendImageViewMode = {
     ScaleToFill: 2,
 };
 exports.ZegoBlendImageViewMode = ZegoBlendImageViewMode;
-/**
- * ZegoExpressPluginScreenCaptureWindowMode
- * @enum {number}
- */
-const ZegoExpressPluginScreenCaptureWindowMode = {
-    /**
-     * @description Capture the target window even when it's covered by other window.
-     */
-    ScreenCaptureWindowModeNormal: 1,
-    /**
-     * @description After the target window is covered, the covered area uses content of the upper window.
-     */
-    ScreenCaptureWindowModeUseUpper: 2,
-    /**
-     * @description Capture the whole screen of the window, compared with ScreenCaptureWindowModeNormal, there is no window switching process in this mode(only for windows).
-     */
-    ScreenCaptureWindowModeNormal2: 3,
-};
-exports.ZegoExpressPluginScreenCaptureWindowMode = ZegoExpressPluginScreenCaptureWindowMode;
-const ZegoExpressPluginScreenCaptureWindowStatus = {
-    /**
-     * @description the target window has no change.
-     */
-    ScreenCaptureWindowStatusNoChange: 0,
-    /**
-     * @description the target window is destroyed.
-     */
-    ScreenCaptureWindowStatusDestroy: 1,
-    /**
-     * @description the target window is maximized.
-     */
-    ScreenCaptureWindowStatusMaximize: 2,
-    /**
-     * @description the target window is minimized.
-     */
-    ScreenCaptureWindowStatusMinimize: 3,
-    /**
-     * @description the target window is actived.
-     */
-    ScreenCaptureWindowStatusActive: 4,
-    /**
-     * @description the target window is deactived
-     */
-    ScreenCaptureWindowStatusDeactive: 5,
-    /**
-     * @description the target window is is showed
-     */
-    ScreenCaptureWindowStatusShow: 6,
-    /**
-     * @description the target window is hided
-     */
-    ScreenCaptureWindowStatusHide: 7,
-    /**
-     * @description the target window is movded
-     */
-    ScreenCaptureWindowStatusMove: 8,
-    /**
-     * @description the target window is covered
-     */
-    ScreenCaptureWindowStatusCover: 9,
-    /**
-     * @description the target window is uncovered
-     */
-    ScreenCaptureWindowStatusUnCover: 10,
-};
-exports.ZegoExpressPluginScreenCaptureWindowStatus = ZegoExpressPluginScreenCaptureWindowStatus;
 ;
 /**
  * ZegoExpressPluginBlendImage
@@ -204,49 +139,6 @@ class ZegoExpressPluginBlendImage extends EventEmitter {
         this.removeAllListeners();
         this._addonInstance.uninit({});
     }
-    /**
-     * Get screen list.
-     *
-     * @return {Array<IZegoExpressPluginScreenCaptureScreenItem>} - the screen list
-     */
-    enumScreenList() {
-        return this._addonInstance.enumScreenList({});
-    }
-    /**
-     * Get screen thumbnail list.
-     *
-     * @return {Promise<Array<IZegoExpressPluginScreenCaptureScreenThumbnailItem>>} - the screen thumbnail list
-     */
-    enumScreenThumbnail() {
-        return this._addonInstance.enumScreenThumbnail({});
-    }
-    /**
-     * Get window list.
-     *
-     * @param {boolean} isIncludeIconic - include the iconic window or not
-     *
-     * @return {Array<IZegoExpressPluginScreenCaptureWindowItem>} - the window list
-     */
-    enumWindowList(isIncludeIconic = true) {
-        return this._addonInstance.enumWindowList({ isIncludeIconic });
-    }
-    /**
-     * Get window thumbnail list.
-     *
-     * @return {Promise<Array<IZegoExpressPluginScreenCaptureWindowThumbnailItem>>} - the window thumbnail list
-     */
-    enumWindowThumbnail() {
-        return this._addonInstance.enumWindowThumbnail({});
-    }
-    /**
-     * 检测窗口是否可以采集，若还未获取辅助功能权限，则调用该函数会申请辅助功能，Windows和Mac均可调用，只有Mac生效；
-     * @param {object} option - 参数对象
-     * @param {number} option.handle - 窗口句柄，目标窗口句柄，从接口enumWindowList 返回的对象数组列表中每项的handle字段
-     * @return {boolean} 是否可以采集该窗口
-     */
-    checkWindowSourceAuthorityPermission(handle) {
-        return this._addonInstance.checkWindowSourceAuthorityPermission({ handle });
-    }
     /**
      * 预览源数据，同一时间只允许预览一个源数据(变更源可以直接切换到其他源预览，不支持合图源)，如果需要预览时不合图，可以调用setCustomCaptureSourceVisible
      * @param {number} captureSrc
@@ -287,19 +179,6 @@ class ZegoExpressPluginBlendImage extends EventEmitter {
     createCustomCaptureSource(captureType, dataPlugin = 0) {
         return this._addonInstance.createCustomCaptureSource({ captureType, dataPlugin });
     }
-    /**
-     * 设置窗口采集源的参数
-     * @param {object} option - 参数对象
-     * @param {number} option.captureSrc - 窗口采集源，填写通过createCustomCaptureSource接口创建返回的窗口采集源
-     * @param {boolean} option.activateWindowWhenCapturing - 在目标窗口模式下，初次选择窗口时，设置是否激活窗口，true - 激活窗口，false - 不激活窗口 (仅windows有效)
-     * @param {number} option.targetWindow - 设置采集目标窗口句柄，从接口enumWindowList 返回的对象数组列表中每项的handle字段
-     * @param {number} option.fps - 设置采集的帧率
-     * @param {number} option.targetWindowMode 1 - 窗口截屏，带窗口标题栏， 2 - 窗口客户区截屏，不带窗口标题栏，3 - 截取窗口对应屏幕区域 (窗口被覆盖后继续捕获对应区域). 4 - 截取窗口对应屏幕区域(窗口被覆盖后继续捕获，覆盖区域涂黑.  5 -截取窗口对应屏幕区域(窗口被覆盖后继续捕获，过滤上层覆盖的窗口，win8及以后系统生效)
-     *
-     */
-    setWindowCaptureSourceParam(captureSrc, activateWindowWhenCapturing = true, targetWindow = 0, fps = 10, targetWindowMode = 5) {
-        return this._addonInstance.setWindowCaptureSourceParam({ captureSrc, activateWindowWhenCapturing, targetWindow, fps, targetWindowMode });
-    }
     /**
      *
      * @param captureSrc 自定义采集源对象
@@ -338,35 +217,6 @@ class ZegoExpressPluginBlendImage extends EventEmitter {
     setImageGifCaptureSourceParam(captureSrc, imagePath) {
         return this._addonInstance.setImageGifCaptureSourceParam({ captureSrc, imagePath });
     }
-    /**
-     * 设置屏幕分享源的参数
-     * @param {object} option - 参数对象
-     * @param {number} option.captureSrc - 屏幕采集源，填写通过createCustomCaptureSource接口创建返回的屏幕采集源
-     * @param {string} option.targetScreen - 设置采集目标屏幕名，从接口enumScreenList 返回的对象数组列表中每项的screen_name字段
-     * @param {number} option.fps - 设置采集的帧率
-     * @param {boolean} option.fullScreen -设置采集主屏幕全屏，true - 采集全屏
-     * @param {boolean} option.virtualFullScreen - 设置采集虚拟桌面全屏，true - 采集虚拟全屏。在full_screen为false时有效
-     * @param {boolean} option.cursorVisible - 是否显示光标，true - 显示，false - 不显示
-     * @param {boolean} option.clickAnimation - 是否显示鼠标点击动画，true - 显示鼠标点击动画, false - 不显示鼠标点击动画
-     * @param {number} option.targetRectLeft - 设置采集目标区域，单位为像素，支持高DPI，目标区域左上角横坐标
-     * @param {number} option.targetRectTop - 目标区域左上角纵坐标
-     * @param {number} option.targetRectWidth - 目标区域宽
-     * @param {number} option.targetRectHeight - 目标区域高
-     *
-     */
-    setScreenCaptureSourceParam(captureSrc, targetScreen = "", fps = 10, fullScreen = true, virtualFullScreen = false, cursorVisible = true, clickAnimation = true, targetRectLeft = 0, targetRectTop = 0, targetRectWidth = 0, targetRectHeight = 0) {
-        return this._addonInstance.setScreenCaptureSourceParam({ captureSrc,
-            targetScreen,
-            fps,
-            fullScreen,
-            virtualFullScreen,
-            cursorVisible,
-            clickAnimation,
-            targetRectLeft,
-            targetRectTop,
-            targetRectWidth,
-            targetRectHeight });
-    }
     /**
     * 设置组合源输出大小
     * @param {object} option - 参数对象
@@ -515,7 +365,7 @@ class ZegoExpressPluginBlendImage extends EventEmitter {
                 }
             }
             else {
-                const highFrequencyCallbacks = ["onDebugError", "onScreenCaptureWindowStatusChanged"];
+                const highFrequencyCallbacks = ["onDebugError"];
                 if (!highFrequencyCallbacks.includes(arguments[0])) {
                     console.log(arguments[0], arguments[1]);
                 }