@ohos.multimedia.image (图片处理)

本模块提供图片处理效果，包括通过属性创建PixelMap、读取图像像素数据、读取区域内的图片数据等。

说明：

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

从API version 12开始，本模块接口支持在ArkTS卡片中使用。

导入模块

import image from '@ohos.multimedia.image';

image.createPixelMap⁸⁺

createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise<PixelMap>

通过属性创建PixelMap，默认采用BGRA_8888格式处理数据，通过Promise返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	BGRA_8888格式的颜色数组。
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。当创建的pixelMap大小超过原图大小时，返回原图pixelMap大小。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
  image.createPixelMap(color, opts).then((pixelMap: image.PixelMap) => {
    console.info('Succeeded in creating pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
  })
}

image.createPixelMap⁸⁺

createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback<PixelMap>): void

通过属性创建PixelMap，默认采用BGRA_8888格式处理数据，通过回调函数返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	BGRA_8888格式的颜色数组。
options	InitializationOptions	是	属性。
callback	AsyncCallback<PixelMap>	是	回调函数，当创建PixelMap成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
  image.createPixelMap(color, opts, (error: BusinessError, pixelMap: image.PixelMap) => {
    if(error) {
      console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
      return;
    } else {
      console.info('Succeeded in creating pixelmap.');
    }
  })
}

image.createPixelMapFromParcel¹¹⁺

createPixelMapFromParcel(sequence: rpc.MessageSequence): PixelMap

从MessageSequence中获取PixelMap。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
sequence	rpc.MessageSequence	是	保存有PixelMap信息的MessageSequence。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980096	If the operation failed
62980097	If the ipc error
62980115	Invalid input parameter
62980105	Failed to get the data
62980177	Abnormal API environment
62980178	Failed to create the PixelMap
62980179	Abnormal buffer size
62980180	FD mapping failed
62980246	Failed to read the PixelMap

示例：

import image from '@ohos.multimedia.image';
import rpc from '@ohos.rpc';
import { BusinessError } from '@ohos.base';

class MySequence implements rpc.Parcelable {
  pixel_map: image.PixelMap;
  constructor(conPixelmap: image.PixelMap) {
    this.pixel_map = conPixelmap;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    this.pixel_map.marshalling(messageSequence);
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence) {
    try {
      this.pixel_map = image.createPixelMapFromParcel(messageSequence);
    } catch(e) {
      let error = e as BusinessError;
      console.error(`createPixelMapFromParcel error. code is ${error.code}, message is ${error.message}`);
      return false;
    }
    return true;
  }
}
async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96);
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = 0x80;
  }
  let opts: image.InitializationOptions = {
    editable: true,
    pixelFormat: 4,
    size: { height: 4, width: 6 },
    alphaType: 3
  }
  let pixelMap: image.PixelMap | undefined = undefined;
  image.createPixelMap(color, opts).then((srcPixelMap: image.PixelMap) => {
    pixelMap = srcPixelMap;
  })
  if (pixelMap != undefined) {
    // 序列化
    let parcelable: MySequence = new MySequence(pixelMap);
    let data: rpc.MessageSequence = rpc.MessageSequence.create();
    data.writeParcelable(parcelable);

    // 反序列化 rpc获取到data
    let ret: MySequence = new MySequence(pixelMap);
    data.readParcelable(ret);

    // 获取到pixelmap
    let unmarshPixelmap = ret.pixel_map;
  }
}

image.createPixelMapFromSurface¹¹⁺

createPixelMapFromSurface(surfaceId: string, region: Region): Promise<PixelMap>

从Surface id创建一个PixelMap对象。使用Promise异步回调，返回PixelMap。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	从XComponent组件获取的surfaceId。
region	Region	是	裁剪的尺寸

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980115	Invalid input parameter
62980105	Failed to get the data
62980178	Failed to create the PixelMap

示例：

import { BusinessError } from '@ohos.base';

async function Demo(surfaceId: string) {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  image.createPixelMapFromSurface(surfaceId, region).then(() => {
    console.info('Succeeded in creating pixelmap from Surface');
  }).catch((error: BusinessError) => {
    console.error(`Failed to create pixelmap. code is ${error.code}, message is ${error.message}`);
  });
}

image.createPixelMapFromSurfaceSync¹²⁺

createPixelMapFromSurfaceSync(surfaceId: string, region: Region): PixelMap

从Surface id创建一个pixelMap对象，同步返回PixelMap结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
surfaceId	string	是	从XComponent组件获取的surfaceId。
region	Region	是	裁剪的尺寸

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980105	Failed to get the data
62980178	Failed to create the PixelMap

示例：

import { BusinessError } from '@kit.BasicServicesKit';

async function Demo(surfaceId: string) {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  let pixelMap : image.PixelMap = image.createPixelMapFromSurfaceSync(surfaceId, region);
  return pixelMap;
}

image.createPixelMapSync¹²⁺

createPixelMapSync(colors: ArrayBuffer, options: InitializationOptions): PixelMap

通过属性创建PixelMap，同步返回PixelMap结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colors	ArrayBuffer	是	BGRA_8888格式的颜色数组。
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
  let pixelMap : image.PixelMap = image.createPixelMapSync(color, opts);
  return pixelMap;
}

image.createPixelMapSync¹²⁺

createPixelMapSync(options: InitializationOptions): PixelMap

通过属性创建PixelMap，同步返回PixelMap结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
options	InitializationOptions	是	创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
  let pixelMap : image.PixelMap = image.createPixelMapSync(opts);
  return pixelMap;
}

image.createPremultipliedPixelMap¹²⁺

createPremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void

将PixelMap的透明通道非预乘模式转变为预乘模式，转换后的数据存入目标PixelMap，通过回调函数返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。
callback	AsyncCallback<void>	是	回调函数，当创建PixelMap成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 2, width: 2 } , alphaType: 3}
  let srcPixelmap = image.createPixelMapSync(color, opts);
  let dstPixelMap = image.createPixelMapSync(opts);
  image.createPremultipliedPixelMap(srcPixelmap, dstPixelMap, (error: BusinessError) => {
    if(error) {
      console.error(`Failed to convert pixelmap. code is ${error.code}, message is ${error.message}`);
      return;
    } else {
      console.info('Succeeded in converting pixelmap.');
    }
  })
}

image.createPremultipliedPixelMap¹²⁺

createPremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>

将PixelMap数据按照透明度不前乘格式转为前乘格式，转换后的数据存入另一个PixelMap，通过Promise返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象
dst	PixelMap	是	目标PixelMap对象

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 2, width: 2 } , alphaType: 2}
  let srcPixelmap = image.createPixelMapSync(color, opts);
  let dstPixelMap = image.createPixelMapSync(opts);
  image.createPremultipliedPixelMap(srcPixelmap, dstPixelMap).then(() => {
    console.info('Succeeded in converting pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to convert pixelmap. code is ${error.code}, message is ${error.message}`);
  })
}

image.createUnpremultipliedPixelMap¹²⁺

createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void

将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap，通过回调函数返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。
callback	AsyncCallback<void>	是	回调函数，当创建PixelMap成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
62980246	Failed to read the pixelMap
62980248	Pixelmap not allow modify

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 2, width: 2 } , alphaType: 2}
  let srcPixelmap = image.createPixelMapSync(color, opts);
  let dstPixelMap = image.createPixelMapSync(opts);
  image.createUnpremultipliedPixelMap(srcPixelmap, dstPixelMap, (error: BusinessError) => {
    if(error) {
      console.error(`Failed to convert pixelmap. code is ${error.code}, message is ${error.message}`);
      return;
    } else {
      console.info('Succeeded in converting pixelmap.');
    }
  })
}

image.createUnpremultipliedPixelMap¹²⁺

createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>

将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap，通过Promise返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	PixelMap	是	源PixelMap对象。
dst	PixelMap	是	目标PixelMap对象。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980103	The image data is not supported
60980246	Failed to read the PixelMap
60980248	PixelMap does not allow modification

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(16); // 16为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i += 4) {
    bufferArr[i] = 255;
    bufferArr[i+1] = 255;
    bufferArr[i+2] = 122;
    bufferArr[i+3] = 122;
  }
  let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 2, width: 2 } , alphaType: 3}
  let srcPixelmap = image.createPixelMapSync(color, opts);
  let dstPixelMap = image.createPixelMapSync(opts);
  image.createUnpremultipliedPixelMap(srcPixelmap, dstPixelMap).then(() => {
    console.info('Succeeded in converting pixelmap.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to convert pixelmap. code is ${error.code}, message is ${error.message}`);
  })
}

PixelMap⁷⁺

图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。目前pixelmap序列化大小最大128MB，超过会送显失败。大小计算方式为(宽*高*每像素占用字节数)。

从API version 11开始，PixelMap支持通过worker跨线程调用。当PixelMap通过Worker跨线程后，原线程的PixelMap的所有接口均不能调用，否则将报错501 服务器不具备完成请求的功能。

在调用PixelMap的方法前，需要先通过image.createPixelMap构建一个PixelMap对象。

属性

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	可读	可写	说明
isEditable	boolean	是	否	设定是否图像像素可被编辑。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
isStrideAlignment¹¹⁺	boolean	是	否	设定图像内存是否为DMA内存。

readPixelsToBuffer⁷⁺

readPixelsToBuffer(dst: ArrayBuffer): Promise<void>

读取图像像素数据，结果写入ArrayBuffer里，使用Promise形式返回。指定BGRA_8888格式创建pixelmap，读取的像素数据与原数据保持一致。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
dst	ArrayBuffer	是	缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。缓冲区大小由getPixelBytesNumber接口获取。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const readBuffer: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  if (pixelMap != undefined) {
    pixelMap.readPixelsToBuffer(readBuffer).then(() => {
      console.info('Succeeded in reading image pixel data.'); // 符合条件则进入 
    }).catch((error: BusinessError) => {
      console.error(`Failed to read image pixel data. code is ${error.code}, message is ${error.message}`);// 不符合条件则进入
    })
  }
}

readPixelsToBuffer⁷⁺

readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback<void>): void

读取图像像素数据，结果写入ArrayBuffer里，使用callback形式返回。指定BGRA_8888格式创建pixelmap，读取的像素数据与原数据保持一致。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
dst	ArrayBuffer	是	缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。缓冲区大小由getPixelBytesNumber接口获取。
callback	AsyncCallback<void>	是	回调函数。当读取像素数据到ArrayBuffer成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const readBuffer: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  if (pixelMap != undefined) {
    pixelMap.readPixelsToBuffer(readBuffer, (error: BusinessError, res: void) => {
      if(error) {
        console.error(`Failed to read image pixel data. code is ${error.code}, message is ${error.message}`);// 不符合条件则进入
        return;
      } else {
        console.info('Succeeded in reading image pixel data.');  //符合条件则进入
      }
    })
  }
}

readPixelsToBufferSync¹²⁺

readPixelsToBufferSync(dst: ArrayBuffer): void

以同步方法读取PixelMap到Buffer里。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
dst	ArrayBuffer	是	缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。缓冲区大小由getPixelBytesNumber接口获取。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const readBuffer: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  if (pixelMap != undefined) {
    pixelMap.readPixelsToBufferSync(readBuffer);
  }
}

readPixels⁷⁺

readPixels(area: PositionArea): Promise<void>

读取区域内的图片数据，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域大小，根据区域读取。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area: image.PositionArea = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  if (pixelMap != undefined) {
    pixelMap.readPixels(area).then(() => {
      console.info('Succeeded in reading the image data in the area.'); //符合条件则进入
    }).catch((error: BusinessError) => {
      console.error(`Failed to read the image data in the area. code is ${error.code}, message is ${error.message}`);// 不符合条件则进入
    })
  }
}

readPixels⁷⁺

readPixels(area: PositionArea, callback: AsyncCallback<void>): void

读取区域内的图片数据，使用callback形式返回读取结果。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域大小，根据区域读取。
callback	AsyncCallback<void>	是	回调函数。当读取区域内的图片数据成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area: image.PositionArea = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  if (pixelMap != undefined) {
    pixelMap.readPixels(area, (error: BusinessError) => {
      if (error) {
        console.error(`Failed to read pixelmap from the specified area. code is ${error.code}, message is ${error.message}`);
        return;
      } else {
        console.info('Succeeded in reading pixelmap from the specified area.');
      }
    })
  }
}

readPixelsSync¹²⁺

readPixelsSync(area: PositionArea): void

读取区域内的图片数据并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域大小，根据区域读取。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area : image.PositionArea = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  if (pixelMap != undefined) {
    pixelMap.readPixelsSync(area);
  }
}

writePixels⁷⁺

writePixels(area: PositionArea): Promise<void>

将PixelMap写入指定区域内，使用Promise形式返回写入结果。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域，根据区域写入。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area: image.PositionArea = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  let bufferArr: Uint8Array = new Uint8Array(area.pixels);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writePixels(area).then(() => {
      console.info('Succeeded in writing pixelmap into the specified area.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to write pixelmap into the specified area. code is ${error.code}, message is ${error.message}`);
    })
  }
}

writePixels⁷⁺

writePixels(area: PositionArea, callback: AsyncCallback<void>): void

将PixelMap写入指定区域内，使用callback形式返回写入结果。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域，根据区域写入。
callback	AsyncCallback<void>	是	回调函数，当写入成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area: image.PositionArea = { pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  let bufferArr: Uint8Array = new Uint8Array(area.pixels);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writePixels(area, (error : BusinessError) => {
      if (error) {
        console.error(`Failed to write pixelmap into the specified area. code is ${error.code}, message is ${error.message}`);
        return;
      } else {
        console.info('Succeeded in writing pixelmap into the specified area.');
      }
    })
  }
}

writePixelsSync¹²⁺

writePixelsSync(area: PositionArea): void

以同步方法将PixelMap写入指定区域内。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
area	PositionArea	是	区域，根据区域写入。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const area: image.PositionArea = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
  };
  let bufferArr: Uint8Array = new Uint8Array(area.pixels);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writePixelsSync(area);
  }
}

writeBufferToPixels⁷⁺

writeBufferToPixels(src: ArrayBuffer): Promise<void>

读取缓冲区中的图片数据，结果写入PixelMap中，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	ArrayBuffer	是	图像像素数据。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writeBufferToPixels(color).then(() => {
      console.info("Succeeded in writing data from a buffer to a PixelMap.");
    }).catch((error: BusinessError) => {
      console.error(`Failed to write data from a buffer to a PixelMap. code is ${error.code}, message is ${error.message}`);
    })
  }
}

writeBufferToPixels⁷⁺

writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback<void>): void

