📸 node-screenshots
node-screenshots is a native node.js screenshot library based on XCap, It supports Mac, Windows, and Linux systems without any dependencies. node-screenshots supports screenshot and video recording (to be implemented).
English | 简体ä¸æ–‡
Support Matrix
Operating System
| Operating System | node16 | node18 | node20 |
|---|---|---|---|
| Windows x64 | ✓ | ✓ | ✓ |
| Windows x32 | ✓ | ✓ | ✓ |
| Windows arm64 | ✓ | ✓ | ✓ |
| macOS x64 | ✓ | ✓ | ✓ |
| macOS arm64 | ✓ | ✓ | ✓ |
| Linux x64 gnu | ✓ | ✓ | ✓ |
| Linux x64 musl | ✓ | ✓ | ✓ |
Example
Monitor
const fs = require("fs");
const { Monitor } = require("node-screenshots");
let monitor = Monitor.fromPoint(100, 100);
console.log(monitor, monitor.id);
let image = monitor.captureImageSync();
fs.writeFileSync(`${monitor.id}-sync.png`, image.toPngSync());
monitor.captureImage().then((data) => {
console.log(data);
fs.writeFileSync(`${monitor.id}.jpeg`, data.toJpegSync());
});
let monitors = Monitor.all();
monitors.forEach((capturer) => {
console.log({
id: capturer.id,
x: capturer.x,
y: capturer.y,
width: capturer.width,
height: capturer.height,
rotation: capturer.rotation,
scaleFactor: capturer.scaleFactor,
isPrimary: capturer.isPrimary,
});
});Window
const fs = require("fs");
const { Window } = require("node-screenshots");
let windows = Window.all();
windows.forEach((item) => {
console.log({
id: item.id,
x: item.x,
y: item.y,
width: item.width,
height: item.height,
rotation: item.rotation,
scaleFactor: item.scaleFactor,
isPrimary: item.isPrimary,
});
let image = item.captureImageSync();
fs.writeFileSync(`${item.id}-sync.bmp`, image.toBmpSync());
item.captureImage().then(async (data) => {
console.log(data);
let newImage = await data.crop(10, 10, 10, 10);
fs.writeFileSync(`${item.id}.png`, await newImage.toPng());
});
});API
Full typeScript type definition: index.d.ts
Monitor
static all(): Array<Monitor>: Get all monitorstatic fromPoint(x: number, y: number): Monitor | null: Get a monitor from the specified coordinatescaptureImageSync(): Image: Synchronously capture imagecaptureImage(): Promise<Image>: Asynchronously capture image
Window
static all(): Array<Window>: Get all windowcaptureImageSync(): Image: Synchronously capture imagecaptureImage(): Promise<Image>: Asynchronously capture image
Image
cropSync(x: number, y: number, width: number, height: number): Image: Synchronously crop imagecrop(x: number, y: number, width: number, height: number): Promise<Image>: Asynchronously crop imagetoPngSync(copyOutputData?: boolean | undefined | null): Buffer:Synchronously Convert to pngtoPng(copyOutputData?: boolean | undefined | null): Promise<Buffer>: Asynchronously Convert to pngtoJpegSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to jpegtoJpeg(copyOutputData?: boolean | undefined | null): Promise<Buffer>: Asynchronously Convert to jpegtoBmpSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to bmptoBmp(copyOutputData?: boolean | undefined | null): Promise<Buffer>: Asynchronously Convert to bmptoRawSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to raw(RGBA data)toRaw(copyOutputData?: boolean | undefined | null): Promise<Buffer>: Asynchronously Convert to raw(RGBA data)
copyOutputData: pass related parameters in electron, otherwise electron will crash, nodejs does not pass or passes false, performance will be better, for more information refer to napi-rs/napi-rs#1346
Linux System Requirements
On Linux, you need to install libxcb, libxrandr, and dbus.
Debian / Ubuntu:
apt-get install libxcb1 libxrandr2 libdbus-1-3Alpine:
apk add libxcb libxrandr dbusRelated Repositories
- xcap - XCap is a cross-platform screen capture library written in Rust