node-screenshots

A native Node.js screenshots library for Mac, Windows, Linux

Screenshot
nashaofu/node-screenshotsnode-screenshots

README

📸 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).

Support Matrix


Operating System


Operatingnode16node18node20
----------------------------------
Windows✓✓✓
Windows✓✓✓
Windows✓✓✓
macOS✓✓✓
macOS✓✓✓
Linux✓✓✓
Linux✓✓✓

Example


Monitor


  1. ```ts
  2. const fs = require("fs");
  3. const { Monitor } = require("node-screenshots");

  5. let monitor = Monitor.fromPoint(100, 100);

  7. console.log(monitor, monitor.id);

  9. let image = monitor.captureImageSync();
  10. fs.writeFileSync(`${monitor.id}-sync.png`, image.toPngSync());

  12. monitor.captureImage().then((data) => {
  13.   console.log(data);
  14.   fs.writeFileSync(`${monitor.id}.jpeg`, data.toJpegSync());
  15. });

  17. let monitors = Monitor.all();

  19. monitors.forEach((capturer) => {
  20.   console.log({
  21.     id: capturer.id,
  22.     x: capturer.x,
  23.     y: capturer.y,
  24.     width: capturer.width,
  25.     height: capturer.height,
  26.     rotation: capturer.rotation,
  27.     scaleFactor: capturer.scaleFactor,
  28.     isPrimary: capturer.isPrimary,
  29.   });
  30. });
  31. ```

Window


  1. ```ts
  2. const fs = require("fs");
  3. const { Window } = require("node-screenshots");

  5. let windows = Window.all();

  7. windows.forEach((item) => {
  8.   console.log({
  9.     id: item.id,
  10.     x: item.x,
  11.     y: item.y,
  12.     width: item.width,
  13.     height: item.height,
  14.     rotation: item.rotation,
  15.     scaleFactor: item.scaleFactor,
  16.     isPrimary: item.isPrimary,
  17.   });

  19.   let image = item.captureImageSync();
  20.   fs.writeFileSync(`${item.id}-sync.bmp`, image.toBmpSync());

  22.   item.captureImage().then(async (data) => {
  23.     console.log(data);
  24.     let newImage = await data.crop(10, 10, 10, 10);
  25.     fs.writeFileSync(`${item.id}.png`, await newImage.toPng());
  26.   });
  27. });
  28. ```

API


Full typeScript type definition: index.d.ts

Monitor


- `static all(): Array`: Get all monitor
- static fromPoint(x: number, y: number): Monitor | null: Get a monitor from the specified coordinates
- captureImageSync(): Image: Synchronously capture image
- `captureImage(): Promise`: Asynchronously capture image

Window


- `static all(): Array`: Get all window
- captureImageSync(): Image: Synchronously capture image
- `captureImage(): Promise`: Asynchronously capture image

Image


- cropSync(x: number, y: number, width: number, height: number): Image: Synchronously crop image
- `crop(x: number, y: number, width: number, height: number): Promise`: Asynchronously crop image
- toPngSync(copyOutputData?: boolean | undefined | null): Buffer:Synchronously Convert to png
- `toPng(copyOutputData?: boolean | undefined | null): Promise`: Asynchronously Convert to png
- toJpegSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to jpeg
- `toJpeg(copyOutputData?: boolean | undefined | null): Promise`: Asynchronously Convert to jpeg
- toBmpSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to bmp
- `toBmp(copyOutputData?: boolean | undefined | null): Promise`: Asynchronously Convert to bmp
- toRawSync(copyOutputData?: boolean | undefined | null): Buffer: Synchronously Convert to raw(RGBA data)
- `toRaw(copyOutputData?: boolean | undefined | null): Promise`: 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 https://github.com/napi-rs/napi-rs/issues/1346

Linux System Requirements


On Linux, you need to install libxcb, libxrandr, and dbus.

Debian / Ubuntu:

  1. ```sh
  2. apt-get install libxcb1 libxrandr2 libdbus-1-3
  3. ```

Alpine:

  1. ```sh
  2. apk add libxcb libxrandr dbus
  3. ```