From 3c65805c50b308e9544ca457f9e9633f5e2a391f Mon Sep 17 00:00:00 2001 From: zhang-xiaobo1997 Date: Sun, 27 Feb 2022 15:31:36 +0800 Subject: [PATCH 1/2] modify for API8 Signed-off-by: zhang-xiaobo1997 --- .../kits/js/@ohos.multimedia.image.d.ts | 414 +++++++++++------- 1 file changed, 265 insertions(+), 149 deletions(-) diff --git a/interfaces/kits/js/@ohos.multimedia.image.d.ts b/interfaces/kits/js/@ohos.multimedia.image.d.ts index c231f17a4..bf594a3d8 100644 --- a/interfaces/kits/js/@ohos.multimedia.image.d.ts +++ b/interfaces/kits/js/@ohos.multimedia.image.d.ts @@ -18,7 +18,6 @@ import { AsyncCallback } from './basic'; /** * @name image * @since 6 - * @syscap SystemCapability.Multimedia.Image * @import import image from '@ohos.multimedia.image'; */ declare namespace image { @@ -26,12 +25,13 @@ declare namespace image { /** * Enumerates pixel map formats. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ enum PixelMapFormat { /** * Indicates an unknown format. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ UNKNOWN = 0, @@ -39,31 +39,37 @@ declare namespace image { * Indicates that each pixel is stored on 16 bits. Only the R, G, and B components are encoded * from the higher-order to the lower-order bits: red is stored with 5 bits of precision, * green is stored with 6 bits of precision, and blue is stored with 5 bits of precision. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ RGB_565 = 2, /** * Indicates that each pixel is stored on 32 bits. Components R, G, B, and A each occupies 8 bits * and are stored from the higher-order to the lower-order bits. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ RGBA_8888 = 3, } /** * Describes the size of an image. + * @since 6 + * @syscap SystemCapability.Multimedia.Image.Core */ interface Size { /** * Height * @since 6 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ height: number; /** * Width * @since 6 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ width: number; } @@ -71,47 +77,62 @@ declare namespace image { /** * Enumerates exchangeable image file format (Exif) information types of an image. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ enum PropertyKey { /** * Number of bits in each pixel of an image. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ BITS_PER_SAMPLE = "BitsPerSample", /** * Image rotation mode. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ ORIENTATION = "Orientation", /** * Image length. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ IMAGE_LENGTH = "ImageLength", /** * Image width. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ IMAGE_WIDTH = "ImageWidth", /** * GPS latitude. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ GPS_LATITUDE = "GPSLatitude", /** * GPS longitude. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ GPS_LONGITUDE = "GPSLongitude", /** * GPS latitude reference. For example, N indicates north latitude and S indicates south latitude. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ GPS_LATITUDE_REF = "GPSLatitudeRef", /** * GPS longitude reference. For example, E indicates east longitude and W indicates west longitude. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ GPS_LONGITUDE_REF = "GPSLongitudeRef" } @@ -119,128 +140,202 @@ declare namespace image { /** * Enum for image formats. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ enum ImageFormat { /** * YCBCR422 semi-planar format. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core */ YCBCR_422_SP = 1000, /** * JPEG encoding format. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core */ JPEG = 2000 } + /** + * Enumerates alpha types. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + enum AlphaType { + /** + * Indicates an unknown alpha type. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + UNKNOWN = 0, + + /** + * Indicates that the image has no alpha channel, or all pixels in the image are fully opaque. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + OPAQUE = 1, + + /** + * Indicates that RGB components of each pixel in the image are premultiplied by alpha. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + PREMUL = 2, + + /** + * Indicates that RGB components of each pixel in the image are independent of alpha and are not premultiplied by alpha. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + UNPREMUL = 3 + } + + /** + * Enum for image scale mode. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + enum ScaleMode { + /** + * Indicates the effect that scales an image to fill the target image area and center-crops the part outside the area. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + CENTER_CROP = 1, // Indicates the effect that scales an image to fill the target image area and center-crops the part outside the area. + + /** + * Indicates the effect that fits the image into the target size. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + FIT_TARGET_SIZE = 2, + } + /** * The componet type of image. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ enum ComponentType { /** * Luma info. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ YUV_Y = 1, /** * Chrominance info. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ YUV_U = 2, /** * Chroma info. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ YUV_V = 3, /** * Jpeg type. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ JPEG = 4, } /** * Describes region information. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core */ interface Region { /** * Image size. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ size: Size; /** * x-coordinate at the upper left corner of the image. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ x: number; /** * y-coordinate at the upper left corner of the image. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ y: number; } /** * Describes area information in an image. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ interface PositionArea { /** * Image data that will be read or written. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ pixels: ArrayBuffer; /** * Offset for data reading. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ offset: number; /** * Number of bytes to read. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ stride: number; /** * Region to read. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ region: Region; } /** * Describes image information. + * @since 6 + * @syscap SystemCapability.Multimedia.Image.Core */ interface ImageInfo { /** * Indicates image dimensions specified by a {@link Size} interface. - * @since 6 - * @syscap SystemCapability.Multimedia.Image + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core */ size: Size; } /** * Describes the option for image packing. + * @since 6 + * @syscap SystemCapability.Multimedia.Image.ImagePacker */ interface PackingOption { /** * Multipurpose Internet Mail Extensions (MIME) format of the target image, for example, image/jpeg. * @since 6 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImagePacker */ format: string; @@ -248,59 +343,63 @@ declare namespace image { * Quality of the target image. The value is an integer ranging from 0 to 100. A larger value indicates better * image quality but larger space occupied. * @since 6 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImagePacker */ quality: number; } /** * Describes image properties. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.ImageSource */ interface GetImagePropertyOptions { /** * Index of an image. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ index?: number; /** * Default property value. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ defaultValue?: string; } /** * Describes image decoding parameters. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.ImageSource */ interface DecodingOptions { /** * Number of image frames. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ index?: number; /** * Sampling ratio of the image pixel map. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ sampleSize?: number; /** * Rotation angle of the image pixel map. The value ranges from 0 to 360. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ rotate?: number; /** * Whether the image pixel map is editable. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ editable?: boolean; @@ -308,21 +407,21 @@ declare namespace image { * Width and height of the image pixel map. The value (0, 0) indicates that the pixels are decoded * based on the original image size. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ desiredSize?: Size; /** * Cropping region of the image pixel map. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ desiredRegion?: Region; /** * Data format of the image pixel map. * @since 7 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.ImageSource */ desiredPixelFormat?: PixelMapFormat; } @@ -330,42 +429,98 @@ declare namespace image { /** * Describes image color components. * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core */ interface Component { /** * Component type. * @since 8 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ readonly componentType: ComponentType; /** * Row stride. * @since 8 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ readonly rowStride: number; /** * Pixel stride. * @since 8 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ readonly pixelStride: number; /** * Component buffer. * @since 8 - * @syscap SystemCapability.Multimedia.Image + * @syscap SystemCapability.Multimedia.Image.Core */ readonly byteBuffer: ArrayBuffer; } + /** + * Initialization options for pixelmap. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + interface InitializationOptions { + /** + * PixelMap size. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + size: Size; + + /** + * PixelMap expected format. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + pixelFormat?: PixelMapFormat; + + /** + * Editable or not. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + editable?: boolean; + + /** + * PixelMap expected alpha type. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + alphaType: AlphaType; + + /** + * PixelMap expected scaling effect. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + scaleMode: ScaleMode; + } + + /** + * Create pixelmap by data buffer. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + function createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback): void; + + /** + * Create pixelmap by data buffer. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + function createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise; + /** * Creates an ImageSource instance based on the URI. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param uri Image source URI. * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. */ @@ -374,8 +529,7 @@ declare namespace image { /** * Creates an ImageSource instance based on the file descriptor. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param fd ID of a file descriptor. * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. */ @@ -384,8 +538,7 @@ declare namespace image { /** * Creates an ImagePacker instance. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @return Returns the ImagePacker instance if the operation is successful; returns null otherwise. */ function createImagePacker(): ImagePacker; @@ -393,8 +546,7 @@ declare namespace image { /** * Creates an ImageReceiver instance. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param width The default width in pixels of the Images that this receiver will produce. * @param height The default height in pixels of the Images that this receiver will produce. * @param format The format of the Image that this receiver will produce. This must be one of the @@ -404,12 +556,16 @@ declare namespace image { */ function createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver; + /** + * PixelMap instance. + * @since 7 + * @syscap SystemCapability.Multimedia.Image.Core + */ interface PixelMap { /** * Whether the image pixel map can be edited. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ readonly isEditable: boolean; @@ -417,8 +573,7 @@ declare namespace image { * Reads image pixel map data and writes the data to an ArrayBuffer. This method uses * a promise to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param dst A buffer to which the image pixel map data will be written. * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. */ @@ -428,8 +583,7 @@ declare namespace image { * Reads image pixel map data and writes the data to an ArrayBuffer. This method uses * a callback to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param dst A buffer to which the image pixel map data will be written. * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. */ @@ -438,8 +592,7 @@ declare namespace image { /** * Reads image pixel map data in an area. This method uses a promise to return the data read. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param area Area from which the image pixel map data will be read. * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. */ @@ -448,8 +601,7 @@ declare namespace image { /** * Reads image pixel map data in an area. This method uses a callback to return the data read. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param area Area from which the image pixel map data will be read. * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. */ @@ -459,8 +611,7 @@ declare namespace image { * Writes image pixel map data to the specified area. This method uses a promise to return * the operation result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param area Area to which the image pixel map data will be written. * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. */ @@ -470,8 +621,7 @@ declare namespace image { * Writes image pixel map data to the specified area. This method uses a callback to return * the operation result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param area Area to which the image pixel map data will be written. * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. */ @@ -481,8 +631,7 @@ declare namespace image { * Reads image data in an ArrayBuffer and writes the data to a PixelMap object. This method * uses a promise to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param src A buffer from which the image data will be read. * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. */ @@ -492,8 +641,7 @@ declare namespace image { * Reads image data in an ArrayBuffer and writes the data to a PixelMap object. This method * uses a callback to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param src A buffer from which the image data will be read. * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. */ @@ -502,8 +650,7 @@ declare namespace image { /** * Obtains pixel map information about this image. This method uses a promise to return the information. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @return A Promise instance used to return the image pixel map information. If the operation fails, an error message is returned. */ getImageInfo(): Promise; @@ -511,8 +658,7 @@ declare namespace image { /** * Obtains pixel map information about this image. This method uses a callback to return the information. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param callback Callback used to return the image pixel map information. If the operation fails, an error message is returned. */ getImageInfo(callback: AsyncCallback): void; @@ -520,8 +666,7 @@ declare namespace image { /** * Obtains the number of bytes in each line of the image pixel map. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @return Number of bytes in each line. */ getBytesNumberPerRow(): number; @@ -529,8 +674,7 @@ declare namespace image { /** * Obtains the total number of bytes of the image pixel map. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @return Total number of bytes. */ getPixelBytesNumber(): number; @@ -538,8 +682,7 @@ declare namespace image { /** * Releases this PixelMap object. This method uses a callback to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param callback Callback invoked for instance release. If the operation fails, an error message is returned. */ release(callback: AsyncCallback): void; @@ -547,20 +690,23 @@ declare namespace image { /** * Releases this PixelMap object. This method uses a promise to return the result. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @return A Promise instance used to return the instance release result. If the operation fails, an error message is returned. */ release(): Promise; } + /** + * ImageSource instance. + * @since 6 + * @syscap SystemCapability.Multimedia.Image.ImageSource + */ interface ImageSource { /** * Obtains information about an image with the specified sequence number and uses a callback * to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param index Sequence number of an image. * @param callback Callback used to return the image information. */ @@ -569,8 +715,7 @@ declare namespace image { /** * Obtains information about this image and uses a callback to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param callback Callback used to return the image information. */ getImageInfo(callback: AsyncCallback): void; @@ -578,8 +723,7 @@ declare namespace image { /** * Get image information from image source. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param index Sequence number of an image. If this parameter is not specified, the default value 0 is used. * @return A Promise instance used to return the image information. */ @@ -589,8 +733,7 @@ declare namespace image { * Creates a PixelMap object based on image decoding parameters. This method uses a promise to * return the object. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param options Image decoding parameters. * @return A Promise instance used to return the PixelMap object. */ @@ -599,8 +742,7 @@ declare namespace image { /** * Creates a PixelMap object. This method uses a callback to return the object. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param callback Callback used to return the PixelMap object. */ createPixelMap(callback: AsyncCallback): void; @@ -609,8 +751,7 @@ declare namespace image { * Creates a PixelMap object based on image decoding parameters. This method uses a callback to * return the object. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param options Image decoding parameters. * @param callback Callback used to return the PixelMap object. */ @@ -620,8 +761,7 @@ declare namespace image { * Obtains the value of a property in an image with the specified index. This method uses a * promise to return the property value in a string. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param key Name of the property whose value is to be obtained. * @param options Index of the image. * @return A Promise instance used to return the property value. If the operation fails, the default value is returned. @@ -632,8 +772,7 @@ declare namespace image { * Obtains the value of a property in this image. This method uses a callback to return the * property value in a string. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param key Name of the property whose value is to be obtained. * @param callback Callback used to return the property value. If the operation fails, an error message is returned. */ @@ -643,8 +782,7 @@ declare namespace image { * Obtains the value of a property in an image with the specified index. This method uses * a callback to return the property value in a string. * @since 7 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param key Name of the property whose value is to be obtained. * @param options Index of the image. * @param callback Callback used to return the property value. If the operation fails, the default value is returned. @@ -654,8 +792,7 @@ declare namespace image { /** * Releases an ImageSource instance and uses a callback to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @param callback Callback to return the operation result. */ release(callback: AsyncCallback): void; @@ -663,8 +800,7 @@ declare namespace image { /** * Releases an ImageSource instance and uses a promise to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource * @return A Promise instance used to return the operation result. */ release(): Promise; @@ -672,18 +808,21 @@ declare namespace image { /** * Supported image formats. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageSource */ readonly supportedFormats: Array; } + /** + * ImagePacker instance. + * @since 6 + * @syscap SystemCapability.Multimedia.Image.ImagePacker + */ interface ImagePacker { /** * Compresses or packs an image and uses a callback to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @param source Image to be processed. * @param option Option for image packing. * @param callback Callback used to return the packed data. @@ -693,8 +832,7 @@ declare namespace image { /** * Compresses or packs an image and uses a promise to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @param source Image to be processed. * @param option Option for image packing. * @return A Promise instance used to return the compressed or packed data. @@ -704,8 +842,7 @@ declare namespace image { /** * Compresses or packs an image and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @param source PixelMap to be processed. * @param option Option for image packing. * @param callback Callback used to return the packed data. @@ -715,8 +852,7 @@ declare namespace image { /** * Compresses or packs an image and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @param source PixelMap to be processed. * @param option Option for image packing. * @return A Promise instance used to return the compressed or packed data. @@ -726,8 +862,7 @@ declare namespace image { /** * Releases an ImagePacker instance and uses a callback to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @param callback Callback to return the operation result. */ release(callback: AsyncCallback): void; @@ -735,8 +870,7 @@ declare namespace image { /** * Releases an ImagePacker instance and uses a promise to return the result. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker * @return A Promise instance used to return the operation result. */ release(): Promise; @@ -744,8 +878,7 @@ declare namespace image { /** * Supported image formats. * @since 6 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImagePacker */ readonly supportedFormats: Array; } @@ -753,37 +886,34 @@ declare namespace image { /** * Provides basic image operations, including obtaining image information, and reading and writing image data. * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core */ interface Image { /** * Sets or gets the image area to crop, default is size. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ clipRect: Region; /** * Image size. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ readonly size: Size; /** * Image format. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core */ readonly format: number; /** * Get component buffer from image and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param componentType The componet type of image. * @param callback Callback used to return the component buffer. */ @@ -792,8 +922,7 @@ declare namespace image { /** * Get component buffer from image and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param componentType The componet type of image. * @return A Promise instance used to return the component buffer. */ @@ -802,8 +931,7 @@ declare namespace image { /** * Release current image to receive another and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @param callback Callback to return the operation result. */ release(callback: AsyncCallback): void; @@ -811,8 +939,7 @@ declare namespace image { /** * Release current image to receive another and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.Core * @return A Promise instance used to return the operation result. */ release(): Promise; @@ -821,29 +948,27 @@ declare namespace image { /** * Image receiver object. * @since 8 + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ interface ImageReceiver { /** * Image size. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ readonly size: Size; /** * Image capacity. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ readonly capacity: number; /** * Image format. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver */ readonly format: ImageFormat; @@ -851,8 +976,7 @@ declare namespace image { * get an id which indicates a surface and can be used to set to Camera or other component can receive a surface * and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param callback Callback used to return the surface id. */ getReceivingSurfaceId(callback: AsyncCallback): void; @@ -861,8 +985,7 @@ declare namespace image { * get an id which indicates a surface and can be used to set to Camera or other component can receive a surface * and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @return A Promise instance used to return the surface id. */ getReceivingSurfaceId(): Promise; @@ -870,8 +993,7 @@ declare namespace image { /** * Get lasted image from receiver and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param callback Callback used to return the latest image. */ readLatestImage(callback: AsyncCallback): void; @@ -879,8 +1001,7 @@ declare namespace image { /** * Get lasted image from receiver and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @return A Promise instance used to return the latest image. */ readLatestImage(): Promise; @@ -888,8 +1009,7 @@ declare namespace image { /** * Get next image from receiver and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param callback Callback used to return the next image. */ readNextImage(callback: AsyncCallback): void; @@ -897,8 +1017,7 @@ declare namespace image { /** * Get next image from receiver and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @return A Promise instance used to return the next image. */ readNextImage(): Promise; @@ -906,8 +1025,7 @@ declare namespace image { /** * Subscribe callback when receiving an image * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param type Callback used to return the next image. * @param callback Callback used to return image. */ @@ -916,8 +1034,7 @@ declare namespace image { /** * Release image receiver instance and uses a callback to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @param callback Callback to return the operation result. */ release(callback: AsyncCallback): void; @@ -925,8 +1042,7 @@ declare namespace image { /** * Release image receiver instance and uses a promise to return the result. * @since 8 - * @syscap SystemCapability.Multimedia.Image - * @import import image from '@ohos.multimedia.image' + * @syscap SystemCapability.Multimedia.Image.ImageReceiver * @return A Promise instance used to return the operation result. */ release(): Promise; -- Gitee From 02deea4982c8287c804d54437b66b0a396b5602e Mon Sep 17 00:00:00 2001 From: zhang-xiaobo1997 Date: Mon, 28 Feb 2022 16:25:59 +0800 Subject: [PATCH 2/2] modify since Signed-off-by: zhang-xiaobo1997 --- interfaces/kits/js/@ohos.multimedia.image.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/interfaces/kits/js/@ohos.multimedia.image.d.ts b/interfaces/kits/js/@ohos.multimedia.image.d.ts index bf594a3d8..5172224d0 100644 --- a/interfaces/kits/js/@ohos.multimedia.image.d.ts +++ b/interfaces/kits/js/@ohos.multimedia.image.d.ts @@ -320,7 +320,7 @@ declare namespace image { interface ImageInfo { /** * Indicates image dimensions specified by a {@link Size} interface. - * @since 7 + * @since 6 * @syscap SystemCapability.Multimedia.Image.Core */ size: Size; -- Gitee