读取缓冲区中的图片数据，结果写入PixelMap中，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	ArrayBuffer	是	图像像素数据。
callback	AsyncCallback<void>	是	回调函数。当读取缓冲区中的图片数据并写入PixelMap成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writeBufferToPixels(color, (error: BusinessError) => {
      if (error) {
        console.error(`Failed to write data from a buffer to a PixelMap. code is ${error.code}, message is ${error.message}`);
        return;
      } else {
        console.info("Succeeded in writing data from a buffer to a PixelMap.");
      }
    })
  }
}

writeBufferToPixelsSync¹²⁺

writeBufferToPixelsSync(src: ArrayBuffer): void

读取缓冲区中的图片数据，结果写入PixelMap并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
src	ArrayBuffer	是	图像像素数据。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  const color : ArrayBuffer = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
  let bufferArr : Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
  }
  if (pixelMap != undefined) {
    pixelMap.writeBufferToPixelsSync(color);
  }
}

getImageInfo⁷⁺

getImageInfo(): Promise<ImageInfo>

获取图像像素信息，使用Promise形式返回获取的图像像素信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Promise<ImageInfo>	Promise对象，返回图像像素信息。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.getImageInfo().then((imageInfo: image.ImageInfo) => {
      if (imageInfo != undefined) {
        console.info("Succeeded in obtaining the image pixel map information."+ imageInfo.size.height);
      }
    }).catch((error: BusinessError) => {
      console.error(`Failed to obtain the image pixel map information. code is ${error.code}, message is ${error.message}`);
    })
  }
}

getImageInfo⁷⁺

getImageInfo(callback: AsyncCallback<ImageInfo>): void

获取图像像素信息，使用callback形式返回获取的图像像素信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<ImageInfo>	是	回调函数。当获取图像像素信息成功，err为undefined，data为获取到的图像像素信息；否则为错误对象。

示例:

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.getImageInfo((error: BusinessError, imageInfo: image.ImageInfo) => {
      if (error) {
        console.error(`Failed to obtain the image pixel map information. code is ${error.code}, message is ${error.message}`);
        return;
      } else {
        console.info("Succeeded in obtaining the image pixel map information."+ imageInfo.size.height);
      }
    })
  }
}

getImageInfoSync¹²⁺

getImageInfoSync(): ImageInfo

以同步方法获取图像像素信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
ImageInfo	图像像素信息

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    let imageInfo : image.ImageInfo = pixelMap.getImageInfoSync();
    return imageInfo;
  }
  rteurn undefined;
}

getBytesNumberPerRow⁷⁺

getBytesNumberPerRow(): number

获取图像像素每行字节数。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
number	图像像素的行字节数。

示例：

let rowCount: number = pixelMap.getBytesNumberPerRow();

getPixelBytesNumber⁷⁺

getPixelBytesNumber(): number

获取图像像素的总字节数。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
number	图像像素的总字节数。

示例：

let pixelBytesNumber: number = pixelMap.getPixelBytesNumber();

getDensity⁹⁺

getDensity():number

获取当前图像像素的密度。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
number	图像像素的密度。

示例：

let getDensity: number = pixelMap.getDensity();

opacity⁹⁺

opacity(rate: number, callback: AsyncCallback<void>): void

通过设置透明比率来让PixelMap达到对应的透明效果，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
rate	number	是	透明比率的值。
callback	AsyncCallback<void>	是	回调函数。当设置透明比率成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let rate: number = 0.5;
  if (pixelMap != undefined) {
    pixelMap.opacity(rate, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to set opacity. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in setting opacity.");
      }
    })
  }
}

opacity⁹⁺

opacity(rate: number): Promise<void>

通过设置透明比率来让PixelMap达到对应的透明效果，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
rate	number	是	透明比率的值。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let rate: number = 0.5;
  if (pixelMap != undefined) {
    pixelMap.opacity(rate).then(() => {
      console.info('Succeeded in setting opacity.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to set opacity. code is ${err.code}, message is ${err.message}`);
    })
  }
}

opacitySync¹²⁺

opacitySync(rate: number): void

设置PixelMap的透明比率，初始化PixelMap并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
rate	number	是	透明比率的值。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let rate : number = 0.5;
  if (pixelMap != undefined) {
    pixelMap.opacitySync(rate);
  }
}

createAlphaPixelmap⁹⁺

createAlphaPixelmap(): Promise<PixelMap>

根据Alpha通道的信息，来生成一个仅包含Alpha通道信息的pixelmap，可用于阴影效果，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.createAlphaPixelmap().then((alphaPixelMap: image.PixelMap) => {
      console.info('Succeeded in creating alpha pixelmap.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to create alpha pixelmap. code is ${error.code}, message is ${error.message}`);
    })
  }
}

createAlphaPixelmap⁹⁺

createAlphaPixelmap(callback: AsyncCallback<PixelMap>): void

根据Alpha通道的信息，来生成一个仅包含Alpha通道信息的pixelmap，可用于阴影效果，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<PixelMap>	是	回调函数，当创建PixelMap成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.createAlphaPixelmap((err: BusinessError, alphaPixelMap: image.PixelMap) => {
      if (alphaPixelMap == undefined) {
        console.error(`Failed to obtain new pixel map. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info('Succeeded in obtaining new pixel map.');
      }
    })
  }
}

createAlphaPixelmapSync¹²⁺

createAlphaPixelmapSync(): PixelMap

根据Alpha通道的信息，生成一个仅包含Alpha通道信息的PixelMap，可用于阴影效果，同步返回PixelMap类型的结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
PixelMap	成功同步返回PixelMap对象，失败抛出异常。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    let pixelmap : image.PixelMap = pixelMap.createAlphaPixelmapSync();
    return pixelmap;
  }
  rteurn undefined;
}

scale⁹⁺

scale(x: number, y: number, callback: AsyncCallback<void>): void

根据输入的宽高对图片进行缩放，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	宽度的缩放倍数。
y	number	是	高度的缩放倍数。
callback	AsyncCallback<void>	是	回调函数。当对图片进行缩放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let scaleX: number = 2.0;
  let scaleY: number = 1.0;
  if (pixelMap != undefined) {
    pixelMap.scale(scaleX, scaleY, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to scale pixelmap. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in scaling pixelmap.");
      }
    })
  }
}

scale⁹⁺

scale(x: number, y: number): Promise<void>

根据输入的宽高对图片进行缩放，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	宽度的缩放倍数。
y	number	是	高度的缩放倍数。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let scaleX: number = 2.0;
  let scaleY: number = 1.0;
  if (pixelMap != undefined) {
    pixelMap.scale(scaleX, scaleY).then(() => {
      console.info('Succeeded in scaling pixelmap.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to scale pixelmap. code is ${err.code}, message is ${err.message}`);

    })
  }
}

scaleSync¹²⁺

scaleSync(x: number, y: number): void

以同步方法根据输入的宽高对图片进行缩放。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	宽度的缩放倍数。
y	number	是	高度的缩放倍数。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let scaleX: number = 2.0;
  let scaleY: number = 1.0;
  if (pixelMap != undefined) {
    pixelMap.scaleSync(scaleX, scaleY);
  }
}

translate⁹⁺

translate(x: number, y: number, callback: AsyncCallback<void>): void

根据输入的坐标对图片进行位置变换，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	区域横坐标。
y	number	是	区域纵坐标。
callback	AsyncCallback<void>	是	回调函数。当对图片进行位置变换成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let translateX: number = 50.0;
  let translateY: number = 10.0;
  if (pixelMap != undefined) {
    pixelMap.translate(translateX, translateY, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to translate pixelmap. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in translating pixelmap.");
      }
    })
  }
}

translate⁹⁺

translate(x: number, y: number): Promise<void>

根据输入的坐标对图片进行位置变换，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	区域横坐标。
y	number	是	区域纵坐标。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let translateX: number = 50.0;
  let translateY: number = 10.0;
  if (pixelMap != undefined) {
    pixelMap.translate(translateX, translateY).then(() => {
      console.info('Succeeded in translating pixelmap.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to translate pixelmap. code is ${err.code}, message is ${err.message}`);
    })
  }
}

translateSync¹²⁺

translateSync(x: number, y: number): void

根据输入的坐标对图片进行位置变换并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
x	number	是	宽度的缩放倍数。
y	number	是	高度的缩放倍数。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let translateX : number = 50.0;
  let translateY : number = 10.0;
  if (pixelMap != undefined) {
    pixelMap.translateSync(translateX, translateY);
  }
}

rotate⁹⁺

rotate(angle: number, callback: AsyncCallback<void>): void

根据输入的角度对图片进行旋转，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
angle	number	是	图片旋转的角度。
callback	AsyncCallback<void>	是	回调函数。当对图片进行旋转成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let angle: number = 90.0;
  if (pixelMap != undefined) {
    pixelMap.rotate(angle, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to rotate pixelmap. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in rotating pixelmap.");
      }
    })
  }
}

rotate⁹⁺

rotate(angle: number): Promise<void>

根据输入的角度对图片进行旋转，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
angle	number	是	图片旋转的角度。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let angle: number = 90.0;
  if (pixelMap != undefined) {
    pixelMap.rotate(angle).then(() => {
      console.info('Succeeded in rotating pixelmap.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to rotate pixelmap. code is ${err.code}, message is ${err.message}`);
    })
  }
}

rotateSync¹²⁺

rotateSync(angle: number): void

根据输入的角度对图片进行旋转并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
angle	number	是	图片旋转的角度。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let angle : number = 90.0;
  if (pixelMap != undefined) {
    pixelMap.rotateSync(angle);
  }
}

flip⁹⁺

flip(horizontal: boolean, vertical: boolean, callback: AsyncCallback<void>): void

根据输入的条件对图片进行翻转，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
horizontal	boolean	是	水平翻转。
vertical	boolean	是	垂直翻转。
callback	AsyncCallback<void>	是	回调函数，当对图片翻转成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let horizontal: boolean = true;
  let vertical: boolean = false;
  if (pixelMap != undefined) {
    pixelMap.flip(horizontal, vertical, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to flip pixelmap. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in flipping pixelmap.");
      }
    })
  }
}

flip⁹⁺

flip(horizontal: boolean, vertical: boolean): Promise<void>

根据输入的条件对图片进行翻转，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
horizontal	boolean	是	水平翻转。
vertical	boolean	是	垂直翻转。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let horizontal: boolean = true;
  let vertical: boolean = false;
  if (pixelMap != undefined) {
    pixelMap.flip(horizontal, vertical).then(() => {
      console.info('Succeeded in flipping pixelmap.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to flip pixelmap. code is ${err.code}, message is ${err.message}`);
    })
  }
}

flipSync¹²⁺

flipSync(horizontal: boolean, vertical: boolean): void

根据输入的条件对图片进行翻转并同步返回结果。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
horizontal	boolean	是	水平翻转。
vertical	boolean	是	垂直翻转。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let horizontal : boolean = true;
  let vertical : boolean = false;
  if (pixelMap != undefined) {
    pixelMap.flipSync(horizontal, vertical);
  }
}

crop⁹⁺

crop(region: Region, callback: AsyncCallback<void>): void

根据输入的尺寸对图片进行裁剪，使用callback形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
region	Region	是	裁剪的尺寸。
callback	AsyncCallback<void>	是	回调函数。当对图片进行裁剪成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  if (pixelMap != undefined) {
    pixelMap.crop(region, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to crop pixelmap. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info("Succeeded in cropping pixelmap.");
      }
    })
  }
}

crop⁹⁺

crop(region: Region): Promise<void>

根据输入的尺寸对图片进行裁剪，使用Promise形式返回。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
region	Region	是	裁剪的尺寸。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let region: image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  if (pixelMap != undefined) {
    pixelMap.crop(region).then(() => {
      console.info('Succeeded in cropping pixelmap.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to crop pixelmap. code is ${err.code}, message is ${err.message}`);

    });
  }
}

cropSync¹²⁺

cropSync(region: Region): void

根据输入的尺寸裁剪图片。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
region	Region	是	裁剪的尺寸。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
501	Resource Unavailable

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  let region : image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
  if (pixelMap != undefined) {
    pixelMap.cropSync(region);
  }
}

getColorSpace¹⁰⁺

getColorSpace(): colorSpaceManager.ColorSpaceManager

获取图像广色域信息。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
colorSpaceManager.ColorSpaceManager	图像广色域信息。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980101	If the image data abnormal.
62980103	If the image data unsupport.
62980115	If the image parameter invalid.

示例：

async function Demo() {
  if (pixelMap != undefined) {
    let csm = pixelMap.getColorSpace();
  }
}

setColorSpace¹⁰⁺

setColorSpace(colorSpace: colorSpaceManager.ColorSpaceManager): void

设置图像广色域信息。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
colorSpace	colorSpaceManager.ColorSpaceManager	是	图像广色域信息。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980111	If the operation invalid.
62980115	If the image parameter invalid.

示例：

import colorSpaceManager from '@ohos.graphics.colorSpaceManager';
async function Demo() {
  let colorSpaceName = colorSpaceManager.ColorSpace.SRGB;
  let csm: colorSpaceManager.ColorSpaceManager = colorSpaceManager.create(colorSpaceName);
  if (pixelMap != undefined) {
    pixelMap.setColorSpace(csm);
  }
}

applyColorSpace¹¹⁺

applyColorSpace(targetColorSpace: colorSpaceManager.ColorSpaceManager, callback: AsyncCallback<void>): void

根据输入的目标色彩空间对图像像素颜色进行色彩空间转换，使用callback形式返回。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
targetColorSpace	colorSpaceManager.ColorSpaceManager	是	目标色彩空间，支持SRGB、DCI_P3、DISPLAY_P3、ADOBE_RGB_1998。
callback	AsyncCallback<void>	是	回调函数。当对图像像素颜色进行色彩空间转换成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980104	Failed to initialize the internal object.
62980108	Failed to convert the color space.
62980115	Invalid image parameter.

示例：

import colorSpaceManager from '@ohos.graphics.colorSpaceManager';
import { BusinessError } from '@ohos.base'

