智能客服
你问我答，随时在线为你解决问题
本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
从API version 12开始，本模块接口支持在ArkTS卡片中使用。
@ohos.multimedia.image (图片处理)
本文导读
本模块提供图片处理效果，包括通过属性创建PixelMap、读取图像像素数据、读取区域内的图片数据等。
说明
导入模块
import { image } from '@kit.ImageKit'; image.createPixelMap8+
createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise<PixelMap>
通过属性创建PixelMap，默认采用BGRA_8888格式处理数据，通过Promise返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| colors | ArrayBuffer | 是 | 图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定。 说明： 图像像素数据的缓冲区长度：length = width * height * 单位像素字节数 |
| options | InitializationOptions | 是 | 创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<PixelMap> | Promise对象，返回PixelMap。 当创建的pixelMap大小超过原图大小时，返回原图pixelMap大小。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function CreatePixelMap() {
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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.createPixelMap8+
createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback<PixelMap>): void
通过属性创建PixelMap，默认采用BGRA_8888格式处理数据，通过callback返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| colors | ArrayBuffer | 是 | 图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定。 说明： 图像像素数据的缓冲区长度：length = width * height * 单位像素字节数 |
| options | InitializationOptions | 是 | 创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。 |
| callback | AsyncCallback<PixelMap> | 是 | 回调函数，当创建PixelMap成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function CreatePixelMap() {
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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.createPixelMapFromParcel11+
createPixelMapFromParcel(sequence: rpc.MessageSequence): PixelMap
从MessageSequence中获取PixelMap。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sequence | rpc.MessageSequence | 是 | 保存有PixelMap信息的MessageSequence。 |
返回值：
| 类型 | 说明 |
|---|---|
| PixelMap | 成功同步返回PixelMap对象，失败抛出异常。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980096 | Operation failed |
| 62980097 | 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 '@kit.ImageKit';
import { rpc } from '@kit.IPCKit';
import { BusinessError } from '@kit.BasicServicesKit';
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 CreatePixelMapFromParcel() {
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: image.PixelMapFormat.BGRA_8888,
size: { height: 4, width: 6 },
alphaType: image.AlphaType.UNPREMUL
}
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.createPixelMapFromSurface11+
createPixelMapFromSurface(surfaceId: string, region: Region): Promise<PixelMap>
根据Surface id和区域信息，创建一个PixelMap对象。该区域的大小由Region.size指定。使用Promise形式返回。
说明
当开发设备为折叠屏，折叠状态切换时，可能因Surface自带旋转角度导致接口创建失败，需将宽高适配旋转角度。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| surfaceId | string | 是 | 对应Surface的ID，可通过预览组件获取，如XComponent组件。 |
| region | Region | 是 | 区域信息。Region.size的宽高需和设置的预览流大小保持一致。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<PixelMap> | Promise对象，返回PixelMap。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980115 | If the image parameter invalid. |
| 62980105 | Failed to get the data |
| 62980178 | Failed to create the PixelMap |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function CreatePixelMapFromSurface(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.createPixelMapFromSurfaceSync12+
createPixelMapFromSurfaceSync(surfaceId: string, region: Region): PixelMap
以同步方式，根据Surface id和区域信息，创建一个PixelMap对象。该区域的大小由Region.size指定。
说明
当开发设备为折叠屏，折叠状态切换时，可能因Surface自带旋转角度导致接口创建失败，需将宽高适配旋转角度。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| surfaceId | string | 是 | 对应Surface的ID，可通过预览组件获取，如XComponent组件。 |
| region | Region | 是 | 区域信息。Region.size的宽高需和设置的预览流大小保持一致。 |
返回值：
| 类型 | 说明 |
|---|---|
| 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 CreatePixelMapFromSurfaceSync(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.createPixelMapSync12+
createPixelMapSync(colors: ArrayBuffer, options: InitializationOptions): PixelMap
通过属性创建PixelMap，默认采用BGRA_8888格式处理数据，同步返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| colors | ArrayBuffer | 是 | 图像像素数据的缓冲区，用于初始化PixelMap的像素。初始化前，缓冲区中的像素格式需要由InitializationOptions.srcPixelFormat指定。 说明： 图像像素数据的缓冲区长度：length = width * height * 单位像素字节数 |
| 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 '@kit.BasicServicesKit';
async function CreatePixelMapSync() {
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 4, width: 6 } }
let pixelMap : image.PixelMap = image.createPixelMapSync(color, opts);
return pixelMap;
} image.createPixelMapSync12+
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 '@kit.BasicServicesKit';
async function CreatePixelMapSync() {
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 4, width: 6 } }
let pixelMap : image.PixelMap = image.createPixelMapSync(opts);
return pixelMap;
} image.createPremultipliedPixelMap12+
createPremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void
将PixelMap的透明通道非预乘模式转变为预乘模式，转换后的数据存入目标PixelMap，通过回调函数返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
错误码：
以下错误码的详细介绍请参见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 '@kit.BasicServicesKit';
async function CreatePremultipliedPixelMap() {
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 optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
let srcPixelmap = image.createPixelMapSync(color, optsForUnpre);
let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
let dstPixelMap = image.createPixelMapSync(optsForPre);
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.createPremultipliedPixelMap12+
createPremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>
将PixelMap数据按照透明度非预乘格式转为预乘格式，转换后的数据存入另一个PixelMap，通过Promise返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
返回值：
| 类型 | 说明 |
|---|---|
| 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 '@kit.BasicServicesKit';
async function CreatePremultipliedPixelMap() {
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 optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
let srcPixelmap = image.createPixelMapSync(color, optsForUnpre);
let optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
let dstPixelMap = image.createPixelMapSync(optsForPre);
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.createUnpremultipliedPixelMap12+
createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap, callback: AsyncCallback<void>): void
将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap，通过回调函数返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
错误码：
以下错误码的详细介绍请参见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 '@kit.BasicServicesKit';
async function CreateUnpremultipliedPixelMap() {
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 optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
let srcPixelmap = image.createPixelMapSync(color, optsForPre);
let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
let dstPixelMap = image.createPixelMapSync(optsForUnpre);
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.createUnpremultipliedPixelMap12+
createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise<void>
将PixelMap的透明通道预乘模式转变为非预乘模式，转换后的数据存入目标PixelMap，通过Promise返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
返回值：
| 类型 | 说明 |
|---|---|
| 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 '@kit.BasicServicesKit';
async function CreateUnpremultipliedPixelMap() {
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 optsForPre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.PREMUL}
let srcPixelmap = image.createPixelMapSync(color, optsForPre);
let optsForUnpre: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 2, width: 2 } , alphaType: image.AlphaType.UNPREMUL}
let dstPixelMap = image.createPixelMapSync(optsForUnpre);
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}`);
})
} PixelMap7+
图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。目前pixelmap序列化大小最大128MB，超过会送显失败。大小计算方式为(宽*高*每像素占用字节数)。
从API version 11开始，PixelMap支持通过worker跨线程调用。当PixelMap通过Worker跨线程后，原线程的PixelMap的所有接口均不能调用，否则将报错501 服务器不具备完成请求的功能。
在调用PixelMap的方法前，需要先通过image.createPixelMap构建一个PixelMap对象。
开发元服务请通过ImageSoure构建PixelMap对象。
属性
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| isEditable | boolean | 是 | 否 | 设定是否图像像素可被编辑。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| isStrideAlignment11+ | boolean | 是 | 否 | 设定图像内存是否为DMA内存。 |
readPixelsToBuffer7+
readPixelsToBuffer(dst: ArrayBuffer): Promise<void>
按照PixelMap的像素格式，读取PixelMap的图像像素数据，并写入缓冲区中，使用Promise形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dst | ArrayBuffer | 是 | 缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。缓冲区大小由getPixelBytesNumber接口获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function ReadPixelsToBuffer() {
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}`);// 不符合条件则进入
})
}
} readPixelsToBuffer7+
readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback<void>): void
按照PixelMap的像素格式，读取PixelMap的图像像素数据，并写入缓冲区中，使用callback形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dst | ArrayBuffer | 是 | 缓冲区，函数执行结束后获取的图像像素数据写入到该内存区域内。缓冲区大小由getPixelBytesNumber接口获取。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当读取像素数据到ArrayBuffer成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function ReadPixelsToBuffer() {
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.'); //符合条件则进入
}
})
}
} readPixelsToBufferSync12+
readPixelsToBufferSync(dst: ArrayBuffer): void
按照PixelMap的像素格式，读取PixelMap的图像像素数据，并写入缓冲区中，同步返回结果。
卡片能力： 从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 '@kit.BasicServicesKit';
async function ReadPixelsToBufferSync() {
const readBuffer: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
if (pixelMap != undefined) {
pixelMap.readPixelsToBufferSync(readBuffer);
}
} readPixels7+
readPixels(area: PositionArea): Promise<void>
固定按照BGRA_8888格式，读取PixelMap指定区域内的图像像素数据，并写入PositionArea.pixels缓冲区中，该区域由PositionArea.region指定，使用Promise形式返回。
可用公式计算PositionArea需要申请的内存大小。
YUV的区域计算公式：读取区域（region.size{width * height}）* 1.5 （1倍的Y分量+0.25倍U分量+0.25倍V分量）
RGBA的区域计算公式：读取区域（region.size{width * height}）* 4 （1倍的R分量+1倍G分量+1倍B分量+1倍A分量）
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area | PositionArea | 是 | 区域大小，根据区域读取。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function ReadPixelsRGBA() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(8), // 8为需要创建的像素buffer大小，取值为：height * width *4
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}`);// 不符合条件则进入
})
}
}
async function ReadPixelsYUV() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(6), // 6为需要创建的像素buffer大小，取值为：height * width *1.5
offset: 0,
stride: 8,
region: { size: { height: 2, 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}`);// 不符合条件则进入
})
}
} readPixels7+
readPixels(area: PositionArea, callback: AsyncCallback<void>): void
固定按照BGRA_8888格式，读取PixelMap指定区域内的图像像素数据，并写入PositionArea.pixels缓冲区中，该区域由PositionArea.region指定，使用callback形式返回。
可用公式计算PositionArea需要申请的内存大小。
YUV的区域计算公式：读取区域（region.size{width * height}）* 1.5 （1倍的Y分量+0.25倍U分量+0.25倍V分量）
RGBA的区域计算公式：读取区域（region.size{width * height}）* 4 （1倍的R分量+1倍G分量+1倍B分量+1倍A分量）
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area | PositionArea | 是 | 区域大小，根据区域读取。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当读取区域内的图片数据成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function ReadPixelsRGBA() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(8), // 8为需要创建的像素buffer大小，取值为：height * width *4
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.');
}
})
}
}
async function ReadPixelsYUV() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(6), // 6为需要创建的像素buffer大小，取值为：height * width *1.5
offset: 0,
stride: 8,
region: { size: { height: 2, 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.');
}
})
}
} readPixelsSync12+
readPixelsSync(area: PositionArea): void
固定按照BGRA_8888格式，读取PixelMap指定区域内的图像像素数据，并写入PositionArea.pixels缓冲区中，该区域由PositionArea.region指定，同步返回结果。
元服务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 '@kit.BasicServicesKit';
async function ReadPixelsSync() {
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);
}
} writePixels7+
writePixels(area: PositionArea): Promise<void>
固定按照BGRA_8888格式，读取PositionArea.pixels缓冲区中的图像像素数据，并写入PixelMap指定区域内，该区域由PositionArea.region指定，使用Promise形式返回。
可用公式计算PositionArea需要申请的内存大小。
YUV的区域计算公式：读取区域（region.size{width * height}）* 1.5 （1倍的Y分量+0.25倍U分量+0.25倍V分量）
RGBA的区域计算公式：读取区域（region.size{width * height}）* 4 （1倍的R分量+1倍G分量+1倍B分量+1倍A分量）
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area | PositionArea | 是 | 区域，根据区域写入。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function WritePixelsRGBA() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(8), // 8为需要创建的像素buffer大小，取值为：height * width *4
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}`);
})
}
}
async function WritePixelsYUV() {
const area: image.PositionArea = {
pixels: new ArrayBuffer(6), // 6为需要创建的像素buffer大小，取值为：height * width *1.5
offset: 0,
stride: 8,
region: { size: { height: 2, 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}`);
})
}
} writePixels7+
writePixels(area: PositionArea, callback: AsyncCallback<void>): void
固定按照BGRA_8888格式，读取PositionArea.pixels缓冲区中的图像像素数据，并写入PixelMap指定区域内，该区域由PositionArea.region指定，使用callback形式返回。
可用公式计算PositionArea需要申请的内存大小。
YUV的区域计算公式：读取区域（region.size{width * height}）* 1.5 （1倍的Y分量+0.25倍U分量+0.25倍V分量）
RGBA的区域计算公式：读取区域（region.size{width * height}）* 4 （1倍的R分量+1倍G分量+1倍B分量+1倍A分量）
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| area | PositionArea | 是 | 区域，根据区域写入。 |
| callback | AsyncCallback<void> | 是 | 回调函数，当写入成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function WritePixelsRGBA() {
const area: image.PositionArea = { pixels: new ArrayBuffer(8), // 8为需要创建的像素buffer大小，取值为：height * width *4
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.');
}
})
}
}
async function WritePixelsYUV() {
const area: image.PositionArea = { pixels: new ArrayBuffer(6), // 6为需要创建的像素buffer大小，取值为：height * width *1.5
offset: 0,
stride: 8,
region: { size: { height: 2, 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.');
}
})
}
} writePixelsSync12+
writePixelsSync(area: PositionArea): void
固定按照BGRA_8888格式，读取PositionArea.pixels缓冲区中的图像像素数据，并写入PixelMap指定区域内，该区域由PositionArea.region指定，同步回结果。
卡片能力： 从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 '@kit.BasicServicesKit';
async function WritePixelsSync() {
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);
}
} writeBufferToPixels7+
writeBufferToPixels(src: ArrayBuffer): Promise<void>
按照PixelMap的像素格式，读取缓冲区中的图像像素数据，并写入PixelMap，使用Promise形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| src | ArrayBuffer | 是 | 缓冲区，函数执行时会将该缓冲区中的图像像素数据写入到PixelMap。缓冲区大小由getPixelBytesNumber接口获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function WriteBufferToPixels() {
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}`);
})
}
} writeBufferToPixels7+
writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback<void>): void
按照PixelMap的像素格式，读取缓冲区中的图像像素数据，并写入PixelMap，使用callback形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| src | ArrayBuffer | 是 | 缓冲区，函数执行时会将该缓冲区中的图像像素数据写入到PixelMap。缓冲区大小由getPixelBytesNumber接口获取。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当缓冲区中的图像像素数据写入PixelMap成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function WriteBufferToPixels() {
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.");
}
})
}
} writeBufferToPixelsSync12+
writeBufferToPixelsSync(src: ArrayBuffer): void
按照PixelMap的像素格式，读取缓冲区中的图像像素数据，并写入PixelMap，同步返回结果。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| src | ArrayBuffer | 是 | 缓冲区，函数执行时会将该缓冲区中的图像像素数据写入到PixelMap。缓冲区大小由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 '@kit.BasicServicesKit';
async function WriteBufferToPixelsSync() {
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);
}
} getImageInfo7+
getImageInfo(): Promise<ImageInfo>
获取图像像素信息，使用Promise形式返回获取的图像像素信息。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<ImageInfo> | Promise对象，返回图像像素信息。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function GetImageInfo() {
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}`);
})
}
} getImageInfo7+
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 '@kit.BasicServicesKit';
async function GetImageInfo() {
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);
}
})
}
} getImageInfoSync12+
getImageInfoSync(): ImageInfo
以同步方法获取图像像素信息。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.ImageSource
返回值：
| 类型 | 说明 |
|---|---|
| ImageInfo | 图像像素信息 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 501 | Resource Unavailable |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function GetImageInfoSync() {
if (pixelMap != undefined) {
let imageInfo : image.ImageInfo = pixelMap.getImageInfoSync();
return imageInfo;
}
return undefined;
} getBytesNumberPerRow7+
getBytesNumberPerRow(): number
获取图像像素每行字节数。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 图像像素的行字节数。 |
示例：
let rowCount: number = pixelMap.getBytesNumberPerRow();
getPixelBytesNumber7+
getPixelBytesNumber(): number
获取图像像素的总字节数。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 图像像素的总字节数。 |
示例：
let pixelBytesNumber: number = pixelMap.getPixelBytesNumber();
getDensity9+
getDensity():number
获取当前图像像素的密度。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 图像像素的密度。 |
示例：
let getDensity: number = pixelMap.getDensity();
opacity9+
opacity(rate: number, callback: AsyncCallback<void>): void
通过设置透明比率来让PixelMap达到对应的透明效果，yuv图片不支持设置透明度，使用callback形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rate | number | 是 | 透明比率的值。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当设置透明比率成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Opacity() {
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.");
}
})
}
} opacity9+
opacity(rate: number): Promise<void>
通过设置透明比率来让PixelMap达到对应的透明效果，yuv图片不支持设置透明度，使用Promise形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| rate | number | 是 | 透明比率的值。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Opacity() {
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}`);
})
}
} opacitySync12+
opacitySync(rate: number): void
设置PixelMap的透明比率，yuv图片不支持设置透明度，初始化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 '@kit.BasicServicesKit';
async function OpacitySync() {
let rate : number = 0.5;
if (pixelMap != undefined) {
pixelMap.opacitySync(rate);
}
} createAlphaPixelmap9+
createAlphaPixelmap(): Promise<PixelMap>
根据Alpha通道的信息，来生成一个仅包含Alpha通道信息的pixelmap，可用于阴影效果，yuv格式不支持此接口，使用Promise形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<PixelMap> | Promise对象，返回PixelMap。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function CreateAlphaPixelmap() {
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}`);
})
}
} createAlphaPixelmap9+
createAlphaPixelmap(callback: AsyncCallback<PixelMap>): void
根据Alpha通道的信息，来生成一个仅包含Alpha通道信息的pixelmap，可用于阴影效果，yuv格式不支持此接口，使用callback形式返回。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<PixelMap> | 是 | 回调函数，当创建PixelMap成功，err为undefined，data为获取到的PixelMap对象；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function CreateAlphaPixelmap() {
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.');
}
})
}
} createAlphaPixelmapSync12+
createAlphaPixelmapSync(): PixelMap
根据Alpha通道的信息，生成一个仅包含Alpha通道信息的PixelMap，可用于阴影效果，yuv格式不支持此接口，同步返回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 '@kit.BasicServicesKit';
async function CreateAlphaPixelmapSync() {
if (pixelMap != undefined) {
let pixelmap : image.PixelMap = pixelMap.createAlphaPixelmapSync();
return pixelmap;
}
return undefined;
} scale9+
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 '@kit.BasicServicesKit';
async function Scale() {
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.");
}
})
}
} scale9+
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 '@kit.BasicServicesKit';
async function Scale() {
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}`);
})
}
} scaleSync12+
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 '@kit.BasicServicesKit';
async function ScaleSync() {
let scaleX: number = 2.0;
let scaleY: number = 1.0;
if (pixelMap != undefined) {
pixelMap.scaleSync(scaleX, scaleY);
}
} scale12+
scale(x: number, y: number, level: AntiAliasingLevel): Promise<void>
根据指定的缩放算法和输入的宽高的缩放倍数对图片进行缩放，使用Promise形式返回。
说明
- 建议宽高的缩放倍数取非负数，否则会产生翻转效果。
- 宽高的缩放倍数 = 缩放后的图片宽高 / 缩放前的图片宽高
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| x | number | 是 | 宽度的缩放倍数。 |
| y | number | 是 | 高度的缩放倍数。 |
| level | AntiAliasingLevel | 是 | 采用的缩放算法。 |
返回值：
| 类型 | 说明 |
|---|---|
| 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 |
| 501 | Resource Unavailable |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Scale() {
let scaleX: number = 2.0;
let scaleY: number = 1.0;
if (pixelMap != undefined) {
pixelMap.scale(scaleX, scaleY, image.AntiAliasingLevel.LOW).then(() => {
console.info('Succeeded in scaling pixelmap.');
}).catch((err: BusinessError) => {
console.error(`Failed to scale pixelmap. code is ${err.code}, message is ${err.message}`);
})
}
} scaleSync12+
scaleSync(x: number, y: number, level: AntiAliasingLevel): void
根据指定的缩放算法和输入的宽高的缩放倍数对图片进行缩放，同步返回结果。
说明
- 建议宽高的缩放倍数取非负数，否则会产生翻转效果。
- 宽高的缩放倍数 = 缩放后的图片宽高 / 缩放前的图片宽高
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| x | number | 是 | 宽度的缩放倍数。 |
| y | number | 是 | 高度的缩放倍数。 |
| level | AntiAliasingLevel | 是 | 采用的缩放算法。 |
错误码：
以下错误码的详细介绍请参见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 '@kit.BasicServicesKit';
async function ScaleSync() {
let scaleX: number = 2.0;
let scaleY: number = 1.0;
if (pixelMap != undefined) {
pixelMap.scaleSync(scaleX, scaleY, image.AntiAliasingLevel.LOW);
}
} translate9+
translate(x: number, y: number, callback: AsyncCallback<void>): void
根据输入的坐标对图片进行位置变换，使用callback形式返回。
translate后的图片尺寸改变为：width+X ，height+Y，建议translate后的图片尺寸宽高不要超过屏幕的宽高。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| x | number | 是 | 区域横坐标。单位：像素。 |
| y | number | 是 | 区域纵坐标。单位：像素。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当对图片进行位置变换成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Translate() {
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.");
}
})
}
} translate9+
translate(x: number, y: number): Promise<void>
根据输入的坐标对图片进行位置变换，使用Promise形式返回。
translate后的图片尺寸改变为：width+X ，height+Y，建议translate后的图片尺寸宽高不要超过屏幕的宽高。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| x | number | 是 | 区域横坐标。单位：像素。 |
| y | number | 是 | 区域纵坐标。单位：像素。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Translate() {
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}`);
})
}
} translateSync12+
translateSync(x: number, y: number): void
根据输入的坐标对图片进行位置变换，同步返回结果。
translate后的图片尺寸改变为：width+X ，height+Y，建议translate后的图片尺寸宽高不要超过屏幕的宽高。
元服务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 '@kit.BasicServicesKit';
async function TranslateSync() {
let translateX : number = 50.0;
let translateY : number = 10.0;
if (pixelMap != undefined) {
pixelMap.translateSync(translateX, translateY);
}
} rotate9+
rotate(angle: number, callback: AsyncCallback<void>): void
根据输入的角度对图片进行旋转，使用callback形式返回。
说明
- 图片旋转的角度取值范围：0-360。超出取值范围时，根据圆周360度自动矫正。例如，-100度与260度效果相同。
- 如果图片旋转的角度不是90的整数倍，旋转后图片的尺寸会发生改变。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| angle | number | 是 | 图片旋转的角度。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当对图片进行旋转成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Rotate() {
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.");
}
})
}
} rotate9+
rotate(angle: number): Promise<void>
根据输入的角度对图片进行旋转，使用Promise形式返回。
说明
- 图片旋转的角度取值范围：0-360。超出取值范围时，根据圆周360度自动矫正。例如，-100度与260度效果相同。
- 如果图片旋转的角度不是90的整数倍，旋转后图片的尺寸会发生改变。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| angle | number | 是 | 图片旋转的角度。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Rotate() {
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}`);
})
}
} rotateSync12+
rotateSync(angle: number): void
根据输入的角度对图片进行旋转，同步返回结果。
说明
- 图片旋转的角度取值范围：0-360。超出取值范围时，根据圆周360度自动矫正。例如，-100度与260度效果相同。
- 如果图片旋转的角度不是90的整数倍，旋转后图片的尺寸会发生改变。
元服务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 '@kit.BasicServicesKit';
async function RotateSync() {
let angle : number = 90.0;
if (pixelMap != undefined) {
pixelMap.rotateSync(angle);
}
} flip9+
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 '@kit.BasicServicesKit';
async function Flip() {
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.");
}
})
}
} flip9+
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 '@kit.BasicServicesKit';
async function Flip() {
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}`);
})
}
} flipSync12+
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 '@kit.BasicServicesKit';
async function FlipSync() {
let horizontal : boolean = true;
let vertical : boolean = false;
if (pixelMap != undefined) {
pixelMap.flipSync(horizontal, vertical);
}
} crop9+
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 '@kit.BasicServicesKit';
async function Crop() {
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.");
}
})
}
} crop9+
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 '@kit.BasicServicesKit';
async function Crop() {
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}`);
});
}
} cropSync12+
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 '@kit.BasicServicesKit';
async function CropSync() {
let region : image.Region = { x: 0, y: 0, size: { height: 100, width: 100 } };
if (pixelMap != undefined) {
pixelMap.cropSync(region);
}
} getColorSpace10+
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 GetColorSpace() {
if (pixelMap != undefined) {
let csm = pixelMap.getColorSpace();
}
} setColorSpace10+
setColorSpace(colorSpace: colorSpaceManager.ColorSpaceManager): void
设置图像广色域信息。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| colorSpace | colorSpaceManager.ColorSpaceManager | 是 | 图像广色域信息。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980111 | The image source data is incomplete. |
| 62980115 | If the image parameter invalid. |
示例：
import { colorSpaceManager } from '@kit.ArkGraphics2D';
async function SetColorSpace() {
let colorSpaceName = colorSpaceManager.ColorSpace.SRGB;
let csm: colorSpaceManager.ColorSpaceManager = colorSpaceManager.create(colorSpaceName);
if (pixelMap != undefined) {
pixelMap.setColorSpace(csm);
}
} applyColorSpace11+
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 '@kit.ArkGraphics2D';
import { BusinessError } from '@kit.BasicServicesKit';
async function ApplyColorSpace() {
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.');
}
})
}
} applyColorSpace11+
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 '@kit.ArkGraphics2D';
import { BusinessError } from '@kit.BasicServicesKit';
async function ApplyColorSpace() {
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}`);
})
}
} toSdr12+
toSdr(): Promise<void>
将HDR的图像内容转换为SDR的图像内容，异步使用Promise形式返回。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980137 | Invalid image operation. |
示例：
import image from '@ohos.multimedia.image'
import resourceManager from '@ohos.resourceManager'
import { BusinessError } from '@kit.BasicServicesKit';
//此处'hdr.jpg'仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
let img = getContext().resourceManager.getMediaContentSync($r('app.media.hdr'));
let imageSource = image.createImageSource(img.buffer.slice(0));
let decodingOptions: image.DecodingOptions = {
desiredDynamicRange: image.DecodingDynamicRange.AUTO
};
let pixelmap = imageSource.createPixelMapSync(decodingOptions);
if (pixelmap != undefined) {
console.info('Succeeded in creating pixelMap object.');
pixelmap.toSdr().then(() => {
let imageInfo = pixelmap.getImageInfoSync();
console.info("after toSdr ,imageInfo isHdr:" + imageInfo.isHdr);
}).catch((err: BusinessError) => {
console.error(`Failed to set sdr. code is ${err.code}, message is ${err.message}`);
});
} else {
console.info('Failed to create pixelMap.');
} getMetadata12+
getMetadata(key: HdrMetadataKey): HdrMetadataValue
从PixelMap中获取元数据。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | HdrMetadataKey | 是 | HDR元数据的关键字，可用于查询对应值。 |
返回值：
| 类型 | 说明 |
|---|---|
| HdrMetadataValue | 返回元数据的值。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 401 | Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed. |
| 501 | Resource unavailable. |
| 62980173 | The DMA memory does not exist. |
| 62980302 | Memory copy failed. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import image from '@ohos.multimedia.image'
// 'app.media.test'需要替换为本地hdr图片。
let img = getContext().resourceManager.getMediaContentSync($r('app.media.test'));
let imageSource = image.createImageSource(img.buffer.slice(0));
let decodingOptions: image.DecodingOptions = {
desiredDynamicRange: image.DecodingDynamicRange.AUTO
};
let pixelmap = imageSource.createPixelMapSync(decodingOptions);
if (pixelmap != undefined) {
console.info('Succeeded in creating pixelMap object.');
try {
let staticMetadata = pixelmap.getMetadata(image.HdrMetadataKey.HDR_STATIC_METADATA);
console.info("getmetadata:" + JSON.stringify(staticMetadata));
} catch (e) {
console.info('pixelmap create failed' + e);
}
} else {
console.info('Failed to create pixelMap.');
} setMetadata12+
setMetadata(key: HdrMetadataKey, value: HdrMetadataValue): Promise<void>
设置PixelMap元数据。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | HdrMetadataKey | 是 | HDR元数据的关键字，用于设置对应值 |
| value | HdrMetadataValue | 是 | 元数据的值 |
返回值：
| 类型 | 说明 |
|---|---|
| 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. |
| 501 | Resource unavailable. |
| 62980173 | The DMA memory does not exist. |
| 62980302 | Memory copy failed. |
示例：
import image from '@ohos.multimedia.image'
import { BusinessError } from '@kit.BasicServicesKit';
let staticMetadata: image.HdrStaticMetadata = {
displayPrimariesX: [1.1, 1.1, 1.1],
displayPrimariesY: [1.2, 1.2, 1.2],
whitePointX: 1.1,
whitePointY: 1.2,
maxLuminance: 2.1,
minLuminance: 1.0,
maxContentLightLevel: 2.1,
maxFrameAverageLightLevel: 2.1,
}
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap: image.PixelMap) => {
pixelMap.setMetadata(image.HdrMetadataKey.HDR_STATIC_METADATA, staticMetadata).then(() => {
console.info('Succeeded in setting pixelMap metadata.');
}).catch((error: BusinessError) => {
console.error(`Failed to set the metadata.code ${error.code},message is ${error.message}`);
})
}).catch((error: BusinessError) => {
console.error(`Failed to create the PixelMap.code ${error.code},message is ${error.message}`);
}) setTransferDetached12+
setTransferDetached(detached: boolean): void
pixelmap在跨线程传输时，断开原线程的引用。适用于需立即释放pixelmap的场景。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| detached | boolean | 是 | 是否断开原线程引用 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 501 | Resource Unavailable |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import image from '@ohos.multimedia.image';
import taskpool from '@ohos.taskpool';
@Concurrent
// 子线程方法
async function loadPixelMap(rawFileDescriptor: number): Promise<PixelMap> {
// 创建imageSource。
const imageSource = image.createImageSource(rawFileDescriptor);
// 创建pixelMap。
const pixelMap = imageSource.createPixelMapSync();
// 释放imageSource。
imageSource.release();
// 使pixelMap在跨线程传输完成后，断开原线程的引用。
pixelMap.setTransferDetached(true);
// 返回pixelMap给主线程。
return pixelMap;
}
@Entry
@Component
struct Demo {
@State pixelMap: PixelMap | undefined = undefined;
// 主线程方法
private loadImageFromThread(): void {
const resourceMgr = getContext(this).resourceManager;
// 此处‘example.jpg’仅作示例，请开发者自行替换，否则imageSource创建失败会导致后续无法正常执行。
resourceMgr.getRawFd('example.jpg').then(rawFileDescriptor => {
taskpool.execute(loadPixelMap, rawFileDescriptor).then(pixelMap => {
if (pixelMap) {
this.pixelMap = pixelMap as PixelMap;
console.log('Succeeded in creating pixelMap.');
// 主线程释放pixelMap。由于子线程返回pixelMap时已调用setTransferDetached，所以此处能够立即释放pixelMap。
this.pixelMap.release();
} else {
console.error('Failed to create pixelMap.');
}
});
});
}
build() {
// ...
}
} marshalling10+
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 '@kit.ImageKit';
import { rpc } from '@kit.IPCKit';
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 Marshalling() {
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: image.PixelMapFormat.BGRA_8888,
size: { height: 4, width: 6 },
alphaType: image.AlphaType.UNPREMUL
}
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);
}
} unmarshalling10+
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 '@kit.ImageKit';
import { rpc } from '@kit.IPCKit';
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 Unmarshalling() {
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: image.PixelMapFormat.BGRA_8888,
size: { height: 4, width: 6 },
alphaType: image.AlphaType.UNPREMUL
}
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);
}
} release7+
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 '@kit.BasicServicesKit';
async function Release() {
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}`);
})
}
} release7+
release(callback: AsyncCallback<void>): void
释放PixelMap对象，使用callback形式返回释放结果。
ArkTS有内存回收机制，PixelMap对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当对PixelMap对象释放成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
async function Release() {
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.');
}
})
}
} convertPixelFormat12+
convertPixelFormat(targetPixelFormat: PixelMapFormat): Promise<void>
YUV和RGB类型互转，目前仅支持NV12/NV21与RGB888/RGBA8888/RGB565/BGRA8888/RGBAF16互转，YCRCB_P010/YCBCR_P010与RGBA1010102互转。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| targetPixelFormat | PixelMapFormat | 是 | 目标像素格式，用于YUV和RGB类型互转。目前仅支持NV12/NV21与RGB888/RGBA8888/RGB565/BGRA8888/RGBAF16互转，YCRCB_P010/YCBCR_P010与RGBA1010102互转。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980111 | The image source data is incomplete. |
| 62980115 | Invalid input parameter. |
| 62980178 | Failed to create the pixelmap. |
| 62980274 | The conversion failed |
| 62980276 | The type to be converted is an unsupported target pixel format |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
if (pixelMap != undefined) {
// 设置目标像素格式为NV12
let targetPixelFormat = image.PixelMapFormat.NV12;
pixelMap.convertPixelFormat(targetPixelFormat).then(() => {
// pixelMap转换成NV12格式成功
console.info('PixelMapFormat convert Succeeded');
}).catch((error: BusinessError) => {
// pixelMap转换成NV12格式失败
console.error(`PixelMapFormat convert Failed. code is ${error.code}, message is ${error.message}`);
})
} image.createImageSource
createImageSource(uri: string): ImageSource
通过传入的uri创建图片源实例。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uri | string | 是 | 图片路径，当前仅支持应用沙箱路径。 当前支持格式有：.jpg .png .gif .bmp .webp .dng .heic12+（不同硬件设备支持情况不同） .svg10+ .ico11+。 |
返回值：
| 类型 | 说明 |
|---|---|
| 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.createImageSource9+
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 .heic12+（不同硬件设备支持情况不同）.svg10+ .ico11+。 |
| 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.createImageSource7+
createImageSource(fd: number): ImageSource
通过传入文件描述符来创建图片源实例。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| fd | number | 是 | 文件描述符fd。 |
返回值：
| 类型 | 说明 |
|---|---|
| ImageSource | 返回ImageSource类实例，失败时返回undefined。 |
示例：
import { fileIo as fs } from '@kit.CoreFileKit';
const context: Context = getContext(this);
//此处'test.jpg'仅作示例，请开发者自行替换，否则imageSource会创建失败导致后续无法正常执行。
let 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); image.createImageSource9+
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 { fileIo as fs } from '@kit.CoreFileKit';
let sourceOptions: image.SourceOptions = { sourceDensity: 120 };
const context: Context = getContext();
//此处'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.createImageSource9+
createImageSource(buf: ArrayBuffer): ImageSource
通过缓冲区创建图片源实例。buf数据应该是未解码的数据，不要传入类似于RBGA，YUV的像素buffer数据，如果想通过像素buffer数据创建pixelMap，可以调用image.createPixelMapSync这一类接口。
卡片能力： 从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.createImageSource9+
createImageSource(buf: ArrayBuffer, options: SourceOptions): ImageSource
通过缓冲区创建图片源实例。buf数据应该是未解码的数据，不要传入类似于RBGA，YUV的像素buffer数据，如果想通过像素buffer数据创建pixelMap，可以调用image.createPixelMapSync这一类接口。
卡片能力： 从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.createImageSource11+
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 '@kit.LocalizationKit';
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.CreateIncrementalSource9+
CreateIncrementalSource(buf: ArrayBuffer): ImageSource
通过缓冲区以增量的方式创建图片源实例，IncrementalSource不支持读写Exif信息。
以增量方式创建的图片源实例ImageSource，仅支持使用以下功能，同步、异步callback、异步Promise均支持。
- 获取图片信息：指定序号-getImageInfo、直接获取-getImageInfo
- 获取图片中给定索引处图像的指定属性键的值：getImageProperty
- 批量获取图片中的指定属性键的值：getImageProperties
- 更新增量数据：updateData
- 创建PixelMap对象：通过图片解码参数创建-createPixelMap、通过默认参数创建-createPixelMap 、通过图片解码参数-createPixelMap
- 释放图片源实例：release
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| buf | ArrayBuffer | 是 | 增量数据。 |
返回值：
| 类型 | 说明 |
|---|---|
| ImageSource | 返回图片源，失败时返回undefined。 |
示例：
const context: Context = getContext(this)
let imageArray = context.resourceManager.getMediaContentSync($r('app.media.startIcon')) // 获取图像资源
// 此处'app.media.startIcon'仅作示例，请开发者自行替换，否则imageArray创建失败会导致后续无法正常执行。
let splitBuff1 = imageArray.slice(0, imageArray.byteLength / 2) // 分片
let splitBuff2 = imageArray.slice(imageArray.byteLength / 2)
const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(new ArrayBuffer(imageArray.byteLength));
imageSourceIncrementalSApi.updateData(splitBuff1, false, 0, splitBuff1.byteLength).then(() => {
imageSourceIncrementalSApi.updateData(splitBuff2, true, 0, splitBuff2.byteLength).then(() => {
let pixelMap = imageSourceIncrementalSApi.createPixelMapSync()
let imageInfo = pixelMap.getImageInfoSync()
console.info('Succeeded in creating pixelMap')
}).catch((error : BusinessError) => {
console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`)
})
}).catch((error : BusinessError) => {
console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`)
}) image.CreateIncrementalSource9+
CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource
通过缓冲区以增量的方式创建图片源实例，IncrementalSource不支持读写Exif信息。
此接口支持的功能与CreateIncrementalSource(buf: ArrayBuffer): ImageSource所生成的实例支持的功能相同
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| buf | ArrayBuffer | 是 | 增量数据。 |
| options | SourceOptions | 否 | 图片属性，包括图片像素密度、像素格式和图片尺寸。 |
返回值：
| 类型 | 说明 |
|---|---|
| ImageSource | 返回图片源，失败时返回undefined。 |
示例：
const context: Context = getContext(this)
let imageArray = context.resourceManager.getMediaContentSync($r('app.media.startIcon')) // 获取图像资源
// 此处'app.media.startIcon'仅作示例，请开发者自行替换，否则imageArray创建失败会导致后续无法正常执行。
let splitBuff1 = imageArray.slice(0, imageArray.byteLength / 2) // 分片
let splitBuff2 = imageArray.slice(imageArray.byteLength / 2)
let sourceOptions: image.SourceOptions = { sourceDensity: 120};
const imageSourceIncrementalSApi: image.ImageSource = image.CreateIncrementalSource(new ArrayBuffer(imageArray.byteLength), sourceOptions);
imageSourceIncrementalSApi.updateData(splitBuff1, false, 0, splitBuff1.byteLength).then(() => {
imageSourceIncrementalSApi.updateData(splitBuff2, true, 0, splitBuff2.byteLength).then(() => {
let pixelMap = imageSourceIncrementalSApi.createPixelMapSync()
let imageInfo = pixelMap.getImageInfoSync()
console.info('Succeeded in creating pixelMap')
}).catch((error : BusinessError) => {
console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`)
})
}).catch((error : BusinessError) => {
console.error(`Failed to updateData error code is ${error.code}, message is ${error.message}`)
}) ImageSource
图片源类，用于获取图片相关信息。在调用ImageSource的方法前，需要先通过createImageSource构建一个ImageSource实例。
属性
系统能力： SystemCapability.Multimedia.Image.ImageSource
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| supportedFormats | Array<string> | 是 | 否 | 支持的图片格式，包括：png，jpeg，bmp，gif，webp，dng，heif12+（不同硬件设备支持情况不同）。 |
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 '@kit.BasicServicesKit';
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 '@kit.BasicServicesKit';
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 '@kit.BasicServicesKit';
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}`);
}) getImageInfoSync12+
getImageInfoSync(index?: number): ImageInfo
获取指定序号的图片信息，使用同步形式返回图片信息。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 否 | 创建图片源时的序号，不选择时默认为0。 |
返回值：
| 类型 | 说明 |
|---|---|
| ImageInfo | 同步返回获取到的图片信息。 |
示例：
import { image } from '@kit.ImageKit';
const context: Context = getContext();
//此处'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);
} getImageProperty11+
getImageProperty(key:PropertyKey, options?: ImagePropertyOptions): Promise<string>
获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果，仅支持JPEG、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的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; |
| 62980096 | The operation failed. |
| 62980103 | The image data is not supported. |
| 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 | Failed to decode the image header. |
| 62980123 | Images in EXIF format are not supported. |
| 62980135 | The EXIF value is invalid. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
从API version 11开始不再维护，建议使用getImageProperty代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 图片属性名。 |
| options | GetImagePropertyOptions | 否 | 图片属性，包括图片序号与默认属性值。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<string> | Promise对象，返回图片属性值，如获取失败则返回属性默认值。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
从API version 11开始不再维护，建议使用getImageProperty代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 图片属性名。 |
| callback | AsyncCallback<string> | 是 | 回调函数，当获取图片属性值成功，err为undefined，data为获取到的图片属性值；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
从API version 11开始不再维护，建议使用getImageProperty代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 图片属性名。 |
| options | GetImagePropertyOptions | 是 | 图片属性，包括图片序号与默认属性值。 |
| callback | AsyncCallback<string> | 是 | 回调函数，当获取图片属性值成功，err为undefined，data为获取到的图片属性值；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) getImageProperties12+
getImageProperties(key: Array<PropertyKey>): Promise<Record<PropertyKey, string|null>>
批量获取图片中的指定属性键的值，用Promise形式返回结果。仅支持JPEG、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的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 '@kit.ImageKit';
import { BusinessError } from '@kit.BasicServicesKit';
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));
}); modifyImageProperty11+
modifyImageProperty(key: PropertyKey, value: string): Promise<void>
通过指定的键修改图片属性的值，使用Promise形式返回结果，仅支持JPEG、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
调用modifyImageProperty修改属性会改变属性字节长度，使用buffer创建的ImageSource调用modifyImageProperty会导致buffer内容覆盖，目前buffer创建的ImageSource不支持调用此接口，请改用fd或path创建的ImageSource。
系统能力： 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 | The image does not support EXIF decoding. |
| 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 { BusinessError } from '@kit.BasicServicesKit';
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、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
调用modifyImageProperty修改属性会改变属性字节长度，使用buffer创建的ImageSource调用modifyImageProperty会导致buffer内容覆盖，目前buffer创建的ImageSource不支持调用此接口，请改用fd或path创建的ImageSource。
从API version 11开始不再维护，建议使用modifyImageProperty代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 图片属性名。 |
| value | string | 是 | 属性值。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
调用modifyImageProperty修改属性会改变属性字节长度，使用buffer创建的ImageSource调用modifyImageProperty会导致buffer内容覆盖，目前buffer创建的ImageSource不支持调用此接口，请改用fd或path创建的ImageSource。
从API version 11开始不再维护，建议使用modifyImageProperty代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 图片属性名。 |
| value | string | 是 | 属性值。 |
| callback | AsyncCallback<void> | 是 | 回调函数，当修改图片属性值成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) modifyImageProperties12+
modifyImageProperties(records: Record<PropertyKey, string|null>): Promise<void>
批量通过指定的键修改图片属性的值，使用Promise形式返回结果。仅支持JPEG、PNG和HEIF12+（不同硬件设备支持情况不同）文件，且需要包含exif信息。其中可以通过supportedFormats属性查询是否支持HEIF格式的exif读写。
说明
调用modifyImageProperties修改属性会改变属性字节长度，使用buffer创建的ImageSource调用modifyImageProperties会导致buffer内容覆盖，目前buffer创建的ImageSource不支持调用此接口，请改用fd或path创建的ImageSource。
系统能力： 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 | The image does not support EXIF decoding. |
| 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 '@kit.ImageKit';
import { BusinessError } from '@kit.BasicServicesKit';
let keyValues: Record<PropertyKey, string|null> = {
[image.PropertyKey.IMAGE_WIDTH] : "1024",
[image.PropertyKey.IMAGE_LENGTH] : "1024"
};
let checkKey = [image.PropertyKey.IMAGE_WIDTH, image.PropertyKey.IMAGE_LENGTH];
imageSourceApi.modifyImageProperties(keyValues).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));
}); updateData9+
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 '@kit.BasicServicesKit';
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}`);
}) updateData9+
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 '@kit.BasicServicesKit';
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.');
}
}) createPixelMap7+
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 '@kit.BasicServicesKit';
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.');
}) createPixelMap7+
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 '@kit.BasicServicesKit';
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.');
}
}) createPixelMap7+
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 '@kit.BasicServicesKit';
let decodingOptions: image.DecodingOptions = {
sampleSize: 1,
editable: true,
desiredSize: { width: 1, height: 2 },
rotate: 10,
desiredPixelFormat: image.PixelMapFormat.RGBA_8888,
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.');
}
}) createPixelMapSync12+
createPixelMapSync(options?: DecodingOptions): PixelMap
通过图片解码参数同步创建PixelMap对象。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | DecodingOptions | 否 | 解码参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| PixelMap | 用于同步返回创建结果。 |
示例：
import { image } from '@kit.ImageKit';
const context: Context = getContext();
//此处'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: image.PixelMapFormat.RGBA_8888,
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.');
} createPixelMapList10+
createPixelMapList(options?: DecodingOptions): Promise<Array<PixelMap>>
通过图片解码参数创建PixelMap数组。针对动图如Gif、Webp，此接口返回每帧图片数据；针对静态图，此接口返回唯一的一帧图片数据。
注意
此接口会一次性解码全部帧，当帧数过多或单帧图像过大时，会占用较大内存，造成系统内存紧张，此种情况推荐使用Image组件显示动图，Image组件采用逐帧解码，占用内存比此接口少。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | DecodingOptions | 否 | 解码参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<PixelMap>> | 异步返回PixeMap数组。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
| 62980173 | The DMA memory does not exist. |
| 62980174 | The DMA memory data is abnormal. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
let decodeOpts: image.DecodingOptions = {
sampleSize: 1,
editable: true,
desiredSize: { width: 198, height: 202 },
rotate: 0,
desiredPixelFormat: image.PixelMapFormat.RGBA_8888,
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}`);
}) createPixelMapList10+
createPixelMapList(callback: AsyncCallback<Array<PixelMap>>): void
通过默认参数创建PixelMap数组，使用callback形式返回结果。针对动图如Gif、Webp，此接口返回每帧图片数据；针对静态图，此接口返回唯一的一帧图片数据。
注意
此接口会一次性解码全部帧，当帧数过多或单帧图像过大时，会占用较大内存，造成系统内存紧张，此种情况推荐使用Image组件显示动图，Image组件采用逐帧解码，占用内存比此接口少。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<PixelMap>> | 是 | 回调函数，当创建PixelMap对象数组成功，err为undefined，data为获取到的PixelMap对象数组；否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
| 62980173 | The DMA memory does not exist. |
| 62980174 | The DMA memory data is abnormal. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) createPixelMapList10+
createPixelMapList(options: DecodingOptions, callback: AsyncCallback<Array<PixelMap>>): void
通过图片解码参数创建PixelMap数组，使用callback形式返回结果。针对动图如Gif、Webp，此接口返回每帧图片数据；针对静态图，此接口返回唯一的一帧图片数据。
注意
此接口会一次性解码全部帧，当帧数过多或单帧图像过大时，会占用较大内存，造成系统内存紧张，此种情况推荐使用Image组件显示动图，Image组件采用逐帧解码，占用内存比此接口少。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | DecodingOptions | 是 | 解码参数。 |
| callback | AsyncCallback<Array<PixelMap>> | 是 | 回调函数，当创建PixelMap对象数组成功，err为undefined，data为获取到的PixelMap对象数组；否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
| 62980173 | The DMA memory does not exist. |
| 62980174 | The DMA memory data is abnormal. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
let decodeOpts: image.DecodingOptions = {
sampleSize: 1,
editable: true,
desiredSize: { width: 198, height: 202 },
rotate: 0,
desiredPixelFormat: image.PixelMapFormat.RGBA_8888,
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.');
}
}) getDelayTimeList10+
getDelayTimeList(callback: AsyncCallback<Array<number>>): void
获取图像延迟时间数组，使用callback形式返回结果。此接口仅用于gif图片和webp图片。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<number>> | 是 | 回调函数，当获取图像延迟时间数组成功，err为undefined，data为获取到的图像延时时间数组；否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
| 62980149 | Invalid MIME type for the image source. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) getDelayTimeList10+
getDelayTimeList(): Promise<Array<number>>
获取图像延迟时间数组，使用Promise形式返回结果。此接口仅用于gif图片和webp图片。
系统能力： SystemCapability.Multimedia.Image.ImageSource
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<number>> | Promise对象，返回延迟时间数组。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
| 62980149 | Invalid MIME type for the image source. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) getFrameCount10+
getFrameCount(callback: AsyncCallback<number>): void
获取图像帧数，使用callback形式返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageSource
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<number> | 是 | 回调函数，当获取图像帧数成功，err为undefined，data为获取到的图像帧数；否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) getFrameCount10+
getFrameCount(): Promise<number>
获取图像帧数，使用Promise形式返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageSource
返回值：
| 类型 | 说明 |
|---|---|
| Promise<number> | Promise对象，返回图像帧数。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 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 | Failed to decode the image header. |
| 62980137 | Invalid media operation. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) getDisposalTypeList12+
getDisposalTypeList(): Promise<Array<number>>
获取图像帧过渡模式数组，使用Promise形式返回结果。此接口仅用于gif图片。
系统能力： SystemCapability.Multimedia.Image.ImageSource
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<number>> | Promise对象，返回帧过渡模式数组。 |
错误码：
以下错误码的详细介绍请参见Image错误码。
| 错误码ID | 错误信息 |
|---|---|
| 62980096 | The operation failed. |
| 62980101 | The image data is abnormal. |
| 62980137 | Invalid media operation. |
| 62980149 | Invalid MIME type for the image source. |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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 '@kit.BasicServicesKit';
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形式返回结果。
ArkTS有内存回收机制，ImageSource对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImageSource
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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、heif12+（不同硬件设备支持情况不同）。
属性
系统能力： SystemCapability.Multimedia.Image.ImagePacker
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| supportedFormats | Array<string> | 是 | 否 | 图片打包支持的格式 jpeg、webp、png、heif12+（不同硬件设备支持情况不同）。 |
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 '@kit.BasicServicesKit';
const context: Context = getContext();
//此处'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 '@kit.BasicServicesKit';
const context: Context = getContext();
//此处'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}`);
}) packing8+
packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBuffer>): void
图片压缩或重新打包，使用callback形式返回结果。
注意
接口如果返回"PixelMap mismatch"，表明参数异常，可能是PixelMap对象被提前释放了。需要调用方排查，在该方法调用结束后再释放PixelMap对象。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | PixelMap | 是 | 打包的PixelMap资源。 |
| option | PackingOption | 是 | 设置打包参数。 |
| callback | AsyncCallback<ArrayBuffer> | 是 | 回调函数，当图片打包成功，err为undefined，data为获取到的压缩或打包数据；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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}`);
}) packing8+
packing(source: PixelMap, option: PackingOption): Promise<ArrayBuffer>
图片压缩或重新打包，使用Promise形式返回结果。
注意
接口如果返回"PixelMap mismatch"，表明参数异常，可能是PixelMap对象被提前释放了。需要调用方排查，在该方法调用结束后再释放PixelMap对象。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | PixelMap | 是 | 打包的PixelMap源。 |
| option | PackingOption | 是 | 设置打包参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<ArrayBuffer> | Promise对象，返回压缩或打包后的数据。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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 '@kit.BasicServicesKit';
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形式返回释放结果。
ArkTS有内存回收机制，ImagePacker对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) packToFile11+
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 '@kit.BasicServicesKit';
import { fileIo as fs } from '@kit.CoreFileKit';
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.');
}
}) packToFile11+
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 '@kit.BasicServicesKit';
import { fileIo as fs } from '@kit.CoreFileKit';
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}`);
}) packToFile11+
packToFile (source: PixelMap, fd: number, options: PackingOption, callback: AsyncCallback<void>): void;
指定打包参数，将PixelMap图片源编码后直接打包进文件。使用callback形式返回结果。
注意
接口如果返回62980115错误码，表明参数异常，可能是PixelMap对象被提前释放了。需要调用方排查，在该方法调用结束后再释放PixelMap对象。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | PixelMap | 是 | 打包的PixelMap资源。 |
| fd | number | 是 | 文件描述符。 |
| options | PackingOption | 是 | 设置打包参数。 |
| callback | AsyncCallback<void> | 是 | 回调函数，当打包图片进文件成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { fileIo as fs } from '@kit.CoreFileKit';
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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.');
}
})
}) packToFile11+
packToFile (source: PixelMap, fd: number, options: PackingOption): Promise<void>
指定打包参数，将PixelMap图片源编码后直接打包进文件。使用Promise形式返回结果。
注意
接口如果返回62980115错误码，表明参数异常，可能是PixelMap对象被提前释放了。需要调用方排查，在该方法调用结束后再释放PixelMap对象。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | PixelMap | 是 | 打包的PixelMap资源。 |
| fd | number | 是 | 文件描述符。 |
| options | PackingOption | 是 | 设置打包参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
import { fileIo as fs } from '@kit.CoreFileKit';
const color: ArrayBuffer = new ArrayBuffer(96); // 96为需要创建的像素buffer大小，取值为：height * width *4
let opts: image.InitializationOptions = { editable: true, pixelFormat: image.PixelMapFormat.RGBA_8888, 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.createImageReceiver11+
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);
ImageReceiver9+
图像接收类，用于获取组件surface id，接收最新的图片和读取下一张图片，以及释放ImageReceiver实例。
在调用以下方法前需要先创建ImageReceiver实例。
属性
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| size | Size | 是 | 否 | 图片大小。 |
| capacity | number | 是 | 否 | 同时访问的图像数。 |
| format | ImageFormat | 是 | 否 | 图像格式。 |
getReceivingSurfaceId9+
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 '@kit.BasicServicesKit';
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.');
}
}); getReceivingSurfaceId9+
getReceivingSurfaceId(): Promise<string>
用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
返回值：
| 类型 | 说明 |
|---|---|
| Promise<string> | Promise对象，返回surface id。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) readLatestImage9+
readLatestImage(callback: AsyncCallback<Image>): void
从ImageReceiver读取最新的图片，并使用callback返回结果。
注意：此接口需要在on回调触发后调用，才能正常的接收到数据。且此接口返回的Image对象使用完毕后需要调用release方法释放，释放后才可以继续接收新的数据。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Image> | 是 | 回调函数，当读取最新图片成功，err为undefined，data为获取到的最新图片；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}); readLatestImage9+
readLatestImage(): Promise<Image>
从ImageReceiver读取最新的图片，并使用promise返回结果。
注意：此接口需要在on回调触发后调用，才能正常的接收到数据。且此接口返回的Image对象使用完毕后需要调用release方法释放，释放后才可以继续接收新的数据。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Image> | Promise对象，返回最新图片。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) readNextImage9+
readNextImage(callback: AsyncCallback<Image>): void
从ImageReceiver读取下一张图片，并使用callback返回结果。
注意：此接口需要在on回调触发后调用，才能正常的接收到数据。且此接口返回的Image对象使用完毕后需要调用release方法释放，释放后才可以继续接收新的数据。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Image> | 是 | 回调函数，当获取下一张图片成功，err为undefined，data为获取到的下一张图片；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}); readNextImage9+
readNextImage(): Promise<Image>
从ImageReceiver读取下一张图片，并使用promise返回结果。
注意：此接口需要在on回调触发后调用，才能正常的接收到数据。且此接口返回的Image对象使用完毕后需要调用release方法释放，释放后才可以继续接收新的数据。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Image> | Promise对象，返回下一张图片。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) on9+
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.
}) release9+
release(callback: AsyncCallback<void>): void
释放ImageReceiver实例并使用回调返回结果。
ArkTS有内存回收机制，ImageReceiver对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，当释放ImageReceiver实例成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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 releasing the receiver.');
}
}) release9+
release(): Promise<void>
释放ImageReceiver实例并使用promise返回结果。
ArkTS有内存回收机制，ImageReceiver对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
receiver.release().then(() => {
console.info('Succeeded in releasing the receiver.');
}).catch((error: BusinessError) => {
console.error(`Failed to release the receiver.code ${error.code},message is ${error.message}`);
}) image.createImageCreator11+
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);
ImageCreator9+
图像创建模块，用于请求图像原生数据区域，并开放给应用编译原生图像数据的能力。
在调用以下方法前需要先创建ImageCreator实例，ImageCreator不支持多线程。
属性
系统能力： SystemCapability.Multimedia.Image.ImageCreator
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| capacity | number | 是 | 否 | 同时访问的图像数。 |
| format | ImageFormat | 是 | 否 | 图像格式。 |
dequeueImage9+
dequeueImage(callback: AsyncCallback<Image>): void
从空闲队列中获取buffer图片，用于绘制UI内容，并使用callback返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Image> | 是 | 回调函数，当获取最新图片成功，err为undefined，data为获取到的最新图片；否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}); dequeueImage9+
dequeueImage(): Promise<Image>
从空闲队列中获取buffer图片，用于绘制UI内容，并使用promise返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Image> | Promise对象，返回最新图片。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) queueImage9+
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 '@kit.BasicServicesKit';
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.');
}
})
}) queueImage9+
queueImage(interface: Image): Promise<void>
将绘制好的图片放入Dirty队列，并使用promise返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| interface | Image | 是 | 绘制好的buffer图像。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
})
}) on9+
on(type: 'imageRelease', callback: AsyncCallback<void>): void
监听imageRelease事件，并使用callback返回结果。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件类型，如'imageRelease'。 |
| callback | AsyncCallback<void> | 是 | 回调函数，当监听事件触发成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) release9+
release(callback: AsyncCallback<void>): void
释放当前图像，并使用callback返回结果。
ArkTS有内存回收机制，ImageCreator对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，当图像释放成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}); release9+
release(): Promise<void>
释放当前图像，并使用promise返回结果。
ArkTS有内存回收机制，ImageCreator对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.ImageCreator
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) Image9+
提供基本的图像操作，包括获取图像信息、读写图像数据。调用readNextImage和readLatestImage接口时会返回image。
属性
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| clipRect | Region | 是 | 是 | 要裁剪的图像区域。 |
| size | Size | 是 | 否 | 图像大小。如果image对象所存储的是相机预览流数据，即YUV图像数据，那么获取到的size中的宽高分别对应YUV图像的宽高； 如果image对象所存储的是相机拍照流数据，即JPEG图像，由于已经是编码后的文件，size中的宽等于JPEG文件大小，高等于1。image对象所存储的数据是预览流还是拍照流，取决于应用将receiver中的surfaceId传给相机的previewOutput还是captureOutput。 |
| format | number | 是 | 否 | 图像格式，参考OH_NativeBuffer_Format。 |
| timestamp12+ | number | 是 | 否 | 图像时间戳。时间戳以纳秒为单位，通常是单调递增的。时间戳的具体含义和基准取决于图像的生产者，在相机预览/拍照场景，生产者就是相机。来自不同生产者的图像的时间戳可能有不同的含义和基准，因此可能无法进行比较。如果要获取某张照片的生成时间，可以通过getImageProperty接口读取相关的EXIF信息。 |
getComponent9+
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 '@kit.BasicServicesKit';
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.');
}
}) getComponent9+
getComponent(componentType: ComponentType): Promise<Component>
根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| componentType | ComponentType | 是 | 图像的组件类型。（目前仅支持 ComponentType:JPEG，实际返回格式由生产者决定，如相机） |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Component> | Promise对象，返回组件缓冲区。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) release9+
release(callback: AsyncCallback<void>): void
释放当前图像并使用callback返回结果。
在接收另一个图像前必须先释放对应资源。
ArkTS有内存回收机制，Image对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，当图像释放成功，err为undefined，否则为错误对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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.');
}
}) release9+
release(): Promise<void>
释放当前图像并使用Promise方式返回结果。
在接收另一个图像前必须先释放对应资源。
ArkTS有内存回收机制，Image对象不调用release方法，内存最终也会由系统统一释放。但图片使用的内存往往较大，为尽快释放内存，建议应用在使用完成后主动调用release方法提前释放内存。
系统能力： SystemCapability.Multimedia.Image.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
示例：
import { BusinessError } from '@kit.BasicServicesKit';
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}`);
}) PositionArea7+
表示图片指定区域内的数据。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| pixels | ArrayBuffer | 否 | 否 | 像素。仅支持BGRA_8888格式的图像像素数据。 |
| offset | number | 否 | 否 | 偏移量。 |
| stride | number | 否 | 否 | 跨距，内存中每行像素所占的空间。stride >= region.size.width*4。 |
| region | Region | 否 | 否 | 区域，按照区域读写。写入的区域宽度加X坐标不能大于原图的宽度，写入的区域高度加Y坐标不能大于原图的高度。 |
ImageInfo
表示图片信息。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| size6+ | Size | 否 | 否 | 图片大小。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| density9+ | number | 否 | 否 | 像素密度，单位为ppi。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| stride11+ | number | 否 | 否 | 跨距，内存中每行像素所占的空间。stride >= region.size.width*4 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| pixelFormat12+ | PixelMapFormat | 否 | 否 | 像素格式。 元服务API： 从API version 12开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| alphaType12+ | AlphaType | 否 | 否 | 透明度。 元服务API： 从API version 12开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| mimeType12+ | string | 否 | 否 | 图片真实格式（MIME type）。 |
| isHdr12+ | boolean | 否 | 否 | 图片是否为高动态范围（HDR）。对于ImageSource，代表源图片是否为HDR；对于PixelMap，代表解码后的pixelmap是否为HDR。 |
Size
表示图片尺寸。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| height | number | 否 | 否 | 输出图片的高，单位：像素。 |
| width | number | 否 | 否 | 输出图片的宽，单位：像素。 |
PixelMapFormat7+
枚举，图片像素格式。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| UNKNOWN | 0 | 未知格式。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| RGB_565 | 2 | 格式为RGB_565。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| RGBA_8888 | 3 | 格式为RGBA_8888。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| BGRA_88889+ | 4 | 格式为BGRA_8888。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| RGB_8889+ | 5 | 格式为RGB_888。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ALPHA_89+ | 6 | 格式为ALPHA_8。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| RGBA_F169+ | 7 | 格式为RGBA_F16。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| NV219+ | 8 | 格式为NV21。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| NV129+ | 9 | 格式为NV12。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| RGBA_101010212+ | 10 | 格式为RGBA_1010102 |
| YCBCR_P01012+ | 11 | 格式为YCBCR_P010 |
| YCRCB_P01012+ | 12 | 格式为YCRCB_P010 |
AlphaType9+
枚举，图像的透明度类型。
卡片能力： 从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。 |
ScaleMode9+
枚举，图像的缩放模式。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 |
| FIT_TARGET_SIZE | 0 | 图像适合目标尺寸的效果。 |
SourceOptions9+
ImageSource的初始化选项。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| sourceDensity | number | 否 | 否 | 图片资源像素密度，单位DPI。 在解码参数DecodingOptions未设置desiredSize的前提下，当前参数SourceOptions.sourceDensity与DecodingOptions.fitDensity非零时将对解码输出的pixelmap进行缩放。 缩放后宽计算公式如下(高同理)：(width * fitDensity + (sourceDensity >> 1)) / sourceDensity。 |
| sourcePixelFormat | PixelMapFormat | 否 | 是 | 图片像素格式，默认值为UNKNOWN。 |
| sourceSize | Size | 否 | 是 | 图像像素大小，默认值为空。 |
InitializationOptions8+
PixelMap的初始化选项。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| alphaType9+ | AlphaType | 否 | 是 | 透明度。默认值为IMAGE_ALPHA_TYPE_PREMUL。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| editable | boolean | 否 | 是 | 是否可编辑。默认值为false。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| srcPixelFormat12+ | PixelMapFormat | 否 | 是 | 传入的buffer数据的像素格式。默认值为BGRA_8888。 |
| pixelFormat | PixelMapFormat | 否 | 是 | 生成的pixelMap的像素格式。默认值为RGBA_8888。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| scaleMode9+ | ScaleMode | 否 | 是 | 缩略值。默认值为0。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| size | Size | 否 | 否 | 创建图片大小。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
DecodingOptions7+
图像解码设置选项。
系统能力： 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时，图片不可二次编辑，如writepixels操作将失败。 元服务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卡片中使用。 |
| fitDensity9+ | number | 否 | 是 | 图像像素密度，单位为ppi。默认值为0。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| desiredColorSpace11+ | colorSpaceManager.ColorSpaceManager | 否 | 是 | 目标色彩空间。默认值为UNKNOWN。 |
| desiredDynamicRange12+ | DecodingDynamicRange | 否 | 是 | 目标动态范围，默认值为SDR。 通过CreateIncrementalSource创建的imagesource不支持设置此属性，默认解码为SDR内容。 如果平台不支持HDR，设置无效，默认解码为SDR内容。 |
Region8+
表示区域信息。
卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。
元服务API： 从API version 11开始，该接口支持在元服务中使用。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| size7+ | Size | 否 | 否 | 区域大小。 |
| x7+ | number | 否 | 否 | 区域横坐标。 |
| y7+ | number | 否 | 否 | 区域纵坐标。 |
PackingOption
表示图片打包选项。
系统能力： SystemCapability.Multimedia.Image.ImagePacker
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| format | string | 否 | 否 | 目标格式。 当前只支持"image/jpeg"、"image/webp"、"image/png"和"image/heif"12+（不同硬件设备支持情况不同）。 说明： 因为jpeg不支持透明通道，若使用带透明通道的数据编码jpeg格式，透明色将变为黑色。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 |
| quality | number | 否 | 否 | JPEG编码中设定输出图片质量的参数，取值范围为0-100。0质量最低，100质量最高，质量越高生成图片所占空间越大。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 |
| bufferSize9+ | number | 否 | 是 | 接收编码数据的缓冲区大小，单位为Byte。如果不设置大小，默认为25M。如果编码图片超过25M，需要指定大小。bufferSize需大于编码后图片大小。使用packToFile不受此参数限制。 元服务API： 从API version 11开始，该接口支持在元服务中使用。 |
| desiredDynamicRange12+ | PackingDynamicRange | 否 | 是 | 目标动态范围。默认值为SDR。 |
| needsPackProperties12+ | boolean | 否 | 是 | 是否需要编码图片属性信息，例如EXIF。默认值为false。 |
ImagePropertyOptions11+
表示查询图片属性的索引。
系统能力： SystemCapability.Multimedia.Image.ImageSource
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| index | number | 是 | 是 | 图片序号。默认值为0。 |
| defaultValue | string | 是 | 是 | 默认属性值。默认值为空。 |
GetImagePropertyOptions(deprecated)
表示查询图片属性的索引。
说明
从API version 11开始不再维护，建议使用ImagePropertyOptions代替。
系统能力： SystemCapability.Multimedia.Image.ImageSource
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| index | number | 否 | 是 | 图片序号。默认值为0。 |
| defaultValue | string | 否 | 是 | 默认属性值。默认值为空。 |
PropertyKey7+
枚举，Exif（Exchangeable image file format）图片信息。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| NEW_SUBFILE_TYPE 12+ | "NewSubfileType" | 读写能力： 可读写 在Exif中，"NewSubfileType"字段用于标识子文件的数据类型，如全分辨率图像、缩略图或多帧图像的一部分。其值是位掩码，0代表全分辨率图像，1代表缩略图，2代表多帧图像的一部分。 |
| SUBFILE_TYPE 12+ | "SubfileType" | 读写能力： 可读写 此标签指示此子文件中的数据类型。标签已弃用，请使用NewSubfileType替代。 |
| IMAGE_WIDTH | "ImageWidth" | 读写能力： 可读写 图片宽度。 |
| IMAGE_LENGTH | "ImageLength" | 读写能力： 可读写 图片长度。 |
| BITS_PER_SAMPLE | "BitsPerSample" | 读写能力： 可读写 像素各分量的位数，如RGB，3分量，格式是8, 8, 8。 |
| COMPRESSION 12+ | "Compression" | 读写能力： 可读写 图像压缩方案。 |
| PHOTOMETRIC_INTERPRETATION 12+ | "PhotometricInterpretation" | 读写能力： 可读写 像素构成，例如 RGB 或 YCbCr。 |
| IMAGE_DESCRIPTION10+ | "ImageDescription" | 读写能力： 可读写 图像信息描述。 |
| MAKE10+ | "Make" | 读写能力： 可读写 生产商。 |
| MODEL10+ | "Model" | 读写能力： 可读写 设备型号。 |
| STRIP_OFFSETS 12+ | "StripOffsets" | 读写能力： 可读写 每个strip的字节偏移量。 |
| ORIENTATION | "Orientation" | 读写能力： 可读写 图片方向。 - 1：Top-left，图像未旋转。 - 2：Top-right，镜像水平翻转。 - 3：Bottom-right，图像旋转180°。 - 4：Bottom-left，镜像垂直翻转。 - 5：Left-top，镜像水平翻转再顺时针旋转270°。 - 6：Right-top，顺时针旋转90°。 - 7：Right-bottom，镜像水平翻转再顺时针旋转90°。 - 8：Left-bottom，顺时针旋转270°。 - 未定义值返回Unknown Value。 |
| SAMPLES_PER_PIXEL 12+ | "SamplesPerPixel" | 读写能力： 可读写 每个像素的分量数。由于该标准适用于 RGB 和 YCbCr 图像，因此该标签的值设置为 3。在 JPEG 压缩数据中，使用 JPEG 标记代替该标签。 |
| ROWS_PER_STRIP 12+ | "RowsPerStrip" | 读写能力： 可读写 每个strip的图像数据行数。 |
| STRIP_BYTE_COUNTS 12+ | "StripByteCounts" | 读写能力： 可读写 每个图像数据带的总字节数。 |
| X_RESOLUTION 12+ | "XResolution" | 读写能力： 可读写 图像宽度方向的分辨率。 |
| Y_RESOLUTION 12+ | "YResolution" | 读写能力： 可读写 图像高度方向的分辨率。 |
| PLANAR_CONFIGURATION 12+ | "PlanarConfiguration" | 读写能力： 可读写 表示像素组件的记录格式，chunky格式或是planar格式。 |
| RESOLUTION_UNIT 12+ | "ResolutionUnit" | 读写能力： 可读写 用于测量XResolution和YResolution的单位。 |
| TRANSFER_FUNCTION 12+ | "TransferFunction" | 读写能力： 可读写 图像的传递函数，通常用于颜色校正。 |
| SOFTWARE 12+ | "Software" | 读写能力： 可读写 用于生成图像的软件的名称和版本。 |
| DATE_TIME10+ | "DateTime" | 读写能力： 可读写 日期时间。格式如2024:01:25 05:51:34。 |
| ARTIST 12+ | "Artist" | 读写能力： 可读写 创建图像的用户名称。 |
| WHITE_POINT 12+ | "WhitePoint" | 读写能力： 可读写 图像的白点色度。 |
| PRIMARY_CHROMATICITIES 12+ | "PrimaryChromaticities" | 读写能力： 可读写 图像的主要颜色的色度。 |
| PHOTO_MODE10+ | "PhotoMode" | 读写能力： 可读写 拍照模式。 |
| JPEG_INTERCHANGE_FORMAT 12+ | "JPEGInterchangeFormat" | 读写能力： 可读写 JPEG压缩缩略图数据开始字节（SOI）的偏移。 |
| JPEG_INTERCHANGE_FORMAT_LENGTH 12+ | "JPEGInterchangeFormatLength" | 读写能力： 可读写 JPEG压缩缩略图数据的字节数。 |
| YCBCR_COEFFICIENTS 12+ | "YCbCrCoefficients" | 读写能力： 可读写 从RGB到YCbCr图像数据的转换矩阵系数。 |
| YCBCR_SUB_SAMPLING 12+ | "YCbCrSubSampling" | 读写能力： 可读写 色度分量与亮度分量的采样比率。 |
| YCBCR_POSITIONING 12+ | "YCbCrPositioning" | 读写能力： 可读写 色度分量相对于亮度分量的位置。 |
| REFERENCE_BLACK_WHITE 12+ | "ReferenceBlackWhite" | 读写能力： 可读写 参考黑点值和参考白点值。 |
| COPYRIGHT 12+ | "Copyright" | 读写能力： 可读写 图像的版权信息。 |
| EXPOSURE_TIME9+ | "ExposureTime" | 读写能力： 可读写 曝光时间，例如1/33 sec。 |
| F_NUMBER9+ | "FNumber" | 读写能力： 可读写 光圈值，例如f/1.8。 |
| EXPOSURE_PROGRAM 12+ | "ExposureProgram" | 读写能力： 可读写 拍照时相机用来设置曝光的程序的类别。 |
| SPECTRAL_SENSITIVITY 12+ | "SpectralSensitivity" | 读写能力： 可读写 表示所用相机的每个通道的光谱灵敏度。 |
| GPS_VERSION_ID 12+ | "GPSVersionID" | 读写能力： 可读写 GPSInfoIFD的版本。 |
| GPS_LATITUDE_REF | "GPSLatitudeRef" | 读写能力： 可读写 纬度引用，例如N或S。 |
| GPS_LATITUDE | "GPSLatitude" | 读写能力： 可读写 图片纬度。修改时应按"度,分,秒"格式传入，如"39,54,7.542" |
| GPS_LONGITUDE_REF | "GPSLongitudeRef" | 读写能力： 可读写 经度引用，例如W或E。 |
| GPS_LONGITUDE | "GPSLongitude" | 读写能力： 可读写 图片经度。修改时应按"度,分,秒"格式传入，如"116,19,42.16" |
| GPS_ALTITUDE_REF 12+ | "GPSAltitudeRef" | 读写能力： 可读写 用于GPS高度的参照高度。 |
| GPS_ALTITUDE 12+ | "GPSAltitude" | 读写能力： 可读写 基于GPSAltitudeRef的高度。 |
| GPS_TIME_STAMP10+ | "GPSTimeStamp" | 读写能力： 可读写 GPS时间戳。 |
| GPS_SATELLITES 12+ | "GPSSatellites" | 读写能力： 可读写 用于测量的GPS卫星。 |
| GPS_STATUS 12+ | "GPSStatus" | 读写能力： 可读写 录制图像时GPS接收器的状态。 |
| GPS_MEASURE_MODE 12+ | "GPSMeasureMode" | 读写能力： 可读写 GPS测量模式。 |
| GPS_DOP 12+ | "GPSDOP" | 读写能力： 可读写 GPS DOP（数据精度等级）。 |
| GPS_SPEED_REF 12+ | "GPSSpeedRef" | 读写能力： 可读写 用来表示GPS接收器移动速度的单位。 |
| GPS_SPEED 12+ | "GPSSpeed" | 读写能力： 可读写 GPS接收器的移动速度。 |
| GPS_TRACK_REF 12+ | "GPSTrackRef" | 读写能力： 可读写 GPS接收机移动方向的参照。 |
| GPS_TRACK 12+ | "GPSTrack" | 读写能力： 可读写 GPS接收机的移动方向。 |
| GPS_IMG_DIRECTION_REF 12+ | "GPSImgDirectionRef" | 读写能力： 可读写 图像方向的参照。 |
| GPS_IMG_DIRECTION 12+ | "GPSImgDirection" | 读写能力： 可读写 拍摄时图像的方向。 |
| GPS_MAP_DATUM 12+ | "GPSMapDatum" | 读写能力： 可读写 GPS接收器使用的大地测量数据。 |
| GPS_DEST_LATITUDE_REF 12+ | "GPSDestLatitudeRef" | 读写能力： 可读写 目的地点的纬度参照。 |
| GPS_DEST_LATITUDE 12+ | "GPSDestLatitude" | 读写能力： 可读写 目的地点的纬度。 |
| GPS_DEST_LONGITUDE_REF 12+ | "GPSDestLongitudeRef" | 读写能力： 可读写 目的地点的经度参照。 |
| GPS_DEST_LONGITUDE 12+ | "GPSDestLongitude" | 读写能力： 可读写 目的地点的经度。 |
| GPS_DEST_BEARING_REF 12+ | "GPSDestBearingRef" | 读写能力： 可读写 指向目的地点的方位参照。 |
| GPS_DEST_BEARING 12+ | "GPSDestBearing" | 读写能力： 可读写 目的地方位。 |
| GPS_DEST_DISTANCE_REF 12+ | "GPSDestDistanceRef" | 读写能力： 可读写 目标点距离的测量单位。 |
| GPS_DEST_DISTANCE 12+ | "GPSDestDistance" | 读写能力： 可读写 到目的地点的距离。 |
| GPS_PROCESSING_METHOD 12+ | "GPSProcessingMethod" | 读写能力： 可读写 记录定位方法名的字符字符串。 |
| GPS_AREA_INFORMATION 12+ | "GPSAreaInformation" | 读写能力： 可读写 记录GPS区域名的字符字符串。 |
| GPS_DATE_STAMP10+ | "GPSDateStamp" | 读写能力： 可读写 GPS日期戳。 |
| GPS_DIFFERENTIAL 12+ | "GPSDifferential" | 读写能力： 可读写 此字段表示GPS数据是否应用了差分校正，对于精确的位置准确性至关重要。 |
| GPS_H_POSITIONING_ERROR 12+ | "GPSHPositioningError" | 读写能力： 可读写 此标签指示水平定位误差，单位为米。 |
| ISO_SPEED_RATINGS9+ | "ISOSpeedRatings" | 读写能力： 可读写 ISO感光度，例如400。 |
| PHOTOGRAPHIC_SENSITIVITY 12+ | "PhotographicSensitivity" | 读写能力： 可读写 此标签指示拍摄图像时相机或输入设备的灵敏度。 |
| OECF 12+ | "OECF" | 读写能力： 可读写 表示ISO 14524中规定的光电转换函数（OECF）。 |
| SENSITIVITY_TYPE10+ | "SensitivityType" | 读写能力： 可读写 灵敏度类型。 |
| STANDARD_OUTPUT_SENSITIVITY10+ | "StandardOutputSensitivity" | 读写能力： 可读写 标准输出灵敏度。 |
| RECOMMENDED_EXPOSURE_INDEX10+ | "RecommendedExposureIndex" | 读写能力： 可读写 推荐曝光指数。 |
| ISO_SPEED10+ | "ISOSpeedRatings" | 读写能力： 可读写 ISO速度等级。 |
| ISO_SPEED_LATITUDE_YYY 12+ | "ISOSpeedLatitudeyyy" | 读写能力： 可读写 该标签指示摄像机或输入设备的ISO速度纬度yyy值，该值在ISO 12232中定义。 |
| ISO_SPEED_LATITUDE_ZZZ 12+ | "ISOSpeedLatitudezzz" | 读写能力： 可读写 该标签指示摄像机或输入设备的ISO速度纬度zzz值，该值在ISO 12232中定义。 |
| EXIF_VERSION 12+ | "ExifVersion" | 读写能力： 可读写 支持的Exif标准版本。 |
| DATE_TIME_ORIGINAL9+ | "DateTimeOriginal" | 读写能力： 可读写 拍摄时间，例如2022:09:06 15:48:00。 |
| DATE_TIME_DIGITIZED 12+ | "DateTimeDigitized" | 读写能力： 可读写 图像作为数字数据存储的日期和时间，格式为YYYY:MM:DD HH:MM:SS |
| OFFSET_TIME 12+ | "OffsetTime" | 读写能力： 可读写 在Exif中，OffsetTime字段表示与UTC（协调世界时）的时间偏移，格式为±HH:MM，用于确定照片拍摄的本地时间。 |
| OFFSET_TIME_ORIGINAL 12+ | "OffsetTimeOriginal" | 读写能力： 可读写 此标签记录原始图像创建时的UTC偏移量，对于时间敏感的应用至关重要。 |
| OFFSET_TIME_DIGITIZED 12+ | "OffsetTimeDigitized" | 读写能力： 可读写 此标签记录图像数字化时的UTC偏移量，有助于准确调整时间戳。 |
| COMPONENTS_CONFIGURATION 12+ | "ComponentsConfiguration" | 读写能力： 可读写 压缩数据的特定信息。 |
| COMPRESSED_BITS_PER_PIXEL 12+ | "CompressedBitsPerPixel" | 读写能力： 可读写 用于压缩图像的压缩模式，单位为每像素位数。 |
| SHUTTER_SPEED 12+ | "ShutterSpeedValue" | 读写能力： 可读写 快门速度，以APEX（摄影曝光的加法系统）值表示。 |
| APERTURE_VALUE10+ | "ApertureValue" | 读写能力： 可读写 光圈值。格式如4/1。 |
| BRIGHTNESS_VALUE 12+ | "BrightnessValue" | 读写能力： 可读写 图像的亮度值，以APEX单位表示。 |
| EXPOSURE_BIAS_VALUE10+ | "ExposureBiasValue" | 读写能力： 可读写 曝光偏差值。 |
| MAX_APERTURE_VALUE 12+ | "MaxApertureValue" | 读写能力： 可读写 最小F数镜头。 |
| SUBJECT_DISTANCE 12+ | "SubjectDistance" | 读写能力： 可读写 测量单位为米的主体距离。 |
| METERING_MODE10+ | "MeteringMode" | 读写能力： 可读写 测光模式。 |
| LIGHT_SOURCE10+ | "LightSource" | 读写能力： 可读写 光源。例如Fluorescent。 |
| FLASH 10+ | "Flash" | 读写能力： 可读写 闪光灯,记录闪光灯状态。 |
| FOCAL_LENGTH 10+ | "FocalLength" | 读写能力： 可读写 焦距。 |
| SUBJECT_AREA 12+ | "SubjectArea" | 读写能力： 可读写 该标签指示整个场景中主要主体的位置和区域。 |
| MAKER_NOTE 12+ | "MakerNote" | 读写能力： 只读 Exif/DCF制造商使用的标签，用于记录任何所需信息。 |
| SCENE_POINTER 12+ | "HwMnoteScenePointer" | 读写能力： 只读 场景指针。 |
| SCENE_VERSION 12+ | "HwMnoteSceneVersion" | 读写能力： 只读 场景算法版本信息。 |
| SCENE_FOOD_CONF11+ | "HwMnoteSceneFoodConf" | 读写能力： 只读 拍照场景：食物。 |
| SCENE_STAGE_CONF11+ | "HwMnoteSceneStageConf" | 读写能力： 只读 拍照场景：舞台。 |
| SCENE_BLUE_SKY_CONF11+ | "HwMnoteSceneBlueSkyConf" | 读写能力： 只读 拍照场景：蓝天。 |
| SCENE_GREEN_PLANT_CONF11+ | "HwMnoteSceneGreenPlantConf" | 读写能力： 只读 拍照场景：绿植。 |
| SCENE_BEACH_CONF11+ | "HwMnoteSceneBeachConf" | 读写能力： 只读 拍照场景：沙滩。 |
| SCENE_SNOW_CONF11+ | "HwMnoteSceneSnowConf" | 读写能力： 只读 拍照场景：下雪。 |
| SCENE_SUNSET_CONF11+ | "HwMnoteSceneSunsetConf" | 读写能力： 只读 拍照场景：日落。 |
| SCENE_FLOWERS_CONF11+ | "HwMnoteSceneFlowersConf" | 读写能力： 只读 拍照场景：花。 |
| SCENE_NIGHT_CONF11+ | "HwMnoteSceneNightConf" | 读写能力： 只读 拍照场景：夜晚。 |
| SCENE_TEXT_CONF11+ | "HwMnoteSceneTextConf" | 读写能力： 只读 拍照场景：文本。 |
| FACE_POINTER 12+ | "HwMnoteFacePointer" | 读写能力： 只读 脸部指针。 |
| FACE_VERSION 12+ | "HwMnoteFaceVersion" | 读写能力： 只读 人脸算法版本信息。 |
| FACE_COUNT11+ | "HwMnoteFaceCount" | 读写能力： 只读 人脸数量。 |
| FACE_CONF 12+ | "HwMnoteFaceConf" | 读写能力： 只读 人脸置信度。 |
| FACE_SMILE_SCORE 12+ | "HwMnoteFaceSmileScore" | 读写能力： 只读 FaceCount张人脸的笑脸分数。 |
| FACE_RECT 12+ | "HwMnoteFaceRect" | 读写能力： 只读 脸部矩形。 |
| FACE_LEYE_CENTER 12+ | "HwMnoteFaceLeyeCenter" | 读写能力： 只读 左眼中心。 |
| FACE_REYE_CENTER 12+ | "HwMnoteFaceReyeCenter" | 读写能力： 只读 右眼中心。 |
| FACE_MOUTH_CENTER 12+ | "HwMnoteFaceMouthCenter" | 读写能力： 只读 嘴中心。 |
| CAPTURE_MODE 10+ | "HwMnoteCaptureMode" | 读写能力： 可读写 捕获模式。 |
| BURST_NUMBER 12+ | "HwMnoteBurstNumber" | 读写能力： 只读 连拍次数。 |
| FRONT_CAMERA 12+ | "HwMnoteFrontCamera" | 读写能力： 只读 是否是前置相机自拍。 |
| ROLL_ANGLE 11+ | "HwMnoteRollAngle" | 读写能力： 只读 滚动角度。 |
| PITCH_ANGLE11+ | "HwMnotePitchAngle" | 读写能力： 只读 俯仰角度。 |
| PHYSICAL_APERTURE 10+ | "HwMnotePhysicalAperture" | 读写能力： 只读 物理孔径，光圈大小。 |
| FOCUS_MODE11+ | "HwMnoteFocusMode" | 读写能力： 只读 对焦模式。 |
| USER_COMMENT 10+ | "UserComment" | 读写能力： 可读写 用户注释。 |
| SUBSEC_TIME 12+ | "SubsecTime" | 读写能力： 可读写 用于为DateTime标签记录秒的分数的标签。 |
| SUBSEC_TIME_ORIGINAL 12+ | "SubsecTimeOriginal" | 读写能力： 可读写 用于为DateTimeOriginal标签记录秒的分数的标签。 |
| SUBSEC_TIME_DIGITIZED 12+ | "SubsecTimeDigitized" | 读写能力： 可读写 用于为DateTimeDigitized标签记录秒的分数的标签。 |
| FLASHPIX_VERSION 12+ | "FlashpixVersion" | 读写能力： 可读写 该标签表示FPXR文件支持的Flashpix格式版本，增强了设备兼容性。 |
| COLOR_SPACE 12+ | "ColorSpace" | 读写能力： 可读写 色彩空间信息标签，通常记录为色彩空间指定符。 |
| PIXEL_X_DIMENSION 10+ | "PixelXDimension" | 读写能力： 可读写 像素X尺寸。 |
| PIXEL_Y_DIMENSION10+ | "PixelYDimension" | 读写能力： 可读写 像素Y尺寸。 |
| RELATED_SOUND_FILE 12+ | "RelatedSoundFile" | 读写能力： 可读写 与图像数据相关的音频文件的名称。 |
| FLASH_ENERGY 12+ | "FlashEnergy" | 读写能力： 可读写 图像捕获时的闪光能量，以BCPS表示。 |
| SPATIAL_FREQUENCY_RESPONSE 12+ | "SpatialFrequencyResponse" | 读写能力： 可读写 相机或输入设备的空间频率表。 |
| FOCAL_PLANE_X_RESOLUTION 12+ | "FocalPlaneXResolution" | 读写能力： 可读写 图像宽度中每FocalPlaneResolutionUnit的像素。 |
| FOCAL_PLANE_Y_RESOLUTION 12+ | "FocalPlaneYResolution" | 读写能力： 可读写 图像高度中每FocalPlaneResolutionUnit的像素。 |
| FOCAL_PLANE_RESOLUTION_UNIT 12+ | "FocalPlaneResolutionUnit" | 读写能力： 可读写 测量FocalPlaneXResolution和FocalPlaneYResolution的单位。 |
| SUBJECT_LOCATION 12+ | "SubjectLocation" | 读写能力： 可读写 主要对象相对于左边缘的位置。 |
| EXPOSURE_INDEX 12+ | "ExposureIndex" | 读写能力： 可读写 捕获时选定的曝光指数。 |
| SENSING_METHOD 12+ | "SensingMethod" | 读写能力： 可读写 相机上的图像传感器类型。 |
| FILE_SOURCE 12+ | "FileSource" | 读写能力： 可读写 表明图像来源。 |
| SCENE_TYPE9+ | "SceneType" | 读写能力： 可读写 拍摄场景模式，例如人像、风光、运动、夜景等。 |
| CFA_PATTERN 12+ | "CFAPattern" | 读写能力： 可读写 图像传感器的色彩滤光片（CFA）几何图案。 |
| CUSTOM_RENDERED 12+ | "CustomRendered" | 读写能力： 可读写 指示图像数据上的特殊处理。 |
| EXPOSURE_MODE 12+ | "ExposureMode" | 读写能力： 可读写 拍摄时设置的曝光模式。 |
| WHITE_BALANCE 10+ | "WhiteBalance" | 读写能力： 可读写 白平衡。 |
| DIGITAL_ZOOM_RATIO 12+ | "DigitalZoomRatio" | 读写能力： 可读写 捕获时的数字变焦比率。 |
| FOCAL_LENGTH_IN_35_MM_FILM 10+ | "FocalLengthIn35mmFilm" | 读写能力： 可读写 焦距35毫米胶片。 |
| SCENE_CAPTURE_TYPE 12+ | "SceneCaptureType" | 读写能力： 可读写 捕获的场景类型。 |
| GAIN_CONTROL 12+ | "GainControl" | 读写能力： 可读写 整体图像增益调整的程度。 |
| CONTRAST 12+ | "Contrast" | 读写能力： 可读写 相机应用的对比度处理方向。 |
| SATURATION 12+ | "Saturation" | 读写能力： 可读写 相机应用的饱和度处理方向。 |
| SHARPNESS 12+ | "Sharpness" | 读写能力： 可读写 相机应用的锐度处理方向。 |
| DEVICE_SETTING_DESCRIPTION 12+ | "DeviceSettingDescription" | 读写能力： 可读写 特定相机模型的拍照条件信息。 |
| SUBJECT_DISTANCE_RANGE 12+ | "SubjectDistanceRange" | 读写能力： 可读写 表示主体到相机的距离范围。 |
| IMAGE_UNIQUE_ID 12+ | "ImageUniqueID" | 读写能力： 可读写 为每张图片唯一分配的标识符。 |
| CAMERA_OWNER_NAME 12+ | "CameraOwnerName" | 读写能力： 可读写 相机所有者的姓名。 |
| BODY_SERIAL_NUMBER 12+ | "BodySerialNumber" | 读写能力： 可读写 相机机身的序列号。 |
| LENS_SPECIFICATION 12+ | "LensSpecification" | 读写能力： 可读写 使用的镜头规格。 |
| LENS_MAKE 12+ | "LensMake" | 读写能力： 可读写 镜头的制造商。 |
| LENS_MODEL 12+ | "LensModel" | 读写能力： 可读写 镜头的型号名称。 |
| LENS_SERIAL_NUMBER 12+ | "LensSerialNumber" | 读写能力： 可读写 镜头的序列号。 |
| COMPOSITE_IMAGE 12+ | "CompositeImage" | 读写能力： 可读写 表示图像是否为合成图像。 |
| SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE 12+ | "SourceImageNumberOfCompositeImage" | 读写能力： 可读写 用于合成图像的源图像数量。 |
| SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE 12+ | "SourceExposureTimesOfCompositeImage" | 读写能力： 可读写 合成图像的源图像曝光时间。 |
| GAMMA 12+ | "Gamma" | 读写能力： 可读写 表示系数伽马的值。 |
| DNG_VERSION 12+ | "DNGVersion" | 读写能力： 可读写 DNG版本标签编码了符合DNG规范的四级版本号。 |
| DEFAULT_CROP_SIZE 12+ | "DefaultCropSize" | 读写能力： 可读写 DefaultCropSize指定了原始坐标中的最终图像大小，考虑了额外的边缘像素。 |
| GIF_LOOP_COUNT 12+ | "GIFLoopCount" | 读写能力： 只读 GIF图片循环次数。0表示无限循环，其他值表示循环次数。 |
| IS_XMAGE_SUPPORTED 12+ | "HwMnoteIsXmageSupported" | 读写能力： 可读写 是否支持XMAGE。 |
| XMAGE_MODE 12+ | "HwMnoteXmageMode" | 读写能力： 可读写 XMAGE水印模式。 |
| XMAGE_LEFT 12+ | "HwMnoteXmageLeft" | 读写能力： 可读写 水印区域X1坐标。 |
| XMAGE_TOP 12+ | "HwMnoteXmageTop" | 读写能力： 可读写 水印区域Y1坐标。 |
| XMAGE_RIGHT 12+ | "HwMnoteXmageRight" | 读写能力： 可读写 水印区域X2坐标。 |
| XMAGE_BOTTOM 12+ | "HwMnoteXmageBottom" | 读写能力： 可读写 水印区域Y2坐标。 |
| CLOUD_ENHANCEMENT_MODE 12+ | "HwMnoteCloudEnhancementMode" | 读写能力： 可读写 云增强模式。 |
| WIND_SNAPSHOT_MODE 12+ | "HwMnoteWindSnapshotMode" | 读写能力： 只读 运动快拍模式。 |
ImageFormat9+
枚举，图片格式。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| YCBCR_422_SP | 1000 | YCBCR422半平面格式。 |
| JPEG | 2000 | JPEG编码格式。 |
ComponentType9+
枚举，图像的组件类型。
系统能力： SystemCapability.Multimedia.Image.ImageReceiver
| 名称 | 值 | 说明 |
|---|---|---|
| YUV_Y | 1 | 亮度信息。 |
| YUV_U | 2 | 色度信息。 |
| YUV_V | 3 | 色度信息。 |
| JPEG | 4 | JPEG 类型。 |
Component9+
描述图像颜色分量。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| componentType | ComponentType | 是 | 否 | 组件类型。 |
| rowStride | number | 是 | 否 | 行距。 |
| pixelStride | number | 是 | 否 | 像素间距。 |
| byteBuffer | ArrayBuffer | 是 | 否 | 组件缓冲区。 |
DecodingDynamicRange12+
描述解码时期望的图像动态范围。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| AUTO | 0 | 自适应，根据图片信息处理。即如果图片本身为HDR图片，则会按照HDR内容解码；反之按照SDR内容解码。通过CreateIncrementalSource创建的imagesource会解码为SDR内容。 |
| SDR | 1 | 按照标准动态范围处理图片。 |
| HDR | 2 | 按照高动态范围处理图片。通过CreateIncrementalSource创建的imagesource会解码为SDR内容。 |
PackingDynamicRange12+
描述编码时期望的图像动态范围。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| AUTO | 0 | 自适应，根据pixelmap内容处理。即如果pixelmap本身为HDR，则会按照HDR内容进行编码；反之按照SDR内容编码。 |
| SDR | 1 | 按照标准动态范围处理图片。 |
HdrMetadataKey12+
枚举，pixelmap使用的HDR相关元数据信息的关键字。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| HDR_METADATA_TYPE | 0 | pixelmap使用的元数据类型。 |
| HDR_STATIC_METADATA | 1 | 静态元数据。 |
| HDR_DYNAMIC_METADATA | 2 | 动态元数据。 |
| HDR_GAINMAP_METADATA | 3 | Gainmap使用的元数据。 |
HdrMetadataType12+
枚举，HdrMetadataKey中HDR_METADATA_TYPE关键字对应的值。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| NONE | 0 | 无元数据内容。 |
| BASE | 1 | 表示用于基础图的元数据。 |
| GAINMAP | 2 | 表示用于Gainmap图的元数据。 |
| ALTERNATE | 3 | 表示用于合成后HDR图的元数据。 |
HdrStaticMetadata12+
静态元数据值，HdrMetadataKey中HDR_STATIC_METADATA关键字对应的值。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| displayPrimariesX | Array<number> | 否 | 否 | 归一化后显示设备三基色的X坐标，数组的长度为3，以0.00002为单位，范围[0.0, 1.0]。 |
| displayPrimariesY | Array<number> | 否 | 否 | 归一化后显示设备三基色的Y坐标，数组的长度为3，以0.00002为单位，范围[0.0, 1.0]。 |
| whitePointX | number | 否 | 否 | 归一化后白点值的X坐标，以0.00002为单位，范围[0.0, 1.0]。 |
| whitePointY | number | 否 | 否 | 归一化后白点值的Y坐标，以0.00002为单位，范围[0.0, 1.0]。 |
| maxLuminance | number | 否 | 否 | 图像主监视器最大亮度。以1为单位，最大值为65535。 |
| minLuminance | number | 否 | 否 | 图像主监视器最小亮度。以0.0001为单位，最大值6.55535。 |
| maxContentLightLevel | number | 否 | 否 | 显示内容的最大亮度。以1为单位，最大值为65535。 |
| maxFrameAverageLightLevel | number | 否 | 否 | 显示内容的最大平均亮度，以1为单位，最大值为65535。 |
GainmapChannel12+
Gainmap图单个通道的数据内容，参考ISO 21496-1。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| gainmapMax | number | 否 | 否 | 增强图像的最大值，参考ISO 21496-1。 |
| gainmapMin | number | 否 | 否 | 增强图像的最小值，参考ISO 21496-1。 |
| gamma | number | 否 | 否 | gamma值，参考ISO 21496-1。 |
| baseOffset | number | 否 | 否 | 基础图的偏移，参考ISO 21496-1。 |
| alternateOffset | number | 否 | 否 | 提取的可选择图像偏移量，参考ISO 21496-1。 |
HdrGainmapMetadata12+
Gainmap使用的元数据值，HdrMetadataKey中HDR_GAINMAP_METADATA关键字对应的值，参考ISO 21496-1。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| writerVersion | number | 否 | 否 | 元数据编写器使用的版本。 |
| miniVersion | number | 否 | 否 | 元数据解析需要理解的最小版本。 |
| gainmapChannelCount | number | 否 | 否 | Gainmap的颜色通道数，值为3时RGB通道的元数据值不同，值为1时各通道元数据值相同，参考ISO 21496-1。 |
| useBaseColorFlag | boolean | 否 | 否 | 是否使用基础图的色彩空间，参考ISO 21496-1。 |
| baseHeadroom | number | 否 | 否 | 基础图提亮比，参考ISO 21496-1。 |
| alternateHeadroom | number | 否 | 否 | 提取的可选择图像提亮比，参考ISO 21496-1。 |
| channels | Array<GainmapChannel> | 否 | 否 | 各通道的数据，长度为3，参考ISO 21496-1。 |
HdrMetadataValue12+
type HdrMetadataValue = HdrMetadataType | HdrStaticMetadata | ArrayBuffer | HdrGainmapMetadata
PixelMap使用的HDR元数据值类型，和HdrMetadataKey关键字相对应。
系统能力： SystemCapability.Multimedia.Image.Core
| 类型 | 说明 |
|---|---|
| HdrMetadataType | HdrMetadataKey中HDR_GAINMAP_METADATA关键字对应的元数据值类型。 |
| HdrStaticMetadata | HdrMetadataKey中HDR_STATIC_METADATA关键字对应的元数据值类型。 |
| ArrayBuffer | HdrMetadataKey中HDR_DYNAMIC_METADATA关键字对应的元数据值类型。 |
| HdrGainmapMetadata | HdrMetadataKey中HDR_GAINMAP_METADATA关键字对应的元数据值类型。 |
AntiAliasingLevel12+
缩放时的缩放算法。
系统能力： SystemCapability.Multimedia.Image.Core
| 名称 | 值 | 说明 |
|---|---|---|
| NONE | 0 | 最近邻插值算法。 |
| LOW | 1 | 双线性插值算法。 |
| MEDIUM | 2 | 双线性插值算法，同时开启Mipmap。缩小图片时建议使用。 |
| HIGH | 3 | 三次插值算法。 |
补充说明
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
在 API参考 中进行搜索
请输入您想要搜索的关键词