# 图片处理 > **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 ``` import image from '@ohos.multimedia.image'; ``` ## image.createPixelMap8+ createPixelMap(colors: ArrayBuffer, options: InitializetionOptions): Promise\ 通过属性创建PixelMap，通过Promise返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ | | colors | ArrayBuffer | 是 | 颜色数组。 | | options | [InitializetionOptions](#initializationoptions8) | 是 | 创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。 | **返回值：** | 类型 | 说明 | | -------------------------------- | -------------- | | Promise\<[PixelMap](#pixelmap7)> | 返回Pixelmap。 | **示例：** ```js image.createPixelMap(Color, opts) .then((pixelmap) => { }) ``` ## image.createPixelMap8+ createPixelMap(colors: ArrayBuffer, options: InitializetionOptions, callback: AsyncCallback\): void 通过属性创建PixelMap，通过回调函数返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------ | ---- | -------------------------- | | colors | ArrayBuffer | 是 | 颜色数组。 | | options | [InitializetionOptions](#initializationoptions8) | 是 | 属性。 | | callback | AsyncCallback\<[PixelMap](#pixelmap7)> | 是 | 通过回调返回PixelMap对象。 | **示例：** ```js image.createPixelMap(Color, opts, (pixelmap) => { }) ``` ## PixelMap7+ 图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。 ### 属性 **系统能力： ** SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ----------------------- | ------- | ---- | ---- | -------------------------- | | isEditable7+ | boolean | 是 | 否 | 设定是否图像像素可被编辑。 | ### readPixelsToBuffer7+ readPixelsToBuffer(dst: ArrayBuffer): Promise\ 读取图像像素数据，结果写入ArrayBuffer里，使用Promise形式返回。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------- | ---- | ------------------------------------------------------------ | | dst | ArrayBuffer | 是 | 缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。 | **返回值：** | 类型 | 说明 | | :------------- | :---------------------------------------------- | | Promise\ | Promise实例，用于获取结果，失败时返回错误信息。 | **示例：** ```js pixelmap.readPixelsToBuffer(readBuffer).then(() => { //符合条件则进入 }).catch(error => { //不符合条件则进入 }) ``` ### readPixelsToBuffer7+ readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\): void 读取图像像素数据，结果写入ArrayBuffer里，使用callback形式返回。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------------------------------ | | dst | ArrayBuffer | 是 | 缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。 | | callback | AsyncCallback\ | 是 | 获取回调，失败时返回错误信息。 | **示例：** ```js pixelmap.readPixelsToBuffer(readBuffer, () => { }) ``` ### readPixels7+ readPixels(area: PositionArea): Promise\ 读取区域内的图片数据，使用Promise形式返回读取结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------ | ---- | ------------------------ | | area | [PositionArea](#positionarea7) | 是 | 区域大小，根据区域读取。 | **返回值：** | 类型 | 说明 | | :------------- | :-------------------------------------------------- | | Promise\ | Promise实例，用于获取读取结果，失败时返回错误信息。 | **示例：** ```js pixelmap.readPixels(area).then((data) => { //符合条件则进入 }).catch(error => { //不符合条件则进入 }) ``` ### readPixels7+ readPixels(area: PositionArea, callback: AsyncCallback\): void 读取区域内的图片数据，使用callback形式返回读取结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------ | ---- | ------------------------------ | | area | [PositionArea](#positionarea7) | 是 | 区域大小，根据区域读取。 | | callback | AsyncCallback\ | 是 | 获取回调，失败时返回错误信息。 | **示例：** ```js let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts, (err, pixelmap) => { if(pixelmap == undefined){ console.info('createPixelMap failed'); expect(false).assertTrue(); done(); }else{ const area = { pixels: new ArrayBuffer(8), offset: 0, stride: 8, region: { size: { height: 1, width: 2 }, x: 0, y: 0 }} pixelmap.readPixels(area, () => { console.info('readPixels success'); }) } }) ``` ### writePixels7+ writePixels(area: PositionArea): Promise\ 将PixelMap写入指定区域内，使用Promise形式返回写入结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------ | ---- | -------------------- | | area | [PositionArea](#positionarea7) | 是 | 区域，根据区域写入。 | **返回值：** | 类型 | 说明 | | :------------- | :-------------------------------------------------- | | Promise\ | Promise实例，用于获取写入结果，失败时返回错误信息。 | **示例：** ```js const color = new ArrayBuffer(96); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } image.createPixelMap(color, opts) .then( pixelmap => { if (pixelmap == undefined) { console.info('createPixelMap failed'); expect(false).assertTrue() done(); } const area = { pixels: new ArrayBuffer(8), offset: 0, stride: 8, region: { size: { height: 1, width: 2 }, x: 0, y: 0 } } var bufferArr = new Uint8Array(area.pixels); for (var i = 0; i < bufferArr.length; i++) { bufferArr[i] = i + 1; } pixelmap.writePixels(area).then(() => { const readArea = { pixels: new ArrayBuffer(8), offset: 0, stride: 8, // region.size.width + x < opts.width, region.size.height + y < opts.height region: { size: { height: 1, width: 2 }, x: 0, y: 0 } } }) }) .catch(error => { console.log('error: ' + error); expect().assertFail(); done(); }) ``` ### writePixels7+ writePixels(area: PositionArea, callback: AsyncCallback\): void 将PixelMap写入指定区域内，使用callback形式返回写入结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------------ | ---- | ------------------------------ | | area | [PositionArea](#positionarea7) | 是 | 区域，根据区域写入。 | | callback: | AsyncCallback\ | 是 | 获取回调，失败时返回错误信息。 | **示例：** ```js pixelmap.writePixels(area, () => { const readArea = { pixels: new ArrayBuffer(20), offset: 0, stride: 8, region: { size: { height: 1, width: 2 }, x: 0, y: 0 }, } }) ``` ### writeBufferToPixels7+ writeBufferToPixels(src: ArrayBuffer): Promise\ 读取缓冲区中的图片数据，结果写入PixelMap中，使用Promise形式返回。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ----------- | ---- | -------------- | | src | ArrayBuffer | 是 | 图像像素数据。 | **返回值：** | 类型 | 说明 | | -------------- | ----------------------------------------------- | | Promise\ | Promise实例，用于获取结果，失败时返回错误信息。 | **示例：** ```js pixelMap.writeBufferToPixels(colorBuffer).then(() => { console.log("Succeeded in writing data from a buffer to a PixelMap."); }).catch((err) => { console.error("Failed to write data from a buffer to a PixelMap."); }); ``` ### writeBufferToPixels7+ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\): void 读取缓冲区中的图片数据，结果写入PixelMap中，使用callback形式返回。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | | src | ArrayBuffer | 是 | 图像像素数据。 | | callback | AsyncCallback\ | 是 | 获取回调，失败时返回错误信息。 | **示例：** ```js pixelMap.writeBufferToPixels(colorBuffer, function(err) { if (err) { console.error("Failed to write data from a buffer to a PixelMap."); return; } console.log("Succeeded in writing data from a buffer to a PixelMap."); }); ``` ### getImageInfo7+ getImageInfo(): Promise\ 获取图像像素信息，使用Promise形式返回获取的图像像素信息。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | --------------------------------- | ----------------------------------------------------------- | | Promise\<[ImageInfo](#imageinfo)> | Promise实例，用于异步获取图像像素信息，失败时返回错误信息。 | **示例：** ```js pixelMap.getImageInfo().then(function(info) { console.log("Succeeded in obtaining the image pixel map information."); }).catch((err) => { console.error("Failed to obtain the image pixel map information."); }); ``` ### getImageInfo7+ getImageInfo(callback: AsyncCallback\): void 获取图像像素信息，使用callback形式返回获取的图像像素信息。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | callback | AsyncCallback\<[ImageInfo](#imageinfo)> | 是 | 获取图像像素信息回调，异步返回图像像素信息，失败时返回错误信息。 | **示例:** ```js pixelmap.getImageInfo((imageInfo) => {}) ``` ### getBytesNumberPerRow7+ getBytesNumberPerRow(): number 获取图像像素每行字节数。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | ------ | -------------------- | | number | 图像像素的行字节数。 | **示例：** ```js rowCount = pixelmap.getBytesNumberPerRow() ``` ### getPixelBytesNumber7+ getPixelBytesNumber(): number 获取图像像素的总字节数。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | ------ | -------------------- | | number | 图像像素的总字节数。 | **示例：** ```js pixelBytesNumber = pixelmap.getPixelBytesNumber() ``` ### release7+ release():Promise\ 释放PixelMap对象，使用Promise形式返回释放结果。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | -------------- | ------------------ | | Promise\ | 异步返回释放结果。 | **示例：** ```js pixelmap.release().then(() => { }) .catch(error => {}) ``` ### release7+ release(callback: AsyncCallback\): void 释放PixelMap对象，使用callback形式返回释放结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------ | | callback | AsyncCallback\ | 是 | 异步返回释放结果。 | **示例：** ```js pixelmap.release(()=>{ }) ``` ## image.createImageSource createImageSource(uri: string): ImageSource 通过传入的uri创建图片源实例。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------------- | | uri | string | 是 | 图片路径，当前仅支持本地绝对路径。 | **返回值：** | 类型 | 说明 | | --------------------------- | -------------------------------------------- | | [ImageSource](#imagesource) | 返回ImageSource类实例，失败时返回undefined。 | **示例：** ```js const imageSourceApi = image.createImageSource('/data/local/tmp/test.jpg') ``` ## image.createImageSource7+ createImageSource(fd: number): ImageSource 通过传入文件描述符来创建图片源实例。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------------- | | fd | number | 是 | 文件描述符fd。 | **返回值：** | 类型 | 说明 | | --------------------------- | -------------------------------------------- | | [ImageSource](#imagesource) | 返回ImageSource类实例，失败时返回undefined。 | **示例：** ```js const imageSourceApi = image.createImageSource(0) ``` ## ImageSource 图片源类，用于获取图片相关信息。在调用ImageSource的方法前，需要先通过createImageSource构建一个ImageSource实例。 ### 属性 **系统能力： ** SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | | supportedFormats | Array\ | 是 | 否 | 支持的图片格式，包括：png，jpeg，wbmp，bmp，gif，webp，heif等。 | ### getImageInfo getImageInfo(index: number, callback: AsyncCallback\): void 获取指定序号的图片信息，使用callback形式返回图片信息。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ---------------------------------------- | | index | number | 是 | 创建图片源时的序号。 | | callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 | **示例：** ```js imageSourceApi.getImageInfo(0,(error, imageInfo) => {}) ``` ### getImageInfo getImageInfo(callback: AsyncCallback\): void 获取图片信息，使用callback形式返回图片信息。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------------------------- | ---- | ---------------------------------------- | | callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 | **示例：** ```js imageSourceApi.getImageInfo(imageInfo => {}) ``` ### getImageInfo getImageInfo(index?: number): Promise\ 获取图片信息，使用Promise形式返回图片信息。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | ------------------------------------- | | index | number | 否 | 创建图片源时的序号，不选择时默认为0。 | **返回值：** | 类型 | 说明 | | -------------------------------- | ---------------------- | | Promise<[ImageInfo](#imageinfo)> | 返回获取到的图片信息。 | **示例：** ```js imageSourceApi.getImageInfo(0) .then(imageInfo => {}) .catch(error => {}) ``` ### getImageProperty7+ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\ 获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------------------- | ---- | ------------------------------------ | | key | string | 是 | 图片属性名。 | | options | [GetImagePropertyOptions](#getimagepropertyoptions7) | 否 | 图片属性，包括图片序号与默认属性值。 | **返回值：** | 类型 | 说明 | | ---------------- | ------------------------------------------------------------ | | Promise\ | Promise实例，用于异步获取图片属性值，如获取失败则返回属性默认值。 | **示例：** ```js imageSourceApi.getImageProperty("BitsPerSample") .then(data => {}) .catch(error => {}) ``` ### getImageProperty7+ getImageProperty(key:string, callback: AsyncCallback\): void 获取图片中给定索引处图像的指定属性键的值，用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | | key | string | 是 | 图片属性名。 | | callback | AsyncCallback\ | 是 | 获取图片属性回调，返回图片属性值，如获取失败则返回属性默认值。 | **示例：** ```js imageSourceApi.getImageProperty("BitsPerSample",(error,data) => {}) ``` ### getImageProperty7+ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback\): void 获取图片指定属性键的值，callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | | key | string | 是 | 图片属性名。 | | options | [GetImagePropertyOptions](#getimagepropertyoptions7) | 是 | 图片属性，包括图片序号与默认属性值。 | | callback | AsyncCallback\ | 是 | 获取图片属性回调，返回图片属性值，如获取失败则返回属性默认值。 | **示例：** ```js imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => {}) ``` ### createPixelMap7+ createPixelMap(options?: DecodingOptions): Promise\ 通过图片解码参数创建PixelMap对象。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | ------- | ------------------------------------ | ---- | ---------- | | options | [DecodingOptions](#decodingoptions7) | 否 | 解码参数。 | **返回值：** | 类型 | 说明 | | -------------------------------- | --------------------- | | Promise\<[PixelMap](#pixelmap7)> | 异步返回Promise对象。 | **示例：** ```js imageSourceApi.createPixelMap().then(pixelmap => {}) .catch(error => {}) ``` ### createPixelMap7+ createPixelMap(callback: AsyncCallback\): void 通过默认参数创建PixelMap对象，使用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | -------------------------- | | callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是 | 通过回调返回PixelMap对象。 | **示例：** ```js imageSourceApi.createPixelMap(pixelmap => {}) ``` ### createPixelMap7+ createPixelMap(options: DecodingOptions, callback: AsyncCallback\): void 通过图片解码参数创建PixelMap对象。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | -------------------------- | | options | [DecodingOptions](#decodingoptions7) | 是 | 解码参数。 | | callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是 | 通过回调返回PixelMap对象。 | **示例：** ```js imageSourceApi.createPixelMap(decodingOptions, pixelmap => {}) ``` ### release release(callback: AsyncCallback\): void 释放图片源实例，使用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------------- | | callback | AsyncCallback\ | 是 | 资源释放回调，失败时返回错误信息。 | **示例：** ```js imageSourceApi.release(() => {}) ``` ### release release(): Promise\ 释放图片源实例，使用Promise形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | -------------- | --------------------------- | | Promise\ | Promise实例，异步返回结果。 | **示例：** ```js imageSourceApi.release().then(()=>{ }).catch(error => {}) ``` ## image.createImagePacker createImagePacker(): ImagePacker 创建ImagePacker实例。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | --------------------------- | --------------------- | | [ImagePacker](#imagepacker) | 返回ImagePacker实例。 | **示例：** ```js const imagePackerApi = image.createImagePacker(); ``` ## ImagePacker 图片打包器类，用于图片压缩和打包。在调用ImagePacker的方法前，需要先通过createImagePacker构建一个ImagePacker实例。 ### 属性 **系统能力： ** SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------- | -------------- | ---- | ---- | -------------------------- | | supportedFormats | Array\ | 是 | 否 | 图片打包支持的格式，jpeg。 | ### packing packing(source: ImageSource, option: PackingOption, callback: AsyncCallback>): void 图片压缩或重新打包，使用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------- | ---- | ---------------------------------- | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | callback | AsyncCallback> | 是 | 获取图片打包回调，返回打包后数据。 | **示例：** ```js let packOpts = { format:["image/jpeg"], quality:98 } imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ``` ### packing packing(source: ImageSource, option: PackingOption): Promise> 图片压缩或重新打包，使用Promise形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | -------------- | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | **返回值：** | 类型 | 说明 | | :--------------------------- | :-------------------------------------------- | | Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | **示例：** ```js let packOpts = { format:["image/jpeg"], quality:98 } imagePackerApi.packing(imageSourceApi, packOpts) .then( data => { }) .catch(error => {}) ``` ### packing packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\): void 图片压缩或重新打包，使用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ---------------------------------- | | source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap资源。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | callback | AsyncCallback\ | 是 | 获取图片打包回调，返回打包后数据。 | **示例：** ```js let packOpts = { format:["image/jpeg"], quality:98 } imagePackerApi.packing(pixelMapApi, packOpts, data => {}) ``` ### packing packing(source: PixelMap, option: PackingOption): Promise> 图片压缩或重新打包，使用Promise形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | ------------------ | | source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap源。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | **返回值：** | 类型 | 说明 | | :--------------------------- | :-------------------------------------------- | | Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | **示例：** ```js let packOpts = { format:["image/jpeg"], quality:98 } imagePackerApi.packing(pixelMapApi, packOpts) .then( data => { }) .catch(error => {}) ``` ### release release(callback: AsyncCallback\): void 释放图片打包实例，使用callback形式返回结果。 **系统能力：** SystemCapability.Multimedia.Image **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | | callback | AsyncCallback\ | 是 | 释放回调，失败时返回错误信息。 | **示例：** ```js imagePackerApi.release(()=>{}) ``` ### release release(): Promise\ 释放图片打包实例，使用Promise形式返回释放结果。 **系统能力：** SystemCapability.Multimedia.Image **返回值：** | 类型 | 说明 | | :------------- | :------------------------------------------------------ | | Promise\ | Promise实例，用于异步获取释放结果，失败时返回错误信息。 | **示例：** ```js imagePackerApi.release().then(()=>{ }).catch((error)=>{}) ``` ## image.createImageReceiver9+ createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver 通过宽、高、图片格式、容量创建imagereceiver实例。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------- | | width | number | 是 | imagereceiver将生成的图像的默认宽度。 | | height | number | 是 | imagereceiver将生成的图像的默认高度。 | | format | number | 是 | imagereceiver将生成的图像格式。 | | capacity | number | 是 | 同时访问的最大图像数。 | **返回值：** | 类型 | 说明 | | ------------- | ----------------------------------------- | | ImageReceiver | 如果操作成功，则返回 ImageReceiver 实例。 | **示例：** ```js var receiver = image.createImageReceiver(8192, 8, 4, 8) ``` ## ImageReceiver9+ 图像接收类，用于获取组件surface id，接收最新的图片和读取下一张图片，以及释放 ImageReceiver 实例。在调用各方法前需要先创建 ImageReceiver 实例。 ### 属性 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | ---------------------------- | ---- | ---- | ------------------ | | size | [Size](#size) | 是 | 否 | 图片大小。 | | capacity | number | 是 | 否 | 同时访问的图像数。 | | format | [ImageFormat](#imageformat9) | 是 | 否 | 图像格式。 | ### getReceivingSurfaceId9+ getReceivingSurfaceId(callback: AsyncCallback\): void 用于获取一个surface id并使用callback返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------------- | | callback | AsyncCallback\ | 是 | 使用callback返回surface id。 | **示例:** ```js receiver.getReceivingSurfaceId((err, id) => {}); ``` ### getReceivingSurfaceId9+ getReceivingSurfaceId(): Promise\ 用于获取一个surface id并使用promise返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **返回值：** | 类型 | 说明 | | ---------------- | -------------------- | | Promise\ | 异步返回surface id。 | **示例：** ```js receiver.getReceivingSurfaceId().then( id => { }).catch(error => { }) ``` ### readLatestImage9+ readLatestImage(callback: AsyncCallback\): void 从 ImageReceiver读取最新的图片，并使用callback返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ---------------------- | | callback | AsyncCallback<[Image](#image8)> | 是 | callback返回最新图像。 | **示例：** ```js receiver.readLatestImage((err, img) => { }); ``` ### readLatestImage9+ readLatestImage(): Promise\ 从 ImageReceiver读取最新的图片，并使用promise返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **返回值：** | 类型 | 说明 | | ------------------------- | ------------------ | | Promise<[Image](#image8)> | 异步返回最新图片。 | **示例：** ```js receiver.readLatestImage().then(img => {}) .catch(error => {}) ``` ### readNextImage9+ readNextImage(callback: AsyncCallback\): void 从 ImageReceiver读取下一张图片，并使用callback返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------ | | callback | AsyncCallback<[Image](#image8)> | 是 | callback返回下一张图片。 | **示例：** ```js receiver.readNextImage((err, img) => {}); ``` ### readNextImage9+ readNextImage(): Promise\ 从 ImageReceiver读取下一张图片，并使用promise返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **返回值：** | 类型 | 说明 | | ------------------------- | -------------------- | | Promise<[Image](#image8)> | 异步返回下一张图片。 | **示例：** ```js receiver.readNextImage().then(img => { }).catch(error => { }) ``` ### on9+ on(type: 'imageArrival', callback: AsyncCallback\): void 接收图片时注册回调。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------------------------ | | type | imageArrival | 是 | 注册事件的类型，固定为'imageArrival'，接收图片时触发。 | | callback | AsyncCallback\ | 是 | 注册的事件回调。 | **示例：** ```js receiver.on('imageArrival', () => {}) ``` ### release9+ release(callback: AsyncCallback\): void 释放ImageReceiver实例并使用回调返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------- | | callback | AsyncCallback\ | 是 | 返回操作结果。 | **示例：** ```js receiver.release(() => {}) ``` ### release9+ release(): Promise\ 释放ImageReceiver实例并使用promise返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.ImageReceiver **返回值：** | 类型 | 说明 | | -------------- | ----------------------- | | Promise\ | 用promise返回操作结果。 | **示例：** ```js receiver.release().then(() => {}) .catch(error => {}) ``` ## Image9+ 提供基本的图像操作，包括获取图像信息、读写图像数据。调用readNextImage和readLatestImage接口时会返回image。 ### 属性 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | ------------------ | ---- | ---- | ---------------------------- | | clipRect | [Region](#region8) | 是 | 是 | 设置或获取要裁剪的图像区域。 | | size | [Size](#size) | 是 | 否 | 图像大小。 | | format | number | 是 | 否 | 图像格式。 | ### getComponent9+ getComponent(componentType: ComponentType, callback: AsyncCallback\): void 根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.Core **参数：** | 名称 | 类型 | 必填 | 说明 | | ------------- | --------------------------------------- | ---- | -------------------- | | componentType | [ComponentType](#componenttype8) | 是 | 图像的组件类型。 | | callback | AsyncCallback<[Component](#component8)> | 是 | 用于返回组件缓冲区。 | **示例：** ```js img.getComponent(4, (err, component) => {}) ``` ### getComponent9+ getComponent(componentType: ComponentType): Promise\ 根据图像的组件类型从图像中获取组件缓存并使用promise方式返回结果。 **系统能力： ** SystemCapability.Multimedia.Image.Core **参数：** | 名称 | 类型 | 必填 | 说明 | | ------------- | -------------------------------- | ---- | ---------------- | | componentType | [ComponentType](#componenttype8) | 是 | 图像的组件类型。 | **返回值：** | 类型 | 说明 | | --------------------------------- | --------------------------------- | | Promise<[Component](#component8)> | 用于返回组件缓冲区的promise实例。 | **示例：** ```js img.getComponent(4).then(component => { }) ``` ### release9+ release(callback: AsyncCallback\): void 释放当前图像并使用callback返回结果。在接收另一个图像前必须先释放对应资源。 **系统能力： ** SystemCapability.Multimedia.Image.Core **参数：** | 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------- | | callback | AsyncCallback\ | 是 | 返回操作结果。 | **示例：** ```js img.release(() =>{ }) ``` ### release9+ release(): Promise\ 释放当前图像并使用promise返回结果。在接收另一个图像前必须先释放对应资源。 **系统能力： ** SystemCapability.Multimedia.Image.Core **返回值：** | 类型 | 说明 | | -------------- | --------------------- | | Promise\ | promise返回操作结果。 | **示例：** ```js img.release().then(() =>{ }).catch(error => { }) ``` ## PositionArea7+ 表示图片指定区域内的数据。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ------ | ------------------ | ---- | ---- | ------------------------------------------------------------ | | pixels | ArrayBuffer | 是 | 否 | 像素。 | | offset | number | 是 | 否 | 偏移量。 | | stride | number | 是 | 否 | 像素间距，stride >= region.size.width*4。 | | region | [Region](#region8) | 是 | 否 | 区域，按照区域读写。写入的区域宽度加X坐标不能大于原图的宽度，写入的区域高度加Y坐标不能大于原图的高度 | ## ImageInfo 表示图片信息。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ---- | ------------- | ---- | ---- | ---------- | | size | [Size](#size) | 是 | 是 | 图片大小。 | ## Size 表示图片尺寸。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ------ | ------ | ---- | ---- | -------------- | | height | number | 是 | 是 | 输出图片的高。 | | width | number | 是 | 是 | 输出图片的宽。 | ## PixelMapFormat7+ 枚举，像素格式。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 默认值 | 描述 | | --------- | ------ | ----------------- | | UNKNOWN | 0 | 未知格式。 | | RGBA_8888 | 3 | 格式为RGBA_8888。 | | RGB_565 | 2 | 格式为RGB_565。 | ## AlphaType9+ 枚举，透明度。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 默认值 | 描述 | | -------- | ------ | ----------------------- | | UNKNOWN | 0 | 未知透明度。 | | OPAQUE | 1 | 没有alpha或图片全透明。 | | PREMUL | 2 | RGB前乘alpha。 | | UNPREMUL | 3 | RGB不前乘alpha。 | ## ScaleMode9+ 枚举，缩略值。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 默认值 | 描述 | | --------------- | ------ | -------------------------------------------------- | | CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 | | FIT_TARGET_SIZE | 2 | 图像适合目标尺寸的效果。 | ## InitializationOptions8+ **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------------- | ---------------------------------- | ---- | ---- | -------------- | | alphaType9+ | [AlphaType](#alphatype9) | 是 | 是 | 透明度。 | | editable | boolean | 是 | 是 | 是否可编辑。 | | pixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 像素格式。 | | scaleMode9+ | [ScaleMode](#scalemode9) | 是 | 是 | 缩略值。 | | size | [Size](#size) | 是 | 是 | 创建图片大小。 | ## DecodingOptions7+ 解码设置选项。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------ | ---------------------------------- | ---- | ---- | ---------------- | | sampleSize | number | 是 | 是 | 缩略图采样大小。 | | rotate | number | 是 | 是 | 旋转角度。 | | editable | boolean | 是 | 是 | 是否可编辑。 | | desiredSize | [Size](#size) | 是 | 是 | 期望输出大小。 | | desiredRegion | [Region](#region8) | 是 | 是 | 解码区域。 | | desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 解码的像素格式。 | | index | numer | 是 | 是 | 解码图片序号 | ## Region8+ 表示区域信息。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ---- | ------------- | ---- | ---- | ------------ | | size | [Size](#size) | 是 | 是 | 区域大小。 | | x | number | 是 | 是 | 区域横坐标。 | | y | number | 是 | 是 | 区域纵坐标。 | ## PackingOption 表示图片打包选项。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ------- | ------ | ---- | ---- | -------------- | | format | string | 是 | 是 | 目标格式。 | | quality | number | 是 | 是 | 目标图片质量。 | ## GetImagePropertyOptions7+ 表示查询图片属性的索引。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------ | ------ | ---- | ---- | ------------ | | index | number | 是 | 是 | 图片序号。 | | defaultValue | string | 是 | 是 | 默认属性值。 | ## PropertyKey7+ 枚举，Exif（Exchangeable image file format）图片信息。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image | 名称 | 默认值 | 说明 | | ----------------- | ----------------- | -------------------- | | BITS_PER_SAMPLE | "BitsPerSample" | 每个像素比特数。 | | ORIENTATION | "Orientation" | 图片方向。 | | IMAGE_LENGTH | "ImageLength" | 图片长度。 | | IMAGE_WIDTH | "ImageWidth" | 图片宽度。 | | GPS_LATITUDE | "GPSLatitude" | 图片纬度。 | | GPS_LONGITUDE | "GPSLongitude" | 图片经度。 | | GPS_LATITUDE_REF | "GPSLatitudeRef" | 纬度引用，例如N或S。 | | GPS_LONGITUDE_REF | "GPSLongitudeRef" | 经度引用，例如W或E。 | ## ImageFormat9+ 枚举，图片格式。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core | 名称 | 默认值 | 描述 | | ------------ | ------ | --------------------- | | YCBCR_422_SP | 1000 | YCBCR422 半平面格式。 | | JPEG | 2000 | JPEG编码格式。 | ## ComponentType8+ 枚举，图像的组件类型。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver | 名称 | 默认值 | 描述 | | ----- | ------ | ----------- | | YUV_Y | 1 | 亮度信息。 | | YUV_U | 2 | 色度信息。 | | YUV_V | 3 | 色度信息。 | | JPEG | 4 | Jpeg 类型。 | ## Component8+ 描述图像颜色分量。 **系统能力： ** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------- | -------------------------------- | ---- | ---- | ------------ | | componentType | [ComponentType](#componenttype8) | 是 | 否 | 组件类型。 | | rowStride | number | 是 | 否 | 行距。 | | pixelStride | number | 是 | 否 | 像素间距。 | | byteBuffer | ArrayBuffer | 是 | 否 | 组件缓冲区。 |