async function Demo() {
  let colorSpaceName = colorSpaceManager.ColorSpace.SRGB;
  let targetColorSpace: colorSpaceManager.ColorSpaceManager = colorSpaceManager.create(colorSpaceName);
  if (pixelMap != undefined) {
    pixelMap.applyColorSpace(targetColorSpace, (err: BusinessError) => {
      if (err) {
        console.error(`Failed to apply color space for pixelmap object. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info('Succeeded in applying color space for pixelmap object.');
      }
    })
  }
}

applyColorSpace¹¹⁺

applyColorSpace(targetColorSpace: colorSpaceManager.ColorSpaceManager): Promise<void>

根据输入的目标色彩空间对图像像素颜色进行色彩空间转换，使用Promise形式返回。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
targetColorSpace	colorSpaceManager.ColorSpaceManager	是	目标色彩空间，支持SRGB、DCI_P3、DISPLAY_P3、ADOBE_RGB_1998。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed
62980104	Failed to initialize the internal object.
62980108	Failed to convert the color space.
62980115	Invalid image parameter.

示例：

import colorSpaceManager from '@ohos.graphics.colorSpaceManager';
import { BusinessError } from '@ohos.base'

async function Demo() {
  let colorSpaceName = colorSpaceManager.ColorSpace.SRGB;
  let targetColorSpace: colorSpaceManager.ColorSpaceManager = colorSpaceManager.create(colorSpaceName);
  if (pixelMap != undefined) {
    pixelMap.applyColorSpace(targetColorSpace).then(() => {
      console.info('Succeeded in applying color space for pixelmap object.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to apply color space for pixelmap object. code is ${error.code}, message is ${error.message}`);
    })
  }
}

marshalling¹⁰⁺

marshalling(sequence: rpc.MessageSequence): void

将PixelMap序列化后写入MessageSequence。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
sequence	rpc.MessageSequence	是	新创建的MessageSequence。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980115	Invalid image parameter.
62980097	IPC error.

示例：

import image from '@ohos.multimedia.image';
import rpc from '@ohos.rpc';

class MySequence implements rpc.Parcelable {
  pixel_map: image.PixelMap;
  constructor(conPixelMap : image.PixelMap) {
    this.pixel_map = conPixelMap;
  }
  marshalling(messageSequence : rpc.MessageSequence) {
    this.pixel_map.marshalling(messageSequence);
    console.info('marshalling');
    return true;
  }
  unmarshalling(messageSequence : rpc.MessageSequence) {
    image.createPixelMap(new ArrayBuffer(96), {size: { height:4, width: 6}}).then((pixelParcel: image.PixelMap) => {
      pixelParcel.unmarshalling(messageSequence).then(async (pixelMap: image.PixelMap) => {
        this.pixel_map = pixelMap;
        pixelMap.getImageInfo().then((imageInfo: image.ImageInfo) => {
          console.info("unmarshalling information h:" + imageInfo.size.height + "w:" + imageInfo.size.width);
        })
      })
    });
    return true;
  }
}
async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96);
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = 0x80;
  }
  let opts: image.InitializationOptions = {
    editable: true,
    pixelFormat: 4,
    size: { height: 4, width: 6 },
    alphaType: 3
  }
  let pixelMap: image.PixelMap | undefined = undefined;
  image.createPixelMap(color, opts).then((srcPixelMap: image.PixelMap) => {
    pixelMap = srcPixelMap;
  })
  if (pixelMap != undefined) {
    // 序列化
    let parcelable: MySequence = new MySequence(pixelMap);
    let data: rpc.MessageSequence = rpc.MessageSequence.create();
    data.writeParcelable(parcelable);

    // 反序列化 rpc获取到data
    let ret: MySequence = new MySequence(pixelMap);
    data.readParcelable(ret);
  }
}

unmarshalling¹⁰⁺

unmarshalling(sequence: rpc.MessageSequence): Promise<PixelMap>

从MessageSequence中获取PixelMap，如需使用同步方式创建PixelMap可使用：createPixelMapFromParcel。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
sequence	rpc.MessageSequence	是	保存有PixelMap信息的MessageSequence。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
62980115	Invalid image parameter.
62980097	IPC error.
62980096	The operation failed.

示例：

import image from '@ohos.multimedia.image';
import rpc from '@ohos.rpc';

class MySequence implements rpc.Parcelable {
  pixel_map: image.PixelMap;
  constructor(conPixelMap: image.PixelMap) {
    this.pixel_map = conPixelMap;
  }
  marshalling(messageSequence: rpc.MessageSequence) {
    this.pixel_map.marshalling(messageSequence);
    console.info('marshalling');
    return true;
  }
  unmarshalling(messageSequence: rpc.MessageSequence) {
    image.createPixelMap(new ArrayBuffer(96), {size: { height:4, width: 6}}).then((pixelParcel : image.PixelMap) => {
      pixelParcel.unmarshalling(messageSequence).then(async (pixelMap : image.PixelMap) => {
        this.pixel_map = pixelMap;
        pixelMap.getImageInfo().then((imageInfo : image.ImageInfo) => {
          console.info("unmarshalling information h:" + imageInfo.size.height + "w:" + imageInfo.size.width);
        })
      })
    });
    return true;
  }
}
async function Demo() {
  const color: ArrayBuffer = new ArrayBuffer(96);
  let bufferArr: Uint8Array = new Uint8Array(color);
  for (let i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = 0x80;
  }
  let opts: image.InitializationOptions = {
    editable: true,
    pixelFormat: 4,
    size: { height: 4, width: 6 },
    alphaType: 3
  }
  let pixelMap: image.PixelMap | undefined = undefined;
  image.createPixelMap(color, opts).then((srcPixelMap : image.PixelMap) => {
    pixelMap = srcPixelMap;
  })
  if (pixelMap != undefined) {
    // 序列化
    let parcelable: MySequence = new MySequence(pixelMap);
    let data : rpc.MessageSequence = rpc.MessageSequence.create();
    data.writeParcelable(parcelable);

    // 反序列化 rpc获取到data
    let ret : MySequence = new MySequence(pixelMap);
    data.readParcelable(ret);
  }
}

release⁷⁺

release():Promise<void>

释放PixelMap对象，使用Promise形式返回释放结果。

ArkTS有内存回收机制，PixelMap对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.release().then(() => {
      console.info('Succeeded in releasing pixelmap object.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to release pixelmap object. code is ${error.code}, message is ${error.message}`);
    })
  }
}

release⁷⁺

release(callback: AsyncCallback<void>): void

释放PixelMap对象，使用callback形式返回释放结果。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当对PixelMap对象释放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

async function Demo() {
  if (pixelMap != undefined) {
    pixelMap.release((err: BusinessError) => {
      if (err) {
        console.error(`Failed to release pixelmap object. code is ${err.code}, message is ${err.message}`);
        return;
      } else {
        console.info('Succeeded in releasing pixelmap object.');
      }
    })
  }
}

image.createImageSource

createImageSource(uri: string): ImageSource

通过传入的uri创建图片源实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
uri	string	是	图片路径，当前仅支持应用沙箱路径。当前支持格式有：.jpg .png .gif .bmp .webp .dng SVG¹⁰⁺ .ico¹¹⁺。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换。否则imageSource会创建失败，导致后续无法正常执行。
const path: string = context.filesDir + "/test.jpg";
const imageSourceApi: image.ImageSource = image.createImageSource(path);

image.createImageSource⁹⁺

createImageSource(uri: string, options: SourceOptions): ImageSource

通过传入的uri创建图片源实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
uri	string	是	图片路径，当前仅支持应用沙箱路径。当前支持格式有：.jpg .png .gif .bmp .webp .dng SVG¹⁰⁺ .ico¹¹⁺。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
const context: Context = getContext(this);
//此处'test.png'仅作示例，请开发者自行替换。否则imageSource会创建失败，导致后续无法正常执行。
const path: string = context.filesDir + "/test.png";
let imageSourceApi: image.ImageSource = image.createImageSource(path, sourceOptions);

image.createImageSource⁷⁺

createImageSource(fd: number): ImageSource

通过传入文件描述符来创建图片源实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
fd	number	是	文件描述符fd。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
let filePath: string = context.filesDir + "/test.jpg";
const imageSourceApi: image.ImageSource = image.createImageSource(filePath);

image.createImageSource⁹⁺

createImageSource(fd: number, options: SourceOptions): ImageSource

通过传入文件描述符来创建图片源实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
fd	number	是	文件描述符fd。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

import fs from '@ohos.file.fs'

