屏幕截圖
本模塊提供屏幕截圖的能力,截取屏幕時(shí)支持設(shè)置截取的區(qū)域、大小等圖像信息。
說明:
開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口,采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。該模塊接口為系統(tǒng)接口。
導(dǎo)入模塊
import screenshot from '@ohos.screenshot';
ScreenshotOptions
設(shè)置截取圖像的信息。
系統(tǒng)能力: SystemCapability.WindowManager.WindowManager.Core
參數(shù)名 | 類型 | 必填 | 說明 |
---|---|---|---|
screenRect | [Rect] | 否 | 表示截取圖像的區(qū)域,不傳值默認(rèn)為全屏。 |
imageSize | [Size] | 否 | 表示截取圖像的大小,不傳值默認(rèn)為全屏。 |
rotation | number | 否 | 表示截取圖像的旋轉(zhuǎn)角度,當(dāng)前僅支持輸入值為0,默認(rèn)值為0。 |
displayId8+ | number | 否 | 表示截取圖像的顯示設(shè)備[Display]的ID號(hào)。 |
Rect
表示截取圖像的區(qū)域。
系統(tǒng)能力: SystemCapability.WindowManager.WindowManager.Core
參數(shù)名 | 類型 | 必填 | 說明 |
---|---|---|---|
left | number | 是 | 表示截取圖像區(qū)域的左邊界。 |
top | number | 是 | 表示截取圖像區(qū)域的上邊界。 |
width | number | 是 | 表示截取圖像區(qū)域的寬度。 |
height | number | 是 | 表示截取圖像區(qū)域的高度。 |
Size
表示截取圖像的大小。
系統(tǒng)能力: SystemCapability.WindowManager.WindowManager.Core
參數(shù)名 | 類型 | 必填 | 說明 |
---|---|---|---|
width | number | 是 | 表示截取圖像的寬度。 |
height | number | 是 | 表示截取圖像的高度。 |
screenshot.save
save(options?: ScreenshotOptions, callback: AsyncCallback): void
獲取屏幕截圖。
系統(tǒng)能力: SystemCapability.WindowManager.WindowManager.Core
需要權(quán)限 :ohos.permission.CAPTURE_SCREEN,僅系統(tǒng)應(yīng)用可用。
參數(shù):
參數(shù)名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [ScreenshotOptions] | 否 | 該類型的參數(shù)包含screenRect,imageSize,rotation, displayId四個(gè)參數(shù),可以分別設(shè)置這四個(gè)參數(shù)。 |
callback | AsyncCallback | 是 | 回調(diào)函數(shù)。返回一個(gè)PixelMap對(duì)象。 |
示例:
var ScreenshotOptions = {
"screenRect": {
"left": 200,
"top": 100,
"width": 200,
"height": 200},
"imageSize": {
"width": 300,
"height": 300},
"rotation": 0,
"displayId": 0
};
screenshot.save(ScreenshotOptions, (err, data) = > {
if (err) {
console.error('Failed to save the screenshot. Error: ' + JSON.stringify(err));
return;
}
console.info('Screenshot saved. Data: ' + JSON.stringify(data));
});
screenshot.save
save(options?: ScreenshotOptions): Promise
獲取屏幕截圖。
系統(tǒng)能力: SystemCapability.WindowManager.WindowManager.Core
需要權(quán)限 :ohos.permission.CAPTURE_SCREEN,僅系統(tǒng)應(yīng)用可用。
參數(shù):
參數(shù)名 | 類型 | 必填 | 說明 |
---|---|---|---|
options | [ScreenshotOptions] | 否 | 該類型的參數(shù)包含screenRect、imageSize、rotation、displayId四個(gè)參數(shù),可以分別設(shè)置這四個(gè)參數(shù)。 |
返回值:
類型 | 說明HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿 |
---|---|
Promise | Promise對(duì)象。返回一個(gè)PixelMap對(duì)象。 |
示例:
var ScreenshotOptions = {
"screenRect": {
"left": 200,
"top": 100,
"width": 200,
"height": 200},
"imageSize": {
"width": 300,
"height": 300},
"rotation": 0,
"displayId": 0
};
let promise = screenshot.save(ScreenshotOptions);
promise.then(() = > {
console.log('screenshot save success');
}).catch((err) = > {
console.log('screenshot save fail: ' + JSON.stringify(err));
});
審核編輯 黃宇
-
接口
+關(guān)注
關(guān)注
33文章
8596瀏覽量
151145 -
圖形圖像
+關(guān)注
關(guān)注
0文章
6瀏覽量
981 -
鴻蒙
+關(guān)注
關(guān)注
57文章
2351瀏覽量
42849
發(fā)布評(píng)論請(qǐng)先 登錄
相關(guān)推薦
評(píng)論