@ohos.screenshot (屏幕截图)


@ohos.screenshot (屏幕截图)

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

说明:

本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

该模块接口为系统接口。

导入模块

import screenshot from '@ohos.screenshot';
1

ScreenshotOptions

设置截取图像的信息。

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

名称 类型 必填 说明
screenRect Rect 表示截取图像的区域,不传值默认为全屏。
imageSize Size 表示截取图像的大小,不传值默认为全屏。
rotation number 表示截取图像的旋转角度,当前仅支持输入值为0,默认值为0。
displayId8+ number 表示截取图像的显示设备Display的ID号。

Rect

表示截取图像的区域。

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

名称 类型 必填 说明
left number 表示截取图像区域的左边界。
top number 表示截取图像区域的上边界。
width number 表示截取图像区域的宽度。
height number 表示截取图像区域的高度。

Size

表示截取图像的大小。

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

名称 类型 必填 说明
width number 表示截取图像的宽度。
height number 表示截取图像的高度。

screenshot.save

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

获取屏幕截图。

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

需要权限:ohos.permission.CAPTURE_SCREEN,仅系统应用可用。

参数:

参数名 类型 必填 说明
options ScreenshotOptions 该类型的参数包含screenRect、imageSize、rotation、displayId四个参数,可以分别设置这四个参数。
callback AsyncCallback<image.PixelMap> 回调函数。返回一个PixelMap对象。

示例:

let screenshotOptions = {
  "screenRect": {
      "left": 200,
      "top": 100,
      "width": 200,
      "height": 200},
  "imageSize": {
      "width": 300,
      "height": 300},
  "rotation": 0,
  "displayId": 0
};
try {
  screenshot.save(screenshotOptions, (err, pixelMap) => {
    if (err) {
        console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
    pixelMap.release(); // PixelMap使用完后及时释放内存
  });
} catch (exception) {
  console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

screenshot.save

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

获取屏幕截图。

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

需要权限:ohos.permission.CAPTURE_SCREEN,仅系统应用可用。

参数:

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

示例:

try {
  screenshot.save((err, pixelMap) => {
    if (err) {
        console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
    pixelMap.release(); // PixelMap使用完后及时释放内存
  });
} catch (exception) {
  console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
1
2
3
4
5
6
7
8
9
10
11
12

screenshot.save

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

获取屏幕截图。

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

需要权限:ohos.permission.CAPTURE_SCREEN,仅系统应用可用。

参数:

参数名 类型 必填 说明
options ScreenshotOptions 该类型的参数包含screenRect、imageSize、rotation、displayId四个参数,可以分别设置这四个参数。

返回值:

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

示例:

let screenshotOptions = {
	"screenRect": {
		"left": 200,
		"top": 100,
		"width": 200,
		"height": 200},
	"imageSize": {
		"width": 300,
		"height": 300},
	"rotation": 0,
	"displayId": 0
};
try {
  let promise = screenshot.save(screenshotOptions);
  promise.then((pixelMap) => {
      console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
      pixelMap.release(); // PixelMap使用完后及时释放内存
  }).catch((err) => {
      console.log('Failed to save screenshot. Code: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to save screenshot. Code: ' + JSON.stringify(exception));
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23