let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
const filePath: string = context.filesDir + "/test.jpg";
let file = fs.openSync(filePath, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
const imageSourceApi: image.ImageSource = image.createImageSource(file.fd, sourceOptions);

image.createImageSource⁹⁺

createImageSource(buf: ArrayBuffer): ImageSource

通过缓冲区创建图片源实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	图像缓冲区数组。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

const buf: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
const imageSourceApi: image.ImageSource = image.createImageSource(buf);

image.createImageSource⁹⁺

createImageSource(buf: ArrayBuffer, options: SourceOptions): ImageSource

通过缓冲区创建图片源实例。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	图像缓冲区数组。
options	SourceOptions	是	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

const data: ArrayBuffer = new ArrayBuffer(112);
let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
const imageSourceApi: image.ImageSource = image.createImageSource(data, sourceOptions);

image.createImageSource¹¹⁺

createImageSource(rawfile: resourceManager.RawFileDescriptor, options?: SourceOptions): ImageSource

通过图像资源文件的RawFileDescriptor创建图片源实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
rawfile	resourceManager.RawFileDescriptor	是	图像资源文件的RawFileDescriptor。
options	SourceOptions	否	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回ImageSource类实例，失败时返回undefined。

示例：

import resourceManager from '@ohos.resourceManager';

const context: Context = getContext(this);
// 获取resourceManager资源管理器
const resourceMgr: resourceManager.ResourceManager = context.resourceManager;
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
resourceMgr.getRawFd('test.jpg').then((rawFileDescriptor: resourceManager.RawFileDescriptor) => {
  const imageSourceApi: image.ImageSource = image.createImageSource(rawFileDescriptor);
}).catch((error: BusinessError) => {
  console.error(`Failed to get RawFileDescriptor.code is ${error.code}, message is ${error.message}`);
})

image.CreateIncrementalSource⁹⁺

CreateIncrementalSource(buf: ArrayBuffer): ImageSource

通过缓冲区以增量的方式创建图片源实例。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。

返回值：

类型	说明
ImageSource	返回图片源，失败时返回undefined。

示例：

const buf: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(buf);

image.CreateIncrementalSource⁹⁺

CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource

通过缓冲区以增量的方式创建图片源实例。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。
options	SourceOptions	否	图片属性，包括图片像素密度、像素格式和图片尺寸。

返回值：

类型	说明
ImageSource	返回图片源，失败时返回undefined。

示例：

const buf: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(buf, sourceOptions);

ImageSource

图片源类，用于获取图片相关信息。在调用ImageSource的方法前，需要先通过createImageSource构建一个ImageSource实例。

属性

系统能力： SystemCapability.Multimedia.Image.ImageSource

名称	类型	可读	可写	说明
supportedFormats	Array<string>	是	否	支持的图片格式，包括：png，jpeg，bmp，gif，webp，dng。

getImageInfo

getImageInfo(index: number, callback: AsyncCallback<ImageInfo>): void

获取指定序号的图片信息，使用callback形式返回图片信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
index	number	是	创建图片源时的序号。
callback	AsyncCallback<ImageInfo>	是	回调函数。当获取图片信息成功，err为undefined，data为获取到的图片信息；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getImageInfo(0, (error: BusinessError, imageInfo: image.ImageInfo) => {
  if (error) {
    console.error(`Failed to obtain the image information.code is ${error.code}, message is ${error.message}`);
  } else {
    console.info('Succeeded in obtaining the image information.');
  }
})

getImageInfo

getImageInfo(callback: AsyncCallback<ImageInfo>): void

获取图片信息，使用callback形式返回图片信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<ImageInfo>	是	回调函数。当获取图片信息成功，err为undefined，data为获取到的图片信息；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getImageInfo((err: BusinessError, imageInfo: image.ImageInfo) => {
  if (err) {
    console.error(`Failed to obtain the image information.code is ${err.code}, message is ${err.message}`);
  } else {
    console.info('Succeeded in obtaining the image information.');
  }
})

getImageInfo

getImageInfo(index?: number): Promise<ImageInfo>

获取图片信息，使用Promise形式返回图片信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
index	number	否	创建图片源时的序号，不选择时默认为0。

返回值：

类型	说明
Promise<ImageInfo>	Promise对象，返回获取到的图片信息。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getImageInfo(0)
  .then((imageInfo: image.ImageInfo) => {
    console.info('Succeeded in obtaining the image information.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to obtain the image information.code is ${error.code}, message is ${error.message}`);
  })

getImageInfoSync¹²⁺

getImageInfoSync(index?: number): ImageInfo

获取指定序号的图片信息，使用同步形式返回图片信息。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
index	number	否	创建图片源时的序号，不选择时默认为0。

返回值：

类型	说明
ImageInfo	同步返回获取到的图片信息。

示例：

import image from "@ohos.multimedia.image";

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
let filePath: string = context.filesDir + "/test.jpg";
let imageSource = image.createImageSource(filePath);
let imageInfo = imageSource.getImageInfoSync(0);
if (imageInfo == undefined) {
  console.error('Failed to obtain the image information.');
} else {
  console.info('Succeeded in obtaining the image information.');
  console.info('imageInfo.size.height:' + imageInfo.size.height);
  console.info('imageInfo.size.width:' + imageInfo.size.width);
}

getImageProperty¹¹⁺

getImageProperty(key:PropertyKey, options?: ImagePropertyOptions): Promise<string>

获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果，仅支持JPEG和PNG文件，且需要包含exif信息。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	PropertyKey	是	图片属性名。
options	ImagePropertyOptions	否	图片属性，包括图片序号与默认属性值。

返回值：

类型	说明
Promise<string>	Promise对象，返回图片属性值，如获取失败则返回属性默认值。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed;
62980123	Images in EXIF format are not supported.

示例：

import { BusinessError } from '@ohos.base';

let options: image.ImagePropertyOptions = { index: 0, defaultValue: '9999' }
imageSourceApi.getImageProperty(image.PropertyKey.BITS_PER_SAMPLE, options)
.then((data: string) => {
  console.info('Succeeded in getting the value of the specified attribute key of the image.');
}).catch((error: BusinessError) => {
  console.error('Failed to get the value of the specified attribute key of the image.');
})

getImageProperty^(deprecated)

getImageProperty(key:string, options?: GetImagePropertyOptions): Promise<string>

获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果，仅支持JPEG和PNG文件，且需要包含exif信息。

说明：

从API version 11开始不再维护，建议使用getImageProperty代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	string	是	图片属性名。
options	GetImagePropertyOptions	否	图片属性，包括图片序号与默认属性值。

返回值：

类型	说明
Promise<string>	Promise对象，返回图片属性值，如获取失败则返回属性默认值。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getImageProperty("BitsPerSample")
  .then((data: string) => {
    console.info('Succeeded in getting the value of the specified attribute key of the image.');
  }).catch((error: BusinessError) => {
    console.error('Failed to get the value of the specified attribute key of the image.');
  })

getImageProperty^(deprecated)

getImageProperty(key:string, callback: AsyncCallback<string>): void

获取图片中给定索引处图像的指定属性键的值，用callback形式返回结果，仅支持JPEG和PNG文件，且需要包含exif信息。

说明：

从API version 11开始不再维护，建议使用getImageProperty代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	string	是	图片属性名。
callback	AsyncCallback<string>	是	回调函数，当获取图片属性值成功，err为undefined，data为获取到的图片属性值；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getImageProperty("BitsPerSample", (error: BusinessError, data: string) => {
  if (error) {
    console.error('Failed to get the value of the specified attribute key of the image.');
  } else {
    console.info('Succeeded in getting the value of the specified attribute key of the image.');
  }
})

getImageProperty^(deprecated)

getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback<string>): void

获取图片指定属性键的值，callback形式返回结果，仅支持JPEG和PNG文件，且需要包含exif信息。

说明：

从API version 11开始不再维护，建议使用getImageProperty代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	string	是	图片属性名。
options	GetImagePropertyOptions	是	图片属性，包括图片序号与默认属性值。
callback	AsyncCallback<string>	是	回调函数，当获取图片属性值成功，err为undefined，data为获取到的图片属性值；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

let property: image.GetImagePropertyOptions = { index: 0, defaultValue: '9999' }
imageSourceApi.getImageProperty("BitsPerSample", property, (error: BusinessError, data: string) => {
  if (error) {
    console.error('Failed to get the value of the specified attribute key of the image.');
  } else {
    console.info('Succeeded in getting the value of the specified attribute key of the image.');
  }
})

getImageProperties¹²⁺

getImageProperties(key: Array<PropertyKey>): Promise<Record<PropertyKey, string|null>>

批量获取图片中的指定属性键的值，用Promise形式返回结果。支持JPEG、PNG文件，且需要包含exif信息。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	Array<PropertyKey>	是	图片属性名的数组。

返回值：

类型	说明
Promise<Record<PropertyKey, string \| null>>	Promise对象，返回图片属性值，如获取失败则返回null。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed;
62980096	The operation failed.
62980110	The image source data is incorrect.
62980113	Unknown image format.
62980116	Failed to decode the image.

示例：

import image from "@ohos.multimedia.image";
import { BusinessError } from '@ohos.base';

let key = [image.PropertyKey.IMAGE_WIDTH, image.PropertyKey.IMAGE_LENGTH];
imageSourceApi.getImageProperties(key).then((data) => {
  console.info(JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error(JSON.stringify(err));
});

modifyImageProperty¹¹⁺

modifyImageProperty(key: PropertyKey, value: string): Promise<void>

通过指定的键修改图片属性的值，使用Promise形式返回结果，仅支持JPEG文件，且需要包含exif信息。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	PropertyKey	是	图片属性名。
value	string	是	属性值。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;
62980123	Images in EXIF format are not supported.
62980135	The EXIF value is invalid.
62980146	The EXIF data failed to be written to the file.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.modifyImageProperty(image.PropertyKey.IMAGE_WIDTH, "120").then(() => {
  imageSourceApi.getImageProperty(image.PropertyKey.IMAGE_WIDTH).then((width: string) => {
    console.info(`ImageWidth is :${width}`);
  }).catch((error: BusinessError) => {
    console.error('Failed to get the Image Width.');
  })
}).catch((error: BusinessError) => {
  console.error('Failed to modify the Image Width');
})

modifyImageProperty^(deprecated)

modifyImageProperty(key: string, value: string): Promise<void>

通过指定的键修改图片属性的值，使用Promise形式返回结果，仅支持JPEG文件，且需要包含exif信息。

说明：

从API version 11开始不再维护，建议使用modifyImageProperty代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	string	是	图片属性名。
value	string	是	属性值。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.modifyImageProperty("ImageWidth", "120").then(() => {
  imageSourceApi.getImageProperty("ImageWidth").then((width: string) => {
    console.info(`ImageWidth is :${width}`);
  }).catch((error: BusinessError) => {
    console.error('Failed to get the Image Width.');
  })
}).catch((error: BusinessError) => {
  console.error('Failed to modify the Image Width');
})

modifyImageProperty^(deprecated)

modifyImageProperty(key: string, value: string, callback: AsyncCallback<void>): void

通过指定的键修改图片属性的值，callback形式返回结果，仅支持JPEG文件，且需要包含exif信息。

说明：

从API version 11开始不再维护，建议使用modifyImageProperty代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
key	string	是	图片属性名。
value	string	是	属性值。
callback	AsyncCallback<void>	是	回调函数，当修改图片属性值成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.modifyImageProperty("ImageWidth", "120", (err: BusinessError) => {
  if (err) {
    console.error(`Failed to modify the Image Width.code is ${err.code}, message is ${err.message}`);
  } else {
    console.info('Succeeded in modifying the Image Width.');
  }
})

modifyImageProperties¹²⁺

modifyImageProperties(records: Record<PropertyKey, string|null>): Promise<void>

批量通过指定的键修改图片属性的值，使用Promise形式返回结果。支持JPEG、PNG文件，且需要包含exif信息。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
records	Record<PropertyKey, string \| null>	是	包含图片属性名和属性值的数组。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed;
62980123	Images in EXIF format are not supported.
62980133	The EXIF data is out of range.
62980135	The EXIF value is invalid.
62980146	The EXIF data failed to be written to the file.

示例：

import image from "@ohos.multimedia.image";
import { BusinessError } from '@ohos.base';

let key: Record<PropertyKey, string|null> = {'ImageWidth':"1024", 'ImageLength':"2048"};
let checkKey = [image.PropertyKey.IMAGE_WIDTH, image.PropertyKey.IMAGE_LENGTH];
imageSourceApi.modifyImageProperties(key).then(() => {
  imageSourceApi.getImageProperties(checkKey).then((data) => {
    console.info(JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error(JSON.stringify(err));
  });
}).catch((err: BusinessError) => {
  console.error(JSON.stringify(err));
});

updateData⁹⁺

updateData(buf: ArrayBuffer, isFinished: boolean, offset: number, length: number): Promise<void>

更新增量数据，使用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。
isFinished	boolean	是	是否更新完。
offset	number	是	偏移量。
length	number	是	数组长。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

const array: ArrayBuffer = new ArrayBuffer(100);
imageSourceApi.updateData(array, false, 0, 10).then(() => {
  console.info('Succeeded in updating data.');
}).catch((err: BusinessError) => {
  console.error(`Failed to update data.code is ${err.code},message is ${err.message}`);
})

updateData⁹⁺

updateData(buf: ArrayBuffer, isFinished: boolean, offset: number, length: number, callback: AsyncCallback<void>): void

更新增量数据，callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
buf	ArrayBuffer	是	增量数据。
isFinished	boolean	是	是否更新完。
offset	number	是	偏移量。
length	number	是	数组长。
callback	AsyncCallback<void>	是	回调函数，当更新增量数据成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

const array: ArrayBuffer = new ArrayBuffer(100);
imageSourceApi.updateData(array, false, 0, 10, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to update data.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in updating data.');
  }
})

createPixelMap⁷⁺

createPixelMap(options?: DecodingOptions): Promise<PixelMap>

通过图片解码参数创建PixelMap对象。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
options	DecodingOptions	否	解码参数。

返回值：

类型	说明
Promise<PixelMap>	Promise对象，返回PixelMap。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.createPixelMap().then((pixelMap: image.PixelMap) => {
  console.info('Succeeded in creating pixelMap object through image decoding parameters.');
}).catch((error: BusinessError) => {
  console.error('Failed to create pixelMap object through image decoding parameters.');
})

createPixelMap⁷⁺

createPixelMap(callback: AsyncCallback<PixelMap>): void

通过默认参数创建PixelMap对象，使用callback形式返回结果。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<PixelMap>	是	回调函数，当创建PixelMap对象成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.createPixelMap((err: BusinessError, pixelMap: image.PixelMap) => {
  if (err) {
    console.error(`Failed to create pixelMap.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in creating pixelMap object.');
  }
})

createPixelMap⁷⁺

createPixelMap(options: DecodingOptions, callback: AsyncCallback<PixelMap>): void

通过图片解码参数创建PixelMap对象。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
options	DecodingOptions	是	解码参数。
callback	AsyncCallback<PixelMap>	是	回调函数，当创建PixelMap对象成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

let decodingOptions: image.DecodingOptions = {
  sampleSize: 1,
  editable: true,
  desiredSize: { width: 1, height: 2 },
  rotate: 10,
  desiredPixelFormat: 3,
  desiredRegion: { size: { height: 1, width: 2 }, x: 0, y: 0 },
  index: 0
};
imageSourceApi.createPixelMap(decodingOptions, (err: BusinessError, pixelMap: image.PixelMap) => {
  if (err) {
    console.error(`Failed to create pixelMap.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in creating pixelMap object.');
  }
})

createPixelMapSync¹²⁺

createPixelMapSync(options?: DecodingOptions): PixelMap

通过图片解码参数同步创建PixelMap对象。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
options	DecodingOptions	否	解码参数。

返回值：

类型	说明
PixelMap	用于同步返回创建结果。

示例：

import image from "@ohos.multimedia.image";

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
let filePath: string = context.filesDir + "/test.jpg";
let imageSource = image.createImageSource(filePath);
let decodingOptions: image.DecodingOptions = {
  sampleSize: 1,
  editable: true,
  desiredSize: { width: 1, height: 2 },
  rotate: 10,
  desiredPixelFormat: 3,
  desiredRegion: { size: { height: 1, width: 2 }, x: 0, y: 0 },
  index: 0
};
let pixelmap = imageSource.createPixelMapSync(decodingOptions);
if (pixelmap != undefined) {
  console.info('Succeeded in creating pixelMap object.');
} else {
  console.info('Failed to create pixelMap.');
}

createPixelMapList¹⁰⁺

createPixelMapList(options?: DecodingOptions): Promise<Array<PixelMap>>

通过图片解码参数创建PixelMap数组。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
options	DecodingOptions	否	解码参数。

返回值：

类型	说明
Promise<Array<PixelMap>>	异步返回PixeMap数组。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980099	The shared memory data is abnormal.
62980101	The image data is abnormal.
62980103	The image data is not supported.
62980106	The image is too large.
62980109	Failed to crop the image.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.
62980173	The DMA memory does not exist.
62980174	The DMA memory data is abnormal.

示例：

import { BusinessError } from '@ohos.base';

let decodeOpts: image.DecodingOptions = {
  sampleSize: 1,
  editable: true,
  desiredSize: { width: 198, height: 202 },
  rotate: 0,
  desiredPixelFormat: 3,
  index: 0,
};
imageSourceApi.createPixelMapList(decodeOpts).then((pixelMapList: Array<image.PixelMap>) => {
  console.info('Succeeded in creating pixelMapList object.');
}).catch((err: BusinessError) => {
  console.error(`Failed to create pixelMapList object.code is ${err.code},message is ${err.message}`);
})

createPixelMapList¹⁰⁺

createPixelMapList(callback: AsyncCallback<Array<PixelMap>>): void

通过默认参数创建PixelMap数组，使用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<PixelMap>>	是	回调函数，当创建PixelMap对象数组成功，err为undefined，data为获取到的PixelMap对象数组；否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980099	The shared memory data is abnormal.
62980101	The image data is abnormal.
62980103	The image data is not supported.
62980106	The image is too large.
62980109	Failed to crop the image.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.
62980173	The DMA memory does not exist.
62980174	The DMA memory data is abnormal.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.createPixelMapList((err: BusinessError, pixelMapList: Array<image.PixelMap>) => {
  if (err) {
    console.error(`Failed to create pixelMapList object.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in creating pixelMapList object.');
  }
})

createPixelMapList¹⁰⁺

createPixelMapList(options: DecodingOptions, callback: AsyncCallback<Array<PixelMap>>): void

通过图片解码参数创建PixelMap数组，使用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
options	DecodingOptions	是	解码参数。
callback	AsyncCallback<Array<PixelMap>>	是	回调函数，当创建PixelMap对象数组成功，err为undefined，data为获取到的PixelMap对象数组；否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980099	The shared memory data is abnormal.
62980101	The image data is abnormal.
62980103	The image data is not supported.
62980106	The image is too large.
62980109	Failed to crop the image.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.
62980173	The DMA memory does not exist.
62980174	The DMA memory data is abnormal.

示例：

import { BusinessError } from '@ohos.base';

let decodeOpts: image.DecodingOptions = {
  sampleSize: 1,
  editable: true,
  desiredSize: { width: 198, height: 202 },
  rotate: 0,
  desiredPixelFormat: 3,
  index: 0,
};
imageSourceApi.createPixelMapList(decodeOpts, (err: BusinessError, pixelMapList: Array<image.PixelMap>) => {
  if (err) {
    console.error(`Failed to create pixelMapList object.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in creating pixelMapList object.');
  }
})

getDelayTimeList¹⁰⁺

getDelayTimeList(callback: AsyncCallback<Array<number>>): void

获取图像延迟时间数组，使用callback形式返回结果。此接口仅用于gif图片和webp图片。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<number>>	是	回调函数，当获取图像延迟时间数组成功，err为undefined，data为获取到的图像延时时间数组；否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.
62980149	Invalid media parameter.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getDelayTimeList((err: BusinessError, delayTimes: Array<number>) => {
  if (err) {
    console.error(`Failed to get delayTimes object.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in getting delayTimes object.');
  }
})

getDelayTimeList¹⁰⁺

getDelayTimeList(): Promise<Array<number>>

获取图像延迟时间数组，使用Promise形式返回结果。此接口仅用于gif图片和webp图片。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
Promise<Array<number>>	Promise对象，返回延迟时间数组。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.
62980149	Invalid media parameter.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getDelayTimeList().then((delayTimes: Array<number>) => {
  console.info('Succeeded in getting delayTimes object.');
}).catch((err: BusinessError) => {
  console.error(`Failed to get delayTimes object.code is ${err.code},message is ${err.message}`);
})

getFrameCount¹⁰⁺

getFrameCount(callback: AsyncCallback<number>): void

获取图像帧数，使用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数，当获取图像帧数成功，err为undefined，data为获取到的图像帧数；否则为错误对象。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getFrameCount((err: BusinessError, frameCount: number) => {
  if (err) {
    console.error(`Failed to get frame count.code is ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in getting frame count.');
  }
})

getFrameCount¹⁰⁺

getFrameCount(): Promise<number>

获取图像帧数，使用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
Promise<number>	Promise对象，返回图像帧数。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980110	The image source data is incorrect.
62980111	The image source data is incomplete.
62980112	The image format does not match.
62980113	Unknown image format.
62980115	Invalid image parameter.
62980116	Failed to decode the image.
62980118	Failed to create the image plugin.
62980122	The image decoding header is abnormal.
62980137	Invalid media operation.

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.getFrameCount().then((frameCount: number) => {
  console.info('Succeeded in getting frame count.');
}).catch((err: BusinessError) => {
  console.error(`Failed to get frame count.code is ${err.code},message is ${err.message}`);
})

getDisposalTypeList¹²⁺

getDisposalTypeList(): Promise<Array<number>>

获取图像帧过渡模式数组，使用Promise形式返回结果。此接口仅用于gif图片。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
Promise<Array<number>>	Promise对象，返回帧过渡模式数组。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	The parameter check failed.
62980096	The operation failed.
62980101	The image data is abnormal.
62980137	Invalid media operation.
62980149	Invalid image source mime type.

示例：

import { BusinessError } from '@ohos.base';
imageSourceApi.getDisposalTypeList().then((disposalTypes: Array<number>) => {
  console.info('Succeeded in getting disposalTypes object.');
}).catch((err: BusinessError) => {
  console.error(`Failed to get disposalTypes object.code ${err.code},message is ${err.message}`);
})

release

release(callback: AsyncCallback<void>): void

释放图片源实例，使用callback形式返回结果。

ArkTS有内存回收机制，ImageSource对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

系统能力： SystemCapability.Multimedia.Image.ImageSource

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，当资源释放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.release((err: BusinessError) => {
  if (err) {
    console.error(`Failed to release the image source instance.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in releasing the image source instance.');
  }
})

release

release(): Promise<void>

释放图片源实例，使用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageSource

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

imageSourceApi.release().then(() => {
  console.info('Succeeded in releasing the image source instance.');
}).catch((error: BusinessError) => {
  console.error(`Failed to release the image source instance.code ${error.code},message is ${error.message}`);
})

image.createImagePacker

createImagePacker(): ImagePacker

创建ImagePacker实例。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

返回值：

类型	说明
ImagePacker	返回ImagePacker实例。

示例：

const imagePackerApi: image.ImagePacker = image.createImagePacker();

ImagePacker

图片打包器类，用于图片压缩和打包。在调用ImagePacker的方法前，需要先通过createImagePacker构建一个ImagePacker实例，当前支持格式有：jpeg、webp、png。

属性

系统能力： SystemCapability.Multimedia.Image.ImagePacker

名称	类型	可读	可写	说明
supportedFormats	Array<string>	是	否	图片打包支持的格式 jpeg、webp、png。

packing

packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<ArrayBuffer>): void

图片压缩或重新打包，使用callback形式返回结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	ImageSource	是	打包的图片源。
option	PackingOption	是	设置打包参数。
callback	AsyncCallback<ArrayBuffer>	是	回调函数，当图片打包成功，err为undefined，data为获取到的压缩或打包数据；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
let filePath: string = context.filesDir + "/test.jpg";
const imageSourceApi: image.ImageSource = image.createImageSource(filePath);
let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 };
imagePackerApi.packing(imageSourceApi, packOpts, (err: BusinessError, data: ArrayBuffer) => {
  if (err) {
    console.error(`Failed to pack the image.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in packing the image.');
  }
})

packing

packing(source: ImageSource, option: PackingOption): Promise<ArrayBuffer>

图片压缩或重新打包，使用Promise形式返回结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	ImageSource	是	打包的图片源。
option	PackingOption	是	设置打包参数。

返回值：

类型	说明
Promise<ArrayBuffer>	Promise对象，返回压缩或打包后的数据。

示例：

import { BusinessError } from '@ohos.base';

const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
let filePath: string = context.filesDir + "/test.jpg";
const imageSourceApi: image.ImageSource = image.createImageSource(filePath);
let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 }
imagePackerApi.packing(imageSourceApi, packOpts)
  .then((data: ArrayBuffer) => {
    console.info('Succeeded in packing the image.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to pack the image.code ${error.code},message is ${error.message}`);
  })

packing⁸⁺

packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBuffer>): void

图片压缩或重新打包，使用callback形式返回结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	PixelMap	是	打包的PixelMap资源。
option	PackingOption	是	设置打包参数。
callback	AsyncCallback<ArrayBuffer>	是	回调函数，当图片打包成功，err为undefined，data为获取到的压缩或打包数据；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap: image.PixelMap) => {
  let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 }
  imagePackerApi.packing(pixelMap, packOpts, (err: BusinessError, data: ArrayBuffer) => {
    if (err) {
      console.error(`Failed to pack the image.code ${err.code},message is ${err.message}`);
    } else {
      console.info('Succeeded in packing the image.');
    }
  })
}).catch((error: BusinessError) => {
  console.error(`Failed to create the PixelMap.code ${error.code},message is ${error.message}`);
})

packing⁸⁺

packing(source: PixelMap, option: PackingOption): Promise<ArrayBuffer>

图片压缩或重新打包，使用Promise形式返回结果。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	PixelMap	是	打包的PixelMap源。
option	PackingOption	是	设置打包参数。

返回值：

类型	说明
Promise<ArrayBuffer>	Promise对象，返回压缩或打包后的数据。

示例：

import { BusinessError } from '@ohos.base';

const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap: image.PixelMap) => {
  let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 }
  imagePackerApi.packing(pixelMap, packOpts)
    .then((data: ArrayBuffer) => {
      console.info('Succeeded in packing the image.');
    }).catch((error: BusinessError) => {
    console.error(`Failed to pack the image.code ${error.code},message is ${error.message}`);
  })
}).catch((error: BusinessError) => {
  console.error(`Failed to create PixelMap.code ${error.code},message is ${error.message}`);
})

