zego-express-engine-electron-plugin-blend-image-private 1.2.8

package/index.d.ts

@@ -0,0 +1,521 @@
+declare const EventEmitter: any;
+/**
+ * ZegoExpressPluginBlendImageLogLevel
+ * @enum {number}
+ */
+declare const ZegoExpressPluginBlendImageLogLevel: {
+    LogLevelGrievous: number;
+    LogLevelError: number;
+    LogLevelWarning: number;
+    LogLevelGeneric: number;
+    LogLevelDebug: number;
+};
+declare const ZGCustomCaptureSourceType: {
+    IMAGE_TYPE: number;
+    CAMERA_TYPE: number;
+    VIDEO_FILE_TYPE: number;
+    SCREEN_TYPE: number;
+    IMAGE_GIF_TYPE: number;
+    COMPLEX_TYPE: number;
+    WINDOW_TYPE: number;
+    CUSTOM_DATA_TYPE: number;
+};
+/**
+ * ZegoExpressPluginCustomSourceLayer
+ * @enum {number}
+ */
+declare const ZegoExpressPluginCustomSourceLayer: {
+    /**
+     * @description reverse all layer.
+     */
+    CustomSourceReverseLayer: number;
+    /**
+     * @description let source keep toplayer.
+     */
+    CustomSourceTopLayer: number;
+    /**
+     * @description let source move to uplayer.
+     */
+    CustomSourceUpLayer: number;
+    /**
+     * @description let source move to downlayer.
+     */
+    CustomSourceDownLayer: number;
+    /**
+     * @description let source keep bottomlayer.
+     */
+    CustomSourceBottomLayer: number;
+};
+/**
+ * Video rendering fill mode.
+ * 视图填充模式
+ * @enum {number}
+ */
+declare const ZegoBlendImageViewMode: {
+    /**
+     * @description The proportional scaling up, there may be black borders
+     * @description 等比缩放，可能有黑边
+     */
+    AspectFit: number;
+    /**
+     * @description The proportional zoom fills the entire View and may be partially cut
+     * @description 等比缩放填充整View，可能有部分被裁减
+     */
+    AspectFill: number;
+    /**
+     * @description Fill the entire view, the image may be stretched
+     * @description 填充整个View，会产生拉伸
+     */
+    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)
+ *
+ * @param error, error code
+ * @param source, return by the function "createCustomCaptureSource()"
+ * @param errorMsg, the description of error
+ *
+ */
+interface IZegoExpressPluginErrorInfo {
+    error: number;
+    source: number;
+    errorMsg: string;
+}
+/**
+ * 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
+     *
+     * @remark this callback will trigger when setparam error occurred
+     *
+     * @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
+ */
+declare class ZegoExpressPluginBlendImage extends EventEmitter {
+    private _addonInstance;
+    constructor();
+    /**
+     * register callback for the specific event.
+     */
+    on<K extends keyof ZegoExpressPluginBlendImageEventHandler>(event: K, callBack: ZegoExpressPluginBlendImageEventHandler[K]): boolean;
+    /**
+     * unregister callback for the specific event.
+     */
+    off<K extends keyof ZegoExpressPluginBlendImageEventHandler>(event: K, callBack: ZegoExpressPluginBlendImageEventHandler[K]): void;
+    /**
+     * Gets the SDK's version number.
+     *
+     * @return {string} - SDK version
+     */
+    getVersion(): any;
+    /**
+     * Init screen capture.
+     *
+     * @remarks
+     * call this function before you call any other function
+     */
+    init(): void;
+    /**
+     * 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
+     * @param {Object} canvas
+     * @param {number} viewMode
+     * @param {number} backgroundColor
+     */
+    startPreviewSource(captureSrc: number, canvas: Object, viewMode: number, backgroundColor: number): void;
+    /**
+     *
+     */
+    stopPreviewSource(captureSrc: number): void;
+    /**
+     * 创建自定义采集源，在初始化sdk成功之后调用
+     * @param {object} option - 参数对象
+     * @param {number} option.captureType - 自定义采集源的类型，支持自定义图片、摄像头(来自express插件)、视频文件(来自express插件)、屏幕分享，查看定义 <a href="./ZegoConstant.js.html" target="_blank">ZEGOCONSTANTS.ZGCustomCaptureSourceType</a>
+     * @param {number} option.dataPlugin - 摄像头、视频文件需要使用express的插件
+     * @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 自定义采集源对象
+     * @param dataPlugin 外部实现的采集源插件指针，需要继承实现即构的ZegoCustomVideoCapturePluginBase
+     * @returns
+     */
+    setCustomDataSourceParam(captureSrc: number, dataPlugin: number): boolean;
+    /**
+     *
+     * @param captureSrc 摄像头源对象
+     * @param effectPlugin 外部实现的美颜插件指针，使用前咨询请使用方式
+     * @returns
+     */
+    setCameraCaptureSourceParam(captureSrc: number, effectPlugin: number): boolean;
+    /**
+     * 配置图像源参数，可用于切换图片，更新图片路径即可
+     * @param {object} option - 参数对象
+     * @param {number} option.captureSrc - 采集源，填写通过createCustomCaptureSource接口创建返回的图像源
+     * @param {string} option.imagePath - 图像路径，图像支持bmp图像 todo
+     * @return {boolean} true - 成功， false - 失败，输入的源无效
+     */
+    setImageCaptureSourceParam(captureSrc: number, imagePath: string): boolean;
+    /**
+     * 配置GIF图像源参数，可用于切换GIF图片，更新图片路径即可
+     * @param {object} option - 参数对象
+     * @param {number} option.captureSrc - 采集源，填写通过createCustomCaptureSource接口创建返回的图像源
+     * @param {string} option.imagePath - GIF图像路径，图像支持GIF图像
+     * @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 - 参数对象
+    * @param {number} option.combinedSourceID - 组合源
+    * @param {number} option.width - 组合源输出的宽
+    * @param {number} option.height - 组合源输出的高
+    * @param {number} option.fps - 组合源输出的帧率
+    * @return {boolean} true - 成功， false - 失败
+    */
+    setCombinedSourceParam(combinedSourceID: number, width: number, height: number, fps: number): boolean;
+    /**
+    * 设置组合源的背景色
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 混合源的id
+    * @param {number} option.rgba - 混合源的背景色0x FF(R) 00(G) 00(B) FF(A)，背景支持Alpha通道，需要配合Express Electron接口进行传输设置（无特殊需要不要配置alpha通道），默认0x000000FF(黑色)
+    * @return {boolean} true - 成功， false - 失败
+    */
+    setCombinedBackgroundColor(combinedSourceID: number, rgba: number): boolean;
+    /**
+    * 向组合源添加采集源
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 组合源的id
+    * @param {number} option.customCaptureSourceID - 采集源对象
+    * @return {boolean} true - 成功， false - 失败
+    */
+    addCustomCaptureSource(combinedSourceID: number, customCaptureSourceID: number): boolean;
+    /**
+    * 删除组合源中的采集源
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 组合源的id
+    * @param {number} option.customCaptureSourceID - 采集源对象id
+    * @return {boolean} true - 成功， false - 失败
+    */
+    delCustomCaptureSource(combinedSourceID: number, customCaptureSourceID: number): boolean;
+    /**
+    * 设置组合源中指定采集源的平面Z轴顺序
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 组合源的id
+    * @param {number} option.customCaptureSourceID - 采集源对象id
+    * @param {number} option.zOrder - 采集源的平面Z轴顺序，请填写ZegoExpressPluginCustomSourceLayer类型，
+    *                 如果该参数为CustomSourceReverseLayer，则不会判断customCaptureSourceID参数
+    * @param {number} option.zOrderNum - 采集源的平面Z轴顺序为CustomSourceUpLayer或CustomSourceDownLayer类型时移动的层数，默认为1
+    * @return {boolean} true - 成功， false - 失败
+    */
+    setCustomCaptureSourceZOrder(combinedSourceID: number, customCaptureSourceID: number, zOrder: number, zOrderNum?: number): boolean;
+    /**
+    * 设置组合源中指定采集源是否可见
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 组合源的id
+    * @param {number} option.customCaptureSourceID - 采集源的id
+    * @param {boolean} option.visible - 混合源是否可见 todo
+    * @return {boolean} true - 成功， false - 失败
+    */
+    setCustomCaptureSourceVisible(combinedSourceID: number, customCaptureSourceID: number, visible: boolean): boolean;
+    /**
+    * 设置组合源中指定采集源的布局
+    * @param {object} option - 参数对象
+    * @param {number} option.combinedSourceID - 组合源的id
+    * @param {number} option.customCaptureSourceID - 采集源的id
+    * @param {number} option.x - 采集源相对于画布左上角的x
+    * @param {number} option.y - 采集源相对于画布左上角的y
+    * @param {number} option.w - 采集源的宽
+    * @param {number} option.h - 采集源的高
+    * @param {number} option.viewMode - 见ZegoBlendImageViewMode
+    * @return {boolean} true - 成功， false - 失败
+    */
+    setCustomCaptureSourceLayout(combinedSourceID: number, customCaptureSourceID: number, x: number, y: number, w: number, h: number, viewMode?: number): boolean;
+    /**
+     * 翻转自定义采集源
+     * @param {object} option - 参数对象
+     * @param {number} option.captureSrc - 采集源，填写通过createCustomCaptureSource接口创建返回的采集源
+     * @param {number} option.enableFlipX - 水平方向是否翻转
+     * @param {number} option.enableFlipY - 垂直方向是否翻转
+     * @return {boolean} true - 成功， false - 失败，输入的源无效
+     */
+    flipCustomCaptureSource(captureSrc: number, enableFlipX: number, enableFlipY: number): boolean;
+    /**
+     * 旋转自定义采集源
+     * @param {object} option - 参数对象
+     * @param {number} option.captureSrc - 采集源，填写通过createCustomCaptureSource接口创建返回的采集源
+     * @param {number} option.rotationMode- 旋转模式，支持 0-不旋转，90-顺时针旋转90度，180-旋转180度， 270-旋转270度，-90-逆时针旋转90度，等同于旋转270度
+     * @return {boolean} true - 成功， false - 失败，输入的源无效，或者不支持的角度
+     */
+    rotationCustomCaptureSource(captureSrc: number, rotationMode: number): boolean;
+    /**
+     * 裁剪采集源
+     * @param captureSrc  - 采集源，填写通过createCustomCaptureSource接口创建返回的采集源
+     * @param cropX - 裁剪的x轴起点
+     * @param cropY - 裁剪的y轴起点
+     * @param cropWidth - 裁剪的宽度
+     * @param cropHeight - 裁剪的高度
+     * @returns
+     */
+    cropCustomCaptureSource(captureSrc: number, cropX: number, cropY: number, cropWidth: number, cropHeight: number): boolean;
+    /**
+     * Get the capture Plugin.todo
+     *
+     * @return {number}
+     */
+    getExpressCustomVideoCapturePlugin(): number;
+    private callEmit;
+}
+declare const ZegoExpressPluginBlendImageInstance: ZegoExpressPluginBlendImage;
+export { ZegoExpressPluginBlendImageLogLevel, ZGCustomCaptureSourceType, ZegoExpressPluginCustomSourceLayer, ZegoBlendImageViewMode, ZegoExpressPluginScreenCaptureWindowMode, ZegoExpressPluginScreenCaptureWindowStatus, IZegoExpressPluginScreenCaptureRect, IZegoExpressPluginScreenCaptureScreenItem, IZegoExpressPluginScreenCaptureWindowItem, ZegoExpressPluginBlendImageEventHandler, ZegoExpressPluginBlendImageInstance };