harmony 鸿蒙@ohos.screenshot (屏幕截图)(系统接口)

2025-06-12
浏览 (6)

@ohos.screenshot (屏幕截图)(系统接口)

本模块提供屏幕截图的能力，截取屏幕时支持设置截取的区域、大小等图像信息。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.screenshot。

导入模块

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

ScreenshotOptions

设置截取图像的信息。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	必填	说明
screenRect	Rect	否	表示截取图像的区域，不传值默认返回displayId所在逻辑屏的区域。
imageSize	Size	否	表示截取图像的大小，不传值默认为displayId所在逻辑屏的大小。若screenRect小于imageSize，图像会拉伸至imageSize，反之则压缩至imageSize的大小。
rotation	number	否	表示截取图像后要旋转的角度，当前仅支持输入值为0，默认值为0。
displayId⁸⁺	number	否	表示截取图像的显示设备Display的ID号，该参数应为整数。
isNotificationNeeded¹⁴⁺	boolean	否	表示截取图像之后是否发送截屏通知，true表示发送截屏通知，false表示不发送截屏通知，默认值为true。截屏通知可以通过captureStatusChange接口监听。
isCaptureFullOfScreen¹⁹⁺	boolean	否	表示是否截取当前Screen上的所有display。对于一个Screen上有多个display的场景，为true表示截取整个Screen，false则只截取displayId所在逻辑屏的区域，默认值为false。

Size

表示截取图像的大小。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

名称	类型	必填	说明
width	number	是	表示截取图像的宽度，单位为px，该参数应为整数。
height	number	是	表示截取图像的高度，单位为px，该参数应为整数。

screenshot.save

save(options: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>): void

获取屏幕截图。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。

参数：

参数名	类型	必填	说明
options	ScreenshotOptions	是	要截取的图像信息。
callback	AsyncCallback<image.PixelMap>	是	回调函数。返回一个PixelMap对象，其大小为指定的imageSize大小，若未指定默认为displayId所在逻辑屏的大小。

错误码：

以下错误码的详细介绍请参见通用错误码和屏幕错误码。

错误码ID	错误信息
201	Permission verification failed.
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
1400001	Invalid display or screen.

示例：

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

let screenshotOptions: screenshot.ScreenshotOptions = {
  "screenRect": {
    "left": 200,
    "top": 100,
    "width": 200,
    "height": 200 },
  "imageSize": {
    "width": 300,
    "height": 300 },
  "rotation": 0,
  "displayId": 0,
  "isNotificationNeeded": true,
  "isCaptureFullOfScreen": true
};
screenshot.save(screenshotOptions, (err: BusinessError, pixelMap: image.PixelMap) => {
  if (err) {
    console.error('Failed to save screenshot. Code: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in saving screenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // PixelMap使用完后及时释放内存
});

screenshot.save

save(callback: AsyncCallback<image.PixelMap>): void

获取屏幕截图。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。

参数：

参数名	类型	必填	说明
callback	AsyncCallback<image.PixelMap>	是	回调函数。返回一个PixelMap对象。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission verification failed.
202	Permission verification failed. A non-system application calls a system API.

示例：

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

screenshot.save((err: BusinessError, pixelMap: image.PixelMap) => {
  if (err) {
    console.error('Failed to save screenshot. Code: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in saving screenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // PixelMap使用完后及时释放内存
});

screenshot.save

save(options?: ScreenshotOptions): Promise<image.PixelMap>

获取屏幕截图。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限：ohos.permission.CAPTURE_SCREEN，仅系统应用可用。

参数：

参数名	类型	必填	说明
options	ScreenshotOptions	否	要截取的图像信息。

返回值：

类型	说明
Promise<image.PixelMap>	Promise对象。返回一个PixelMap对象。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
201	Permission verification failed.
202	Permission verification failed. A non-system application calls a system API.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

示例：

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

let screenshotOptions: screenshot.ScreenshotOptions = {
  "screenRect": {
    "left": 200,
    "top": 100,
    "width": 200,
    "height": 200 },
  "imageSize": {
    "width": 300,
    "height": 300 },
  "rotation": 0,
  "displayId": 0,
  "isNotificationNeeded": true,
  "isCaptureFullOfScreen": true
};
try {
  let promise = screenshot.save(screenshotOptions);
  promise.then((pixelMap: image.PixelMap) => {
    console.log('Succeeded in saving screenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
    pixelMap.release(); // PixelMap使用完后及时释放内存
  }).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));
};