release

release(callback: AsyncCallback<void>): void

释放图片打包实例，使用callback形式返回结果。

ArkTS有内存回收机制，ImagePacker对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，当释放图片打包实例成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

imagePackerApi.release((err: BusinessError)=>{
  if (err) {
    console.error(`Failed to release image packaging.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in releasing image packaging.');
  }
})

release

release(): Promise<void>

释放图片打包实例，使用Promise形式返回释放结果。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

imagePackerApi.release().then(() => {
  console.info('Succeeded in releasing image packaging.');
}).catch((error: BusinessError) => {
  console.error(`Failed to release image packaging.code ${error.code},message is ${error.message}`);
})

packToFile¹¹⁺

packToFile(source: ImageSource, fd: number, options: PackingOption, callback: AsyncCallback<void>): void

指定打包参数，将ImageSource图片源编码后直接打包进文件。使用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	ImageSource	是	打包的图片源。
fd	number	是	文件描述符。
options	PackingOption	是	设置打包参数。
callback	AsyncCallback<void>	是	回调函数，当打包进文件成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base'
import fs from '@ohos.file.fs'

const context: Context = getContext(this);
//此处'test.png'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
const path: string = context.filesDir + "/test.png";
const imageSourceApi: image.ImageSource = image.createImageSource(path);
let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 };
const filePath: string = context.filesDir + "/image_source.jpg";
let file = fs.openSync(filePath, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
const imagePackerApi: image.ImagePacker = image.createImagePacker();
imagePackerApi.packToFile(imageSourceApi, file.fd, packOpts, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to pack the image to file.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in packing the image to file.');
  }
})

packToFile¹¹⁺

packToFile (source: ImageSource, fd: number, options: PackingOption): Promise<void>

指定打包参数，将ImageSource图片源编码后直接打包进文件。使用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	ImageSource	是	打包的图片源。
fd	number	是	文件描述符。
options	PackingOption	是	设置打包参数。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base'
import fs from '@ohos.file.fs'

const context: Context = getContext(this);
//此处'test.png'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
const path: string = context.filesDir + "/test.png";
const imageSourceApi: image.ImageSource = image.createImageSource(path);
let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 };
const filePath: string = context.filesDir + "/image_source.jpg";
let file = fs.openSync(filePath, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
const imagePackerApi: image.ImagePacker = image.createImagePacker();
imagePackerApi.packToFile(imageSourceApi, file.fd, packOpts).then(() => {
  console.info('Succeeded in packing the image to file.');
}).catch((error: BusinessError) => { 
  console.error(`Failed to pack the image to file.code ${error.code},message is ${error.message}`);
})

packToFile¹¹⁺

packToFile (source: PixelMap, fd: number, options: PackingOption, callback: AsyncCallback<void>): void;

指定打包参数，将PixelMap图片源编码后直接打包进文件。使用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	PixelMap	是	打包的PixelMap资源。
fd	number	是	文件描述符。
options	PackingOption	是	设置打包参数。
callback	AsyncCallback<void>	是	回调函数，当打包图片进文件成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base'
import fs from '@ohos.file.fs'

const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
const context: Context = getContext(this);
const path: string = context.filesDir + "/pixel_map.jpg";
image.createPixelMap(color, opts).then((pixelmap: image.PixelMap) => {
  let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 }
  let file = fs.openSync(path, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
  const imagePackerApi: image.ImagePacker = image.createImagePacker();
  imagePackerApi.packToFile(pixelmap, file.fd, packOpts, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to pack the image to file.code ${err.code},message is ${err.message}`);
    } else {
      console.info('Succeeded in packing the image to file.');
    }
  })
})

packToFile¹¹⁺

packToFile (source: PixelMap, fd: number, options: PackingOption): Promise<void>

指定打包参数，将PixelMap图片源编码后直接打包进文件。使用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

参数：

参数名	类型	必填	说明
source	PixelMap	是	打包的PixelMap资源。
fd	number	是	文件描述符。
options	PackingOption	是	设置打包参数。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base'
import fs from '@ohos.file.fs'

const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
const context: Context = getContext(this);
const path: string = context.filesDir + "/pixel_map.jpg";
image.createPixelMap(color, opts).then((pixelmap: image.PixelMap) => {
  let packOpts: image.PackingOption = { format: "image/jpeg", quality: 98 }
  let file = fs.openSync(path, fs.OpenMode.CREATE | fs.OpenMode.READ_WRITE);
  const imagePackerApi: image.ImagePacker = image.createImagePacker();
  imagePackerApi.packToFile(pixelmap, file.fd, packOpts)
    .then(() => {
      console.info('Succeeded in packing the image to file.');
    }).catch((error: BusinessError) => {
    console.error(`Failed to pack the image to file.code ${error.code},message is ${error.message}`);
  })
})

image.createImageReceiver¹¹⁺

createImageReceiver(size: Size, format: ImageFormat, capacity: number): ImageReceiver

通过图片大小、图片格式、容量创建ImageReceiver实例。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
size	Size	是	图像的默认大小。
format	ImageFormat	是	图像格式，取值为ImageFormat常量（目前仅支持 ImageFormat:JPEG，实际返回格式由生产者决定，如相机）。
capacity	number	是	同时访问的最大图像数。

返回值：

类型	说明
ImageReceiver	如果操作成功，则返回ImageReceiver实例。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;

示例：

let size: image.Size = {
  height: 8192,
  width: 8
}
let receiver: image.ImageReceiver = image.createImageReceiver(size, image.ImageFormat.JPEG, 8);

image.createImageReceiver^(deprecated)

createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver

通过宽、高、图片格式、容量创建ImageReceiver实例。

说明：

从API version 11开始不再维护，建议使用createImageReceiver代替。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
width	number	是	图像的默认宽度。
height	number	是	图像的默认高度。
format	number	是	图像格式，取值为ImageFormat常量（目前仅支持 ImageFormat:JPEG，实际返回格式由生产者决定，如相机）。
capacity	number	是	同时访问的最大图像数。

返回值：

类型	说明
ImageReceiver	如果操作成功，则返回ImageReceiver实例。

示例：

let receiver: image.ImageReceiver = image.createImageReceiver(8192, 8, image.ImageFormat.JPEG, 8);

ImageReceiver⁹⁺

图像接收类，用于获取组件surface id，接收最新的图片和读取下一张图片，以及释放ImageReceiver实例。

在调用以下方法前需要先创建ImageReceiver实例。

属性

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

名称	类型	可读	可写	说明
size	Size	是	否	图片大小。
capacity	number	是	否	同时访问的图像数。
format	ImageFormat	是	否	图像格式。

getReceivingSurfaceId⁹⁺

getReceivingSurfaceId(callback: AsyncCallback<string>): void

用于获取一个surface id供Camera或其他组件使用。使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	回调函数，当获取surface id成功，err为undefined，data为获取到的surface id；否则为错误对象。

示例:

import { BusinessError } from '@ohos.base';

receiver.getReceivingSurfaceId((err: BusinessError, id: string) => {
  if (err) {
    console.error(`Failed to get the ReceivingSurfaceId.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in getting the ReceivingSurfaceId.');
  }
});

getReceivingSurfaceId⁹⁺

getReceivingSurfaceId(): Promise<string>

用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

返回值：

类型	说明
Promise<string>	Promise对象，返回surface id。

示例：

import { BusinessError } from '@ohos.base';

receiver.getReceivingSurfaceId().then((id: string) => { 
  console.info('Succeeded in getting the ReceivingSurfaceId.');
}).catch((error: BusinessError) => {
  console.error(`Failed to get the ReceivingSurfaceId.code ${error.code},message is ${error.message}`);
})

readLatestImage⁹⁺

readLatestImage(callback: AsyncCallback<Image>): void

从ImageReceiver读取最新的图片，并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Image>	是	回调函数，当读取最新图片成功，err为undefined，data为获取到的最新图片；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

receiver.readLatestImage((err: BusinessError, img: image.Image) => {
  if (err) {
    console.error(`Failed to read the latest Image.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in reading the latest Image.');
  }
});

readLatestImage⁹⁺

readLatestImage(): Promise<Image>

从ImageReceiver读取最新的图片，并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

返回值：

类型	说明
Promise<Image>	Promise对象，返回最新图片。

示例：

import { BusinessError } from '@ohos.base';

receiver.readLatestImage().then((img: image.Image) => {
  console.info('Succeeded in reading the latest Image.');
}).catch((error: BusinessError) => {
  console.error(`Failed to read the latest Image.code ${error.code},message is ${error.message}`);
})

readNextImage⁹⁺

readNextImage(callback: AsyncCallback<Image>): void

从ImageReceiver读取下一张图片，并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Image>	是	回调函数，当获取下一张图片成功，err为undefined，data为获取到的下一张图片；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

receiver.readNextImage((err: BusinessError, img: image.Image) => {
  if (err) {
    console.error(`Failed to read the next Image.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in reading the next Image.');
  }
});

readNextImage⁹⁺

readNextImage(): Promise<Image>

从ImageReceiver读取下一张图片，并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

返回值：

类型	说明
Promise<Image>	Promise对象，返回下一张图片。

示例：

import { BusinessError } from '@ohos.base';

receiver.readNextImage().then((img: image.Image) => {
  console.info('Succeeded in reading the next Image.');
}).catch((error: BusinessError) => {
  console.error(`Failed to read the next Image.code ${error.code},message is ${error.message}`);
})

on⁹⁺

on(type: 'imageArrival', callback: AsyncCallback<void>): void

接收图片时注册回调。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
type	string	是	注册事件的类型，固定为'imageArrival'，接收图片时触发。
callback	AsyncCallback<void>	是	回调函数，当注册事件触发成功，err为undefined，否则为错误对象。

示例：

receiver.on('imageArrival', () => {
  // image arrival, do something.
})

release⁹⁺

release(callback: AsyncCallback<void>): void

释放ImageReceiver实例并使用回调返回结果。

ArkTS有内存回收机制，ImageReceiver对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，当释放ImageReceiver实例成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base'

receiver.release((err: BusinessError) => {
  if (err) {
    console.error(`Failed to release the receiver.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in releaseing the receiver.');
  }
})

release⁹⁺

release(): Promise<void>

释放ImageReceiver实例并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

receiver.release().then(() => {
  console.info('Succeeded in releaseing the receiver.');
}).catch((error: BusinessError) => {
  console.error(`Failed to release the receiver.code ${error.code},message is ${error.message}`);
})

image.createImageCreator¹¹⁺

createImageCreator(size: Size, format: ImageFormat, capacity: number): ImageCreator

通过图片大小、图片格式、容量创建ImageCreator实例。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
size	Size	是	图像的默认大小。
format	ImageFormat	是	图像格式，如YCBCR_422_SP，JPEG。
capacity	number	是	同时访问的最大图像数。

返回值：

类型	说明
ImageCreator	如果操作成功，则返回ImageCreator实例。

错误码：

以下错误码的详细介绍请参见Image错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;

示例：

let size: image.Size = {
  height: 8192,
  width: 8
}
let creator: image.ImageCreator = image.createImageCreator(size, image.ImageFormat.JPEG, 8);

image.createImageCreator^(deprecated)

createImageCreator(width: number, height: number, format: number, capacity: number): ImageCreator

通过宽、高、图片格式、容量创建ImageCreator实例。

说明：

从API version 11开始不再维护，建议使用createImageCreator代替。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
width	number	是	图像的默认宽度。
height	number	是	图像的默认高度。
format	number	是	图像格式，如YCBCR_422_SP，JPEG。
capacity	number	是	同时访问的最大图像数。

返回值：

类型	说明
ImageCreator	如果操作成功，则返回ImageCreator实例。

示例：

let creator: image.ImageCreator = image.createImageCreator(8192, 8, image.ImageFormat.JPEG, 8);

ImageCreator⁹⁺

图像创建模块，用于请求图像原生数据区域，并开放给应用编译原生图像数据的能力。在调用以下方法前需要先创建ImageCreator实例，ImageCreator不支持多线程。

属性

系统能力： SystemCapability.Multimedia.Image.ImageCreator

名称	类型	可读	可写	说明
capacity	number	是	否	同时访问的图像数。
format	ImageFormat	是	否	图像格式。

dequeueImage⁹⁺

dequeueImage(callback: AsyncCallback<Image>): void

从空闲队列中获取buffer图片，用于绘制UI内容，并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Image>	是	回调函数，当获取最新图片成功，err为undefined，data为获取到的最新图片；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

creator.dequeueImage((err: BusinessError, img: image.Image) => {
  if (err) {
    console.error(`Failed to dequeue the Image.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in dequeuing the Image.');
  }
});

dequeueImage⁹⁺

dequeueImage(): Promise<Image>

从空闲队列中获取buffer图片，用于绘制UI内容，并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

返回值：

类型	说明
Promise<Image>	Promise对象，返回最新图片。

示例：

import { BusinessError } from '@ohos.base';

creator.dequeueImage().then((img: image.Image) => {
  console.info('Succeeded in dequeuing the Image.');
}).catch((error: BusinessError) => {
  console.error(`Failed to dequeue the Image.code ${error.code},message is ${error.message}`);
})

queueImage⁹⁺

queueImage(interface: Image, callback: AsyncCallback<void>): void

将绘制好的图片放入Dirty队列，并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
interface	Image	是	绘制好的buffer图像。
callback	AsyncCallback<void>	是	回调函数，当将图片放入Dirty队列成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

creator.dequeueImage().then((img: image.Image) => {
  //绘制图片
  img.getComponent(4).then((component : image.Component) => {
    let bufferArr: Uint8Array = new Uint8Array(component.byteBuffer);
    for (let i = 0; i < bufferArr.length; i += 4) {
      bufferArr[i] = 0; //B
      bufferArr[i + 1] = 0; //G
      bufferArr[i + 2] = 255; //R
      bufferArr[i + 3] = 255; //A
    }
  })
  creator.queueImage(img, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to queue the Image.code ${err.code},message is ${err.message}`);
    } else {
      console.info('Succeeded in queuing the Image.');
    }
  })
})

queueImage⁹⁺

queueImage(interface: Image): Promise<void>

将绘制好的图片放入Dirty队列，并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
interface	Image	是	绘制好的buffer图像。

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

creator.dequeueImage().then((img: image.Image) => {
  //绘制图片
  img.getComponent(4).then((component: image.Component) => {
    let bufferArr: Uint8Array = new Uint8Array(component.byteBuffer);
    for (let i = 0; i < bufferArr.length; i += 4) {
      bufferArr[i] = 0; //B
      bufferArr[i + 1] = 0; //G
      bufferArr[i + 2] = 255; //R
      bufferArr[i + 3] = 255; //A
    }
  })
  creator.queueImage(img).then(() => {
    console.info('Succeeded in queuing the Image.');
  }).catch((error: BusinessError) => {
    console.error(`Failed to queue the Image.code ${error.code},message is ${error.message}`);
  })
})

on⁹⁺

on(type: 'imageRelease', callback: AsyncCallback<void>): void

监听imageRelease事件，并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
type	string	是	监听事件类型，如'imageRelease'。
callback	AsyncCallback<void>	是	回调函数，当监听时间触发成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

creator.on('imageRelease', (err: BusinessError) => {
  if (err) {
    console.error(`Failed to get the imageRelease callback.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in getting imageRelease callback.');
  }
})

release⁹⁺

release(callback: AsyncCallback<void>): void

释放当前图像，并使用callback返回结果。

ArkTS有内存回收机制，ImageCreator对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，当图像释放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

creator.release((err: BusinessError) => {
  if (err) {
    console.error(`Failed to release the creator.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in releasing creator.');
  }
});

release⁹⁺

release(): Promise<void>

释放当前图像，并使用promise返回结果。

系统能力： SystemCapability.Multimedia.Image.ImageCreator

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

creator.release().then(() => {
  console.info('Succeeded in releasing creator.');
}).catch((error: BusinessError) => {
  console.error(`Failed to release the creator.code ${error.code},message is ${error.message}`);
})

Image⁹⁺

提供基本的图像操作，包括获取图像信息、读写图像数据。调用readNextImage和readLatestImage接口时会返回image。

属性

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	可读	可写	说明
clipRect	Region	是	是	要裁剪的图像区域。
size	Size	是	否	图像大小。
format	number	是	否	图像格式，参考OH_NativeBuffer_Format。
timestamp¹²⁺	number	是	否	图像时间戳。

getComponent⁹⁺

getComponent(componentType: ComponentType, callback: AsyncCallback<Component>): void

根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
componentType	ComponentType	是	图像的组件类型。（目前仅支持 ComponentType:JPEG，实际返回格式由生产者决定，如相机）
callback	AsyncCallback<Component>	是	回调函数，当返回组件缓冲区成功，err为undefined，data为获取到的组件缓冲区；否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

img.getComponent(4, (err: BusinessError, component: image.Component) => {
  if (err) {
    console.error(`Failed to get the component.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in getting component.');
  }
})

getComponent⁹⁺

getComponent(componentType: ComponentType): Promise<Component>

根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
componentType	ComponentType	是	图像的组件类型。（目前仅支持 ComponentType:JPEG，实际返回格式由生产者决定，如相机）

返回值：

类型	说明
Promise<Component>	Promise对象，返回组件缓冲区。

示例：

import { BusinessError } from '@ohos.base';

img.getComponent(4).then((component: image.Component) => {
  console.info('Succeeded in getting component.');
}).catch((error: BusinessError) => {
  console.error(`Failed to get the component.code ${error.code},message is ${error.message}`);
})

release⁹⁺

release(callback: AsyncCallback<void>): void

释放当前图像并使用callback返回结果。

在接收另一个图像前必须先释放对应资源。

ArkTS有内存回收机制，Image对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数，当图像释放成功，err为undefined，否则为错误对象。

示例：

import { BusinessError } from '@ohos.base';

img.release((err: BusinessError) => {
  if (err) {
    console.error(`Failed to release the image instance.code ${err.code},message is ${err.message}`);
  } else {
    console.info('Succeeded in releasing the image instance.');
  }
})

release⁹⁺

release(): Promise<void>

释放当前图像并使用Promise方式返回结果。

在接收另一个图像前必须先释放对应资源。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Promise<void>	Promise对象。无返回结果的Promise对象。

示例：

import { BusinessError } from '@ohos.base';

img.release().then(() => {
  console.info('Succeeded in releasing the image instance.');
}).catch((error: BusinessError) => {
  console.error(`Failed to release the image instance.code ${error.code},message is ${error.message}`);
})

PositionArea⁷⁺

表示图片指定区域内的数据。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
pixels	ArrayBuffer	否	否	像素。
offset	number	否	否	偏移量。
stride	number	否	否	跨距，内存中每行像素所占的空间。stride >= region.size.width*4。
region	Region	否	否	区域，按照区域读写。写入的区域宽度加X坐标不能大于原图的宽度，写入的区域高度加Y坐标不能大于原图的高度。

ImageInfo

表示图片信息。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
size⁶⁺	Size	否	否	图片大小。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
density⁹⁺	number	否	否	像素密度，单位为ppi。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
stride¹¹⁺	number	否	否	跨距，内存中每行像素所占的空间。stride >= region.size.width4 原子化服务API：* 从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
pixelFormat¹²⁺	PixelMapFormat	否	否	像素格式。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
alphaType¹²⁺	AlphaType	否	否	透明度。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
mimeType¹²⁺	string	否	否	图片真实格式（MIME type）。
isHdr¹²⁺	boolean	否	否	图片是否为高动态范围（HDR）。对于ImageSource，代表源图片是否为HDR；对于PixelMap，代表解码后的pixelmap是否为HDR。

Size

表示图片尺寸。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
height	number	否	否	输出图片的高，单位：像素。
width	number	否	否	输出图片的宽，单位：像素。

PixelMapFormat⁷⁺

枚举，图片像素格式。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
UNKNOWN	0	未知格式。
RGB_565	2	格式为RGB_565
RGBA_8888	3	格式为RGBA_8888
BGRA_8888⁹⁺	4	格式为BGRA_8888
RGB_888⁹⁺	5	格式为RGB_888
ALPHA_8⁹⁺	6	格式为ALPHA_8
RGBA_F16⁹⁺	7	格式为RGBA_F16
NV21⁹⁺	8	格式为NV21
NV12⁹⁺	9	格式为NV12

AlphaType⁹⁺

枚举，图像的透明度类型。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
UNKNOWN	0	未知透明度。
OPAQUE	1	没有alpha或图片不透明。
PREMUL	2	RGB前乘alpha。
UNPREMUL	3	RGB不前乘alpha。

ScaleMode⁹⁺

枚举，图像的缩放模式。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
CENTER_CROP	1	缩放图像以填充目标图像区域并居中裁剪区域外的效果。
FIT_TARGET_SIZE	0	图像适合目标尺寸的效果。

SourceOptions⁹⁺

ImageSource的初始化选项。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
sourceDensity	number	否	否	ImageSource的密度。
sourcePixelFormat	PixelMapFormat	否	是	图片像素格式，默认值为UNKNOWN。
sourceSize	Size	否	是	图像像素大小，默认值为空。

InitializationOptions⁸⁺

PixelMap的初始化选项。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
alphaType⁹⁺	AlphaType	否	是	透明度。默认值为IMAGE_ALPHA_TYPE_PREMUL。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
editable	boolean	否	是	是否可编辑。默认值为false。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
srcPixelFormat¹²⁺	PixelMapFormat	否	是	传入的buffer数据的像素格式。默认值为BGRA_8888。
pixelFormat	PixelMapFormat	否	是	生成的pixelMap的像素格式。默认值为RGBA_8888。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
scaleMode⁹⁺	ScaleMode	否	是	缩略值。默认值为0。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
size	Size	否	否	创建图片大小。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。

DecodingOptions⁷⁺

图像解码设置选项。

系统能力： SystemCapability.Multimedia.Image.ImageSource

名称	类型	只读	可选	说明
sampleSize	number	否	是	缩略图采样大小，默认值为1。当前只能取1。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
rotate	number	否	是	旋转角度。默认值为0。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
editable	boolean	否	是	是否可编辑。默认值为false。当取值为false时，图片不可二次编辑，如crop等操作将失败。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
desiredSize	Size	否	是	期望输出大小。默认值为空。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
desiredRegion	Region	否	是	解码区域。默认值为空。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
desiredPixelFormat	PixelMapFormat	否	是	解码的像素格式。默认值为RGBA_8888。仅支持设置：RGBA_8888、BGRA_8888和RGB_565。有透明通道图片格式不支持设置RGB_565，如PNG、GIF、ICO和WEBP。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
index	number	否	是	解码图片序号。默认值为0。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
fitDensity⁹⁺	number	否	是	图像像素密度，单位为ppi。默认值为0。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。卡片能力：从API version 12开始，该接口支持在ArkTS卡片中使用。
desiredColorSpace¹¹⁺	colorSpaceManager.ColorSpaceManager	否	是	目标色彩空间。默认值为UNKNOWN。
desiredDynamicRange¹²⁺	DecodingDynamicRange	否	是	目标动态范围，默认值为SDR。通过CreateIncrementalSource创建的imagesource不支持设置此属性，默认解码为SDR内容。如果平台不支持HDR，设置无效，默认解码为SDR内容。

Region⁷⁺

表示区域信息。

卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
size	Size	否	否	区域大小。
x	number	否	否	区域横坐标。
y	number	否	否	区域纵坐标。

PackingOption

表示图片打包选项。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Multimedia.Image.ImagePacker

名称	类型	只读	可选	说明
format	string	否	否	目标格式。当前只支持"image/jpeg"、"image/webp" 和 "image/png"。
quality	number	否	否	JPEG编码中设定输出图片质量的参数，取值范围为0-100。0质量最低，100质量最高，质量越高生成图片所占空间越大。
bufferSize⁹⁺	number	否	是	接收编码数据的缓冲区大小，单位为Byte。如果不设置大小，默认为25M。如果编码图片超过25M，需要指定大小。bufferSize需大于编码后图片大小。使用packToFile不受此参数限制。
desiredDynamicRange¹²⁺	PackingDynamicRange	否	是	目标动态范围。默认值为SDR。

ImagePropertyOptions¹¹⁺

表示查询图片属性的索引。

系统能力： SystemCapability.Multimedia.Image.ImageSource

名称	类型	只读	可选	说明
index	number	是	是	图片序号。默认值为0。
defaultValue	string	是	是	默认属性值。默认值为空。

GetImagePropertyOptions^(deprecated)

表示查询图片属性的索引。

说明：

从API version 11开始不再维护，建议使用ImagePropertyOptions代替。

系统能力： SystemCapability.Multimedia.Image.ImageSource

名称	类型	只读	可选	说明
index	number	否	是	图片序号。默认值为0。
defaultValue	string	否	是	默认属性值。默认值为空。

PropertyKey⁷⁺

枚举，Exif（Exchangeable image file format）图片信息。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
BITS_PER_SAMPLE	"BitsPerSample"	每个像素比特数。
ORIENTATION	"Orientation"	图片方向。 - Top-left，图像未旋转。 - Top-right，镜像水平翻转。 - Bottom-right，图像旋转180°。 - Bottom-left，镜像垂直翻转。 - Left-top，镜像水平翻转再顺时针旋转270°。 - Right-top，顺时针旋转90°。 - Right-bottom，镜像垂直翻转再顺时针旋转90°。 - Left-bottom，顺时针旋转270°。 - 未定义值返回Unknown Value。
IMAGE_LENGTH	"ImageLength"	图片长度。
IMAGE_WIDTH	"ImageWidth"	图片宽度。
GPS_LATITUDE	"GPSLatitude"	图片纬度。
GPS_LONGITUDE	"GPSLongitude"	图片经度。
GPS_LATITUDE_REF	"GPSLatitudeRef"	纬度引用，例如N或S。
GPS_LONGITUDE_REF	"GPSLongitudeRef"	经度引用，例如W或E。
DATE_TIME_ORIGINAL⁹⁺	"DateTimeOriginal"	拍摄时间，例如2022:09:06 15:48:00。
EXPOSURE_TIME⁹⁺	"ExposureTime"	曝光时间，例如1/33 sec。
SCENE_TYPE⁹⁺	"SceneType"	拍摄场景模式，例如人像、风光、运动、夜景等。
ISO_SPEED_RATINGS⁹⁺	"ISOSpeedRatings"	ISO感光度，例如400。
F_NUMBER⁹⁺	"FNumber"	光圈值，例如f/1.8。
DATE_TIME¹⁰⁺	"DateTime"	日期时间。
GPS_TIME_STAMP¹⁰⁺	"GPSTimeStamp"	GPS时间戳。
GPS_DATE_STAMP¹⁰⁺	"GPSDateStamp"	GPS日期戳。
IMAGE_DESCRIPTION¹⁰⁺	"ImageDescription"	图像信息描述。
MAKE¹⁰⁺	"Make"	生产商。
MODEL¹⁰⁺	"Model"	设备型号。
PHOTO_MODE¹⁰⁺	"PhotoMode "	拍照模式。
SENSITIVITY_TYPE¹⁰⁺	"SensitivityType"	灵敏度类型。
STANDARD_OUTPUT_SENSITIVITY¹⁰⁺	"StandardOutputSensitivity"	标准输出灵敏度。
RECOMMENDED_EXPOSURE_INDEX¹⁰⁺	"RecommendedExposureIndex"	推荐曝光指数。
ISO_SPEED¹⁰⁺	"ISOSpeedRatings"	ISO速度等级。
APERTURE_VALUE¹⁰⁺	"ApertureValue"	光圈值。
EXPOSURE_BIAS_VALUE¹⁰⁺	"ExposureBiasValue"	曝光偏差值。
METERING_MODE¹⁰⁺	"MeteringMode"	测光模式。
LIGHT_SOURCE¹⁰⁺	"LightSource"	光源。
FLASH ¹⁰⁺	"Flash"	闪光灯,记录闪光灯状态。
FOCAL_LENGTH ¹⁰⁺	"FocalLength"	焦距。
USER_COMMENT ¹⁰⁺	"UserComment"	用户注释。
PIXEL_X_DIMENSION ¹⁰⁺	"PixelXDimension"	像素X尺寸。
PIXEL_Y_DIMENSION¹⁰⁺	"PixelYDimension"	像素Y尺寸。
WHITE_BALANCE ¹⁰⁺	"WhiteBalance"	白平衡。
FOCAL_LENGTH_IN_35_MM_FILM ¹⁰⁺	"FocalLengthIn35mmFilm"	焦距35毫米胶片。
CAPTURE_MODE ¹⁰⁺	"HwMnoteCaptureMode"	捕获模式，当前为只读属性。
PHYSICAL_APERTURE ¹⁰⁺	"HwMnotePhysicalAperture"	物理孔径，光圈大小，当前为只读属性。
ROLL_ANGLE ¹¹⁺	"HwMnoteRollAngle"	滚动角度，当前为只读属性。
PITCH_ANGLE¹¹⁺	"HwMnotePitchAngle"	俯仰角度，当前为只读属性。
SCENE_FOOD_CONF¹¹⁺	"HwMnoteSceneFoodConf"	拍照场景：食物，当前为只读属性。
SCENE_STAGE_CONF¹¹⁺	"HwMnoteSceneStageConf"	拍照场景：舞台，当前为只读属性。
SCENE_BLUE_SKY_CONF¹¹⁺	"HwMnoteSceneBlueSkyConf"	拍照场景：蓝天，当前为只读属性。
SCENE_GREEN_PLANT_CONF¹¹⁺	"HwMnoteSceneGreenPlantConf"	拍照场景：绿植，当前为只读属性。
SCENE_BEACH_CONF¹¹⁺	"HwMnoteSceneBeachConf"	拍照场景：沙滩，当前为只读属性。
SCENE_SNOW_CONF¹¹⁺	"HwMnoteSceneSnowConf"	拍照场景：下雪，当前为只读属性。
SCENE_SUNSET_CONF¹¹⁺	"HwMnoteSceneSunsetConf"	拍照场景：日落，当前为只读属性。
SCENE_FLOWERS_CONF¹¹⁺	"HwMnoteSceneFlowersConf"	拍照场景：花，当前为只读属性。
SCENE_NIGHT_CONF¹¹⁺	"HwMnoteSceneNightConf"	拍照场景：夜晚，当前为只读属性。
SCENE_TEXT_CONF¹¹⁺	"HwMnoteSceneTextConf"	拍照场景：文本，当前为只读属性。
FACE_COUNT¹¹⁺	"HwMnoteFaceCount"	人脸数量，当前为只读属性。
FOCUS_MODE¹¹⁺	"HwMnoteFocusMode"	对焦模式，当前为只读属性。
COMPRESSION ¹²⁺	"Compression"	图像压缩方案。
PHOTOMETRIC_INTERPRETATION ¹²⁺	"PhotometricInterpretation"	像素构成，例如 RGB 或 YCbCr。
STRIP_OFFSETS ¹²⁺	"StripOffsets"	每个strip的字节偏移量。
SAMPLES_PER_PIXEL ¹²⁺	"SamplesPerPixel"	每个像素的分量数。由于该标准适用于 RGB 和 YCbCr 图像，因此该标签的值设置为 3。在 JPEG 压缩数据中，使用 JPEG 标记代替该标签。
ROWS_PER_STRIP ¹²⁺	"RowsPerStrip"	每个strip的图像数据行数。
STRIP_BYTE_COUNTS ¹²⁺	"StripByteCounts"	每个图像数据带的总字节数。
X_RESOLUTION ¹²⁺	"XResolution"	图像宽度方向的分辨率。
Y_RESOLUTION ¹²⁺	"YResolution"	图像高度方向的分辨率。
PLANAR_CONFIGURATION ¹²⁺	"PlanarConfiguration"	表示像素组件的记录格式，chunky格式或是planar格式。
RESOLUTION_UNIT ¹²⁺	"ResolutionUnit"	用于测量XResolution和YResolution的单位。
TRANSFER_FUNCTION ¹²⁺	"TransferFunction"	图像的传递函数，通常用于颜色校正。
SOFTWARE ¹²⁺	"Software"	用于生成图像的软件的名称和版本。
ARTIST ¹²⁺	"Artist"	创建图像的用户名称。
WHITE_POINT ¹²⁺	"WhitePoint"	图像的白点色度。
PRIMARY_CHROMATICITIES ¹²⁺	"PrimaryChromaticities"	图像的主要颜色的色度。
YCBCR_COEFFICIENTS ¹²⁺	"YCbCrCoefficients"	从RGB到YCbCr图像数据的转换矩阵系数。
YCBCR_SUB_SAMPLING ¹²⁺	"YCbCrSubSampling"	色度分量与亮度分量的采样比率。
YCBCR_POSITIONING ¹²⁺	"YCbCrPositioning"	色度分量相对于亮度分量的位置。
REFERENCE_BLACK_WHITE ¹²⁺	"ReferenceBlackWhite"	参考黑点值和参考白点值。
COPYRIGHT ¹²⁺	"Copyright"	图像的版权信息。
JPEG_INTERCHANGE_FORMAT ¹²⁺	"JPEGInterchangeFormat"	JPEG压缩缩略图数据开始字节（SOI）的偏移。
JPEG_INTERCHANGE_FORMAT_LENGTH ¹²⁺	"JPEGInterchangeFormatLength"	JPEG压缩缩略图数据的字节数。
EXPOSURE_PROGRAM ¹²⁺	"ExposureProgram"	拍照时相机用来设置曝光的程序的类别。
SPECTRAL_SENSITIVITY ¹²⁺	"SpectralSensitivity"	表示所用相机的每个通道的光谱灵敏度。
OECF ¹²⁺	"OECF"	表示ISO 14524中规定的光电转换函数（OECF）。
EXIF_VERSION ¹²⁺	"ExifVersion"	支持的Exif标准版本。
DATE_TIME_DIGITIZED ¹²⁺	"DateTimeDigitized"	图像作为数字数据存储的日期和时间，格式为YYYY:MM:DD HH:MM:SS
COMPONENTS_CONFIGURATION ¹²⁺	"ComponentsConfiguration"	压缩数据的特定信息。
SHUTTER_SPEED ¹²⁺	"ShutterSpeedValue"	快门速度，以APEX（摄影曝光的加法系统）值表示。
BRIGHTNESS_VALUE ¹²⁺	"BrightnessValue"	图像的亮度值，以APEX单位表示。
MAX_APERTURE_VALUE ¹²⁺	"MaxApertureValue"	最小F数镜头。
SUBJECT_DISTANCE ¹²⁺	"SubjectDistance"	测量单位为米的主体距离。
SUBJECT_AREA ¹²⁺	"SubjectArea"	该标签指示整个场景中主要主体的位置和区域。
MAKER_NOTE ¹²⁺	"MakerNote"	Exif/DCF制造商使用的标签，用于记录任何所需信息。
SUBSEC_TIME ¹²⁺	"SubsecTime"	用于为DateTime标签记录秒的分数的标签。
SUBSEC_TIME_ORIGINAL ¹²⁺	"SubsecTimeOriginal"	用于为DateTimeOriginal标签记录秒的分数的标签。
SUBSEC_TIME_DIGITIZED ¹²⁺	"SubsecTimeDigitized"	用于为DateTimeDigitized标签记录秒的分数的标签。
FLASHPIX_VERSION ¹²⁺	"FlashpixVersion"	该标签表示FPXR文件支持的Flashpix格式版本，增强了设备兼容性。
COLOR_SPACE ¹²⁺	"ColorSpace"	色彩空间信息标签，通常记录为色彩空间指定符。
RELATED_SOUND_FILE ¹²⁺	"RelatedSoundFile"	与图像数据相关的音频文件的名称。
FLASH_ENERGY ¹²⁺	"FlashEnergy"	图像捕获时的闪光能量，以BCPS表示。
SPATIAL_FREQUENCY_RESPONSE ¹²⁺	"SpatialFrequencyResponse"	相机或输入设备的空间频率表。
FOCAL_PLANE_X_RESOLUTION ¹²⁺	"FocalPlaneXResolution"	图像宽度中每FocalPlaneResolutionUnit的像素。
FOCAL_PLANE_Y_RESOLUTION ¹²⁺	"FocalPlaneYResolution"	图像高度中每FocalPlaneResolutionUnit的像素。
FOCAL_PLANE_RESOLUTION_UNIT ¹²⁺	"FocalPlaneResolutionUnit"	测量FocalPlaneXResolution和FocalPlaneYResolution的单位。
SUBJECT_LOCATION ¹²⁺	"SubjectLocation"	主要对象相对于左边缘的位置。
EXPOSURE_INDEX ¹²⁺	"ExposureIndex"	捕获时选定的曝光指数。
SENSING_METHOD ¹²⁺	"SensingMethod"	相机上的图像传感器类型。
FILE_SOURCE ¹²⁺	"FileSource"	表明图像来源。
CFA_PATTERN ¹²⁺	"CFAPattern"	图像传感器的色彩滤光片（CFA）几何图案。
CUSTOM_RENDERED ¹²⁺	"CustomRendered"	指示图像数据上的特殊处理。
EXPOSURE_MODE ¹²⁺	"ExposureMode"	拍摄时设置的曝光模式。
DIGITAL_ZOOM_RATIO ¹²⁺	"DigitalZoomRatio"	捕获时的数字变焦比率。
SCENE_CAPTURE_TYPE ¹²⁺	"SceneCaptureType"	捕获的场景类型。
GAIN_CONTROL ¹²⁺	"GainControl"	整体图像增益调整的程度。
CONTRAST ¹²⁺	"Contrast"	相机应用的对比度处理方向。
SATURATION ¹²⁺	"Saturation"	相机应用的饱和度处理方向。
SHARPNESS ¹²⁺	"Sharpness"	相机应用的锐度处理方向。
DEVICE_SETTING_DESCRIPTION ¹²⁺	"DeviceSettingDescription"	特定相机模型的拍照条件信息。
SUBJECT_DISTANCE_RANGE ¹²⁺	"SubjectDistanceRange"	表示主体到相机的距离范围。
IMAGE_UNIQUE_ID ¹²⁺	"ImageUniqueID"	为每张图片唯一分配的标识符。
GPS_VERSION_ID ¹²⁺	"GPSVersionID"	GPSInfoIFD的版本。
GPS_ALTITUDE_REF ¹²⁺	"GPSAltitudeRef"	用于GPS高度的参照高度。
GPS_ALTITUDE ¹²⁺	"GPSAltitude"	基于GPSAltitudeRef的高度。
GPS_SATELLITES ¹²⁺	"GPSSatellites"	用于测量的GPS卫星。
GPS_STATUS ¹²⁺	"GPSStatus"	录制图像时GPS接收器的状态。
GPS_MEASURE_MODE ¹²⁺	"GPSMeasureMode"	GPS测量模式。
GPS_DOP ¹²⁺	"GPSDOP"	GPS DOP（数据精度等级）。
GPS_SPEED_REF ¹²⁺	"GPSSpeedRef"	用来表示GPS接收器移动速度的单位。
GPS_SPEED ¹²⁺	"GPSSpeed"	GPS接收器的移动速度。
GPS_TRACK_REF ¹²⁺	"GPSTrackRef"	GPS接收机移动方向的参照。
GPS_TRACK ¹²⁺	"GPSTrack"	GPS接收机的移动方向。
GPS_IMG_DIRECTION_REF ¹²⁺	"GPSImgDirectionRef"	图像方向的参照。
GPS_IMG_DIRECTION ¹²⁺	"GPSImgDirection"	拍摄时图像的方向。
GPS_MAP_DATUM ¹²⁺	"GPSMapDatum"	GPS接收器使用的大地测量数据。
GPS_DEST_LATITUDE_REF ¹²⁺	"GPSDestLatitudeRef"	目的地点的纬度参照。
GPS_DEST_LATITUDE ¹²⁺	"GPSDestLatitude"	目的地点的纬度。
GPS_DEST_LONGITUDE_REF ¹²⁺	"GPSDestLongitudeRef"	目的地点的经度参照。
GPS_DEST_LONGITUDE ¹²⁺	"GPSDestLongitude"	目的地点的经度。
GPS_DEST_BEARING_REF ¹²⁺	"GPSDestBearingRef"	指向目的地点的方位参照。
GPS_DEST_BEARING ¹²⁺	"GPSDestBearing"	目的地方位。
GPS_DEST_DISTANCE_REF ¹²⁺	"GPSDestDistanceRef"	目标点距离的测量单位。
GPS_DEST_DISTANCE ¹²⁺	"GPSDestDistance"	到目的地点的距离。
GPS_PROCESSING_METHOD ¹²⁺	"GPSProcessingMethod"	记录定位方法名的字符字符串。
GPS_AREA_INFORMATION ¹²⁺	"GPSAreaInformation"	记录GPS区域名的字符字符串。
GPS_DIFFERENTIAL ¹²⁺	"GPSDifferential"	此字段表示GPS数据是否应用了差分校正，对于精确的位置准确性至关重要。
BODY_SERIAL_NUMBER ¹²⁺	"BodySerialNumber"	相机机身的序列号。
CAMERA_OWNER_NAME ¹²⁺	"CameraOwnerName"	相机所有者的姓名。
COMPOSITE_IMAGE ¹²⁺	"CompositeImage"	表示图像是否为合成图像。
COMPRESSED_BITS_PER_PIXEL ¹²⁺	"CompressedBitsPerPixel"	用于压缩图像的压缩模式，单位为每像素位数。
DNG_VERSION ¹²⁺	"DNGVersion"	DNG版本标签编码了符合DNG规范的四级版本号。
DEFAULT_CROP_SIZE ¹²⁺	"DefaultCropSize"	DefaultCropSize指定了原始坐标中的最终图像大小，考虑了额外的边缘像素。
GAMMA ¹²⁺	"Gamma"	表示系数伽马的值。
ISO_SPEED_LATITUDE_YYY ¹²⁺	"ISOSpeedLatitudeyyy"	该标签指示摄像机或输入设备的ISO速度纬度yyy值，该值在ISO 12232中定义。
ISO_SPEED_LATITUDE_ZZZ ¹²⁺	"ISOSpeedLatitudezzz"	该标签指示摄像机或输入设备的ISO速度纬度zzz值，该值在ISO 12232中定义。
LENS_MAKE ¹²⁺	"LensMake"	镜头的制造商。
LENS_MODEL ¹²⁺	"LensModel"	镜头的型号名称。
LENS_SERIAL_NUMBER ¹²⁺	"LensSerialNumber"	镜头的序列号。
LENS_SPECIFICATION ¹²⁺	"LensSpecification"	使用的镜头规格。
NEW_SUBFILE_TYPE ¹²⁺	"NewSubfileType"	在Exif中，"NewSubfileType"字段用于标识子文件的数据类型，如全分辨率图像、缩略图或多帧图像的一部分。其值是位掩码，0代表全分辨率图像，1代表缩略图，2代表多帧图像的一部分。
OFFSET_TIME ¹²⁺	"OffsetTime"	在Exif中，OffsetTime字段表示与UTC（协调世界时）的时间偏移，格式为±HH:MM，用于确定照片拍摄的本地时间。
OFFSET_TIME_DIGITIZED ¹²⁺	"OffsetTimeDigitized"	此标签记录图像数字化时的UTC偏移量，有助于准确调整时间戳。
OFFSET_TIME_ORIGINAL ¹²⁺	"OffsetTimeOriginal"	此标签记录原始图像创建时的UTC偏移量，对于时间敏感的应用至关重要。
SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE ¹²⁺	"SourceExposureTimesOfCompositeImage"	合成图像的源图像曝光时间。
SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE ¹²⁺	"SourceImageNumberOfCompositeImage"	用于合成图像的源图像数量。
SUBFILE_TYPE ¹²⁺	"SubfileType"	此标签指示此子文件中的数据类型。标签已弃用，请使用NewSubfileType替代。
GPS_H_POSITIONING_ERROR ¹²⁺	"GPSHPositioningError"	此标签指示水平定位误差，单位为米。
PHOTOGRAPHIC_SENSITIVITY ¹²⁺	"PhotographicSensitivity"	此标签指示拍摄图像时相机或输入设备的灵敏度。
BURST_NUMBER ¹²⁺	"HwMnoteBurstNumber"	连拍次数。
FACE_CONF ¹²⁺	"HwMnoteFaceConf"	人脸置信度。
FACE_LEYE_CENTER ¹²⁺	"HwMnoteFaceLeyeCenter"	左眼中心。
FACE_MOUTH_CENTER ¹²⁺	"HwMnoteFaceMouthCenter"	嘴中心。
FACE_POINTER ¹²⁺	"HwMnoteFacePointer"	脸部指针。
FACE_RECT ¹²⁺	"HwMnoteFaceRect"	脸部矩形。
FACE_REYE_CENTER ¹²⁺	"HwMnoteFaceReyeCenter"	右眼中心。
FACE_SMILE_SCORE ¹²⁺	"HwMnoteFaceSmileScore"	FaceCount张人脸的笑脸分数。
FACE_VERSION ¹²⁺	"HwMnoteFaceVersion"	人脸算法版本信息。
FRONT_CAMERA ¹²⁺	"HwMnoteFrontCamera"	是否是前置相机自拍。
SCENE_POINTER ¹²⁺	"HwMnoteScenePointer"	场景指针。
SCENE_VERSION ¹²⁺	"HwMnoteSceneVersion"	场景算法版本信息。
GIF_LOOP_COUNT ¹²⁺	"GIFLoopCount"	GIF图片循环次数。

ImageFormat⁹⁺

枚举，图片格式。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
YCBCR_422_SP	1000	YCBCR422半平面格式。
JPEG	2000	JPEG编码格式。

ComponentType⁹⁺

枚举，图像的组件类型。

系统能力： SystemCapability.Multimedia.Image.ImageReceiver

名称	值	说明
YUV_Y	1	亮度信息。
YUV_U	2	色度信息。
YUV_V	3	色度信息。
JPEG	4	JPEG 类型。

Component⁹⁺

描述图像颜色分量。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	只读	可选	说明
componentType	ComponentType	是	否	组件类型。
rowStride	number	是	否	行距。
pixelStride	number	是	否	像素间距。
byteBuffer	ArrayBuffer	是	否	组件缓冲区。

DecodingDynamicRange¹²⁺

描述解码时期望的图像动态范围。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
AUTO	0	自适应，根据图片信息处理。即如果图片本身为HDR图片，则会按照HDR内容解码；反之按照SDR内容解码。通过CreateIncrementalSource创建的imagesource会解码为SDR内容。
SDR	1	按照标准动态范围处理图片。
HDR	2	按照高动态范围处理图片。通过CreateIncrementalSource创建的imagesource会解码为SDR内容。

PackingDynamicRange¹²⁺

描述编码时期望的图像动态范围。

系统能力： SystemCapability.Multimedia.Image.Core

名称	值	说明
AUTO	0	自适应，根据pixelmap内容处理。即如果pixelmap本身为HDR，则会按照HDR内容进行编码；反之按照SDR内容编码。
SDR	1	按照标准动态范围处理图片。

补充说明

SVG标签说明

从API version 10开始支持SVG标签，使用版本为(SVG) 1.1，SVG文件需添加xml声明，应以“<?xml”开头，并且SVG标签需设置width，height。当前支持的标签列表有：

a
circla
clipPath
defs
ellipse
feBlend
feColorMatrix
feComposite
feDiffuseLighting
feDisplacementMap
feDistantLight
feFlood
feGaussianBlur
feImage
feMorphology
feOffset
fePointLight
feSpecularLighting
feSpotLight
feTurbulence
filter
g
image
line
linearGradient
mask
path
pattern
polygon
polyline
radialGradient
rect
stop
svg
text
textPath
tspan
use

OpenHarmony / docs .gitee-modal { width: 500px !important; }

@ohos.multimedia.image (图片处理)

导入模块

image.createPixelMap8+

image.createPixelMap8+

image.createPixelMapFromParcel11+

image.createPixelMapFromSurface11+

image.createPixelMapFromSurfaceSync12+

image.createPixelMapSync12+

image.createPixelMapSync12+

image.createPremultipliedPixelMap12+

image.createPremultipliedPixelMap12+

image.createUnpremultipliedPixelMap12+

image.createUnpremultipliedPixelMap12+

PixelMap7+

属性

readPixelsToBuffer7+

readPixelsToBuffer7+

readPixelsToBufferSync12+

readPixels7+

readPixels7+

readPixelsSync12+

writePixels7+

writePixels7+

writePixelsSync12+

writeBufferToPixels7+

writeBufferToPixels7+

writeBufferToPixelsSync12+

getImageInfo7+

getImageInfo7+

getImageInfoSync12+

getBytesNumberPerRow7+

getPixelBytesNumber7+

getDensity9+

opacity9+

opacity9+

opacitySync12+

createAlphaPixelmap9+

createAlphaPixelmap9+

createAlphaPixelmapSync12+

scale9+

scale9+

scaleSync12+

translate9+

translate9+

translateSync12+

rotate9+

rotate9+

rotateSync12+

flip9+

flip9+

flipSync12+

crop9+

crop9+

cropSync12+

getColorSpace10+

setColorSpace10+

applyColorSpace11+

applyColorSpace11+

marshalling10+

unmarshalling10+

release7+

release7+

image.createImageSource

image.createImageSource9+

image.createImageSource7+

image.createImageSource9+

image.createImageSource9+

image.createImageSource9+

image.createImageSource11+

image.CreateIncrementalSource9+

image.CreateIncrementalSource9+

ImageSource

属性

getImageInfo

getImageInfo

getImageInfo

getImageInfoSync12+

getImageProperty11+

getImageProperty(deprecated)

OpenHarmony / docs

image.createPixelMap⁸⁺

image.createPixelMap⁸⁺

image.createPixelMapFromParcel¹¹⁺

image.createPixelMapFromSurface¹¹⁺

image.createPixelMapFromSurfaceSync¹²⁺

image.createPixelMapSync¹²⁺

image.createPixelMapSync¹²⁺

image.createPremultipliedPixelMap¹²⁺

image.createPremultipliedPixelMap¹²⁺

image.createUnpremultipliedPixelMap¹²⁺

image.createUnpremultipliedPixelMap¹²⁺

PixelMap⁷⁺

readPixelsToBuffer⁷⁺

readPixelsToBuffer⁷⁺

readPixelsToBufferSync¹²⁺

readPixels⁷⁺

readPixels⁷⁺

readPixelsSync¹²⁺

writePixels⁷⁺

writePixels⁷⁺

writePixelsSync¹²⁺

writeBufferToPixels⁷⁺

writeBufferToPixels⁷⁺

writeBufferToPixelsSync¹²⁺

getImageInfo⁷⁺

getImageInfo⁷⁺

getImageInfoSync¹²⁺

getBytesNumberPerRow⁷⁺

getPixelBytesNumber⁷⁺

getDensity⁹⁺

opacity⁹⁺

opacity⁹⁺

opacitySync¹²⁺

createAlphaPixelmap⁹⁺

createAlphaPixelmap⁹⁺

createAlphaPixelmapSync¹²⁺

scale⁹⁺

scale⁹⁺

scaleSync¹²⁺

translate⁹⁺

translate⁹⁺

translateSync¹²⁺

rotate⁹⁺

rotate⁹⁺

rotateSync¹²⁺

flip⁹⁺

flip⁹⁺

flipSync¹²⁺

crop⁹⁺

crop⁹⁺

cropSync¹²⁺

getColorSpace¹⁰⁺

setColorSpace¹⁰⁺

applyColorSpace¹¹⁺

applyColorSpace¹¹⁺

marshalling¹⁰⁺

unmarshalling¹⁰⁺

release⁷⁺

release⁷⁺

image.createImageSource⁹⁺

image.createImageSource⁷⁺

image.createImageSource⁹⁺

image.createImageSource⁹⁺

image.createImageSource⁹⁺

image.createImageSource¹¹⁺

image.CreateIncrementalSource⁹⁺

image.CreateIncrementalSource⁹⁺

getImageInfoSync¹²⁺

getImageProperty¹¹⁺

getImageProperty^(deprecated)

getImageProperty^(deprecated)

getImageProperty^(deprecated)

getImageProperties¹²⁺

modifyImageProperty¹¹⁺

modifyImageProperty^(deprecated)

modifyImageProperty^(deprecated)

modifyImageProperties¹²⁺

updateData⁹⁺

updateData⁹⁺