@ohos.screenshot (Screenshot)

The Screenshot module provides the screen capture capability.

NOTE

The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { screenshot } from '@kit.ArkUI';

Rect

Describes the region of the screen to capture.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Mandatory	Description
left	number	Yes	Left boundary of the screen region to capture, in px. The value must be an integer.
top	number	Yes	Top boundary of the screen region to capture, in px. The value must be an integer.
width	number	Yes	Width of the screen region to capture, in px. The value must be an integer.
height	number	Yes	Height of the screen region to capture, in px. The value must be an integer.

CaptureOption¹⁴⁺

Describes the capture options.

Atomic service API: This API can be used in atomic services since API version 14.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Mandatory	Description
displayId	number	No	ID of the display to capture. The default value is 0. The value must be an integer greater than or equal to 0. If a non-integer is passed, a parameter error is reported.

PickInfo

Describes the screenshot options.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.WindowManager.WindowManager.Core

Name	Type	Mandatory	Description
pickRect	Rect	Yes	Region of the screen to capture.
pixelMap	image.PixelMap	Yes	PixelMap object of the captured image.

screenshot.pick

pick(): Promise<PickInfo>

Takes a screenshot. This API can be used only on 2-in-1 devices.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.WindowManager.WindowManager.Core

Return value

Type	Description
Promise<PickInfo>	Promise used to return the PickInfo object.

Error codes

For details about the error codes, see Universal Error Codes and Display Error Codes.

ID	Error Message
801	Capability not supported on this device.
1400003	This display manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let promise = screenshot.pick();
  promise.then((pickInfo: screenshot.PickInfo) => {
    console.log('pick Pixel bytes number: ' + pickInfo.pixelMap.getPixelBytesNumber());
    console.log('pick Rect: ' + pickInfo.pickRect);
    pickInfo.pixelMap.release(); // Release the memory in time after the PixelMap is no longer needed.
  }).catch((err: BusinessError) => {
    console.log('Failed to pick. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to pick Code: ' + JSON.stringify(exception));
};

screenshot.capture¹⁴⁺

capture(options?: CaptureOption): Promise<image.PixelMap>

Takes a screenshot of the entire screen. This API can be used only on tablets and 2-in-1 devices.

Different from pick, this API can be used to capture a full-screen screenshot on the specified display

Atomic service API: This API can be used in atomic services since API version 14.

System capability: SystemCapability.WindowManager.WindowManager.Core

Required permissions: ohos.permission.CUSTOM_SCREEN_CAPTURE

Parameters

Name	Type	Mandatory	Description
options	CaptureOption	No	Capture options. The value can contain the display ID. If this parameter is left blank, the display with ID 0 is captured by default.

Return value

Type	Description
Promise<image.PixelMap>	Promise used to return a PixelMap object.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
201	Permission verification failed. The application does not have the permission required to call the API.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
801	Capability not supported on this device.
1400003	This display manager service works abnormally.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { image } from '@kit.ImageKit';

let captureOption: screenshot.CaptureOption = {
  "displayId": 0
};
try {
  let promise = screenshot.capture(captureOption);
  promise.then((pixelMap: image.PixelMap) => {
    console.log('Succeeded in saving screenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
    pixelMap.release(); // Release the memory in time after the PixelMap is used.
  }).catch((err: BusinessError) => {
    console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};