zego-express-engine-electron-plugin-screen-capture

Dependencies

• Electron 5.0.8+
• this package depends on zego-express-engine-electron [3.0.1-25173]

Installation

npm install zego-express-engine-electron-plugin-electron

Quick Start

// import 
const zgScreenCapture = window.require('zego-express-engine-electron-plugin-screen-capture').ZegoExpressPluginScreenCaptureInstance;
const zgScreenCaptureWindowMode = window.require('zego-express-engine-electron-plugin-screen-capture').ZegoExpressPluginScreenCaptureWindowMode;

// init
zgScreenCapture.init()

// select a window as capture target
let windowList = zgScreenCapture.enumWindowList();
zgScreenCapture.setTargetWindow(windowList[0].handle);

// set capture params
zgScreenCapture.setTargetWindowMode(zgScreenCaptureWindowMode.ScreenCaptureWindowModeNormal);
zgScreenCapture.setFPS(5);

// start capture
zgScreenCapture.startCapture();

// publish video-data captured
zgEngine.enableCustomVideoCapture(true, 0);
zgScreenCapture.enablePublishVideo(true, 0);

// uninit
zgScreenCapture.uninit();

Resources

1. Doc Center - See more docs about zego-express-engine-electron
2. Demo - A quick start demo base on this repo
3. [Notice] The screen capture plugin 114 or later must be used with express-electron 3.0.1 or later; otherwise, exceptions may occur

ChangeLog

0.3.0-209

OPTIMISED:

• Optimize the internal window client area capture

0.3.0-207

ADD:

• windows supports the capture window client area, see ScreenCaptureWindowModeNormal3

0.3.0-205

FIX:

• fixed window collection issues in special scenarios

0.3.0-203

FIX:

• fixed occasional crashes in certain Windows

0.3.0-202

FIX:

• fix occasional crash issues and a window capture issue

0.3.0-116

FIX:

• fix an issue where the screen list could not be obtained from the quick plug monitor under mac

0.3.0-115

FIX:

• fixed some known window capture issues under windows 11

ADD:

• add enableEfficientCapture (only for windows platforms)

0.3.0-114

OPTIMISED:

• some internal optimizations were made, including the capture process

0.3.0-112

FIX:

• fix an issue with activation window foreground display not working on mac

0.3.0-111

ADD:

• add callback onScreenCaptureProcessWindowChanged(This callback is triggered when other Windows in the same process become active)

0.3.0-110

FIX:

• fix a memory leak when displaying the mouse(mac)

ADD:

• add enableExcludeSameProcessWindow(Support exclude same process window,only for windows platforms)

0.3.0-108

OPTIMISED:

• some internal optimizations were made

0.3.0-107

FIX:

• fix the problem of not receiving callback(onScreenCaptureWindowStatusChanged)

0.3.0-106

ADD:

• add setTargetWindowRect
• add getWindowRect

0.3.0

ADD:

• add onScreenCaptureWindowStatusChanged callback

FIX:

• fix the data of the thumbnail with padding

0.2.3

FIX:

• fix crash when using NodeJS 32

0.2.2

ADD:

• add getVersion function

FIX:

• fix enumWindowThumbanil for iconic window.

0.2.1

FIX:

• fix enumScreenThumbnail crash on window when screenID invalid

0.2.0

ADD:

• add enumWindowThumbnail function to get window thumbnail
• add enumScreenThumbnail function to get screen thumbnail

0.1.1

UPDATE:

• set default WindowCaptureMode as ScreenCaptureWindowModeNormal in setTargetWindow
• add exception catch mechanism for user's callback implementation

FIX:

• fix enumWindowList and enumScreenList on MacOS
• fix setScreenTarget when screenID is prefix on Windows

0.1.0

screen capture plugin created for zego-express-engine-electron