mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2025-04-17 20:50:34 +00:00
318 lines
11 KiB
TypeScript
318 lines
11 KiB
TypeScript
/*
|
|
* Copyright (c) 2022 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit ArkUI
|
|
*/
|
|
|
|
import { AsyncCallback, ErrorCallback } from './@ohos.base';
|
|
import image from './@ohos.multimedia.image';
|
|
|
|
/**
|
|
* Declares the screenshot APIs.
|
|
*
|
|
* @namespace screenshot
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
declare namespace screenshot {
|
|
/**
|
|
* Takes a screenshot and saves it as a PixelMap object.
|
|
*
|
|
* @permission ohos.permission.CAPTURE_SCREEN
|
|
* @param { ScreenshotOptions } options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
|
* @param { AsyncCallback<image.PixelMap> } callback Callback used to return a PixelMap object.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
|
* <br>2.Incorrect parameter types.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Takes a screenshot and saves it as a PixelMap object.
|
|
*
|
|
* @permission ohos.permission.CAPTURE_SCREEN
|
|
* @param { ScreenshotOptions } options - Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
|
* @param { AsyncCallback<image.PixelMap> } callback - Callback used to return a PixelMap object.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
|
* <br>2.Incorrect parameter types.
|
|
* @throws { BusinessError } 1400001 - Invalid display or screen.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 11
|
|
*/
|
|
function save(options: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>): void;
|
|
|
|
/**
|
|
* Takes a screenshot and saves it as a PixelMap object.
|
|
*
|
|
* @permission ohos.permission.CAPTURE_SCREEN
|
|
* @param { AsyncCallback<image.PixelMap> } callback Callback used to return a PixelMap object.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
function save(callback: AsyncCallback<image.PixelMap>): void;
|
|
|
|
/**
|
|
* Takes a screenshot and saves it as a PixelMap object.
|
|
*
|
|
* @permission ohos.permission.CAPTURE_SCREEN
|
|
* @param { ScreenshotOptions } options Screenshot options, which consist of screenRect, imageSize, and rotation. You need to set these parameters
|
|
* @returns { Promise<image.PixelMap> } Promise used to return a PixelMap object.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
|
* <br>2.Incorrect parameter types.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
function save(options?: ScreenshotOptions): Promise<image.PixelMap>;
|
|
|
|
/**
|
|
* Takes a capture and return as a PixelMap object.
|
|
*
|
|
* @permission ohos.permission.CUSTOM_SCREEN_CAPTURE
|
|
* @param { options } which consist of CaptureOption.
|
|
* @returns { Promise<image.PixelMap> } Promise used to return a PixelMap object.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
|
|
* 2.Incorrect parameter types.
|
|
* @throws { BusinessError } 801 - Capability not supported on this device.
|
|
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function capture(options?: CaptureOption): Promise<image.PixelMap>;
|
|
|
|
/**
|
|
* Takes a screenshot and picks it as a PickInfo object.
|
|
*
|
|
* @returns { Promise<PickInfo> } Promise used to return a PickInfo object.
|
|
* @throws { BusinessError } 801 - Capability not supported on this device.
|
|
* @throws { BusinessError } 1400003 - This display manager service works abnormally.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function pick(): Promise<PickInfo>;
|
|
|
|
/**
|
|
* Describes the region of the screen to pick info.
|
|
*
|
|
* @interface PickInfo
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
interface PickInfo {
|
|
/**
|
|
* the region of the screen to capture.
|
|
*
|
|
* @type { Rect }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
pickRect: Rect;
|
|
|
|
/**
|
|
* the region of the screen to capture pixelMap.
|
|
*
|
|
* @type { image.PixelMap }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
pixelMap: image.PixelMap;
|
|
}
|
|
|
|
/**
|
|
* Describes the region of the screen to capture.
|
|
*
|
|
* @interface Rect
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
interface Rect {
|
|
/**
|
|
* The X-axis coordinate of the upper left vertex of the rectangle.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
left: number;
|
|
|
|
/**
|
|
* The Y-axis coordinate of the upper left vertex of the rectangle.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
top: number;
|
|
|
|
/**
|
|
* Width of the rectangle.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
width: number;
|
|
|
|
/**
|
|
* Height of the rectangle.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
height: number;
|
|
}
|
|
|
|
/**
|
|
* Describes the size of the screen region to capture.
|
|
*
|
|
* @interface Size
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
interface Size {
|
|
/**
|
|
* Defines the width property.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
width: number;
|
|
|
|
/**
|
|
* Defines the height property.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
height: number;
|
|
}
|
|
|
|
/**
|
|
* Describes capture options.
|
|
*
|
|
* @interface CaptureOption
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
interface CaptureOption {
|
|
/**
|
|
* ID of the screen to be captured.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
displayId?: number;
|
|
}
|
|
|
|
/**
|
|
* Describes screenshot options.
|
|
*
|
|
* @interface ScreenshotOptions
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
interface ScreenshotOptions {
|
|
/**
|
|
* Region of the screen to capture. If this parameter is null, the full screen will be captured.
|
|
*
|
|
* @type { ?Rect }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
screenRect?: Rect;
|
|
/**
|
|
* Region of the screen to capture. If this parameter is null, the full screen will be captured.
|
|
*
|
|
* @type { ?Size }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
imageSize?: Size;
|
|
/**
|
|
* Rotation angle of the screenshot. The value can be 0, 90, 180, or 270. The default value is 0.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
rotation?: number;
|
|
/**
|
|
* ID of the screen to be captured.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
displayId?: number;
|
|
/**
|
|
* The capture action is need notification.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 14
|
|
*/
|
|
isNotificationNeeded?: boolean;
|
|
/**
|
|
* The capture action is need pointer.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 14
|
|
*/
|
|
isPointerNeeded?: boolean;
|
|
}
|
|
}
|
|
|
|
export default screenshot;
|