图片处理

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

API Version 9当前为Canary版本，仅供试用，不保证接口可稳定调用。

导入模块

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

image.createPixelMap⁸⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

image.createPixelMap(Color, opts)
            .then((pixelmap) => {
            })

image.createPixelMap⁸⁺

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

通过属性创建PixelMap，通过回调函数返回结果。

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

image.createPixelMap(Color, opts, (pixelmap) => {
            })

PixelMap⁷⁺

图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。

属性

readPixelsToBuffer⁷⁺

readPixelsToBuffer(dst: ArrayBuffer): Promise<void>

读取图像像素数据，结果写入ArrayBuffer里，使用Promise形式返回。

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

pixelmap.readPixelsToBuffer(readBuffer).then(() => {
                        //符合条件则进入 
                }).catch(error => {
                //不符合条件则进入
            })

readPixelsToBuffer⁷⁺

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

读取图像像素数据，结果写入ArrayBuffer里，使用callback形式返回。

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

pixelmap.readPixelsToBuffer(readBuffer, () => {
            })

readPixels⁷⁺

readPixels(area: PositionArea): Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

pixelmap.readPixels(area).then((data) => {
                  //符合条件则进入      
                }).catch(error => {
                //不符合条件则进入
            })

readPixels⁷⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err, pixelmap) => {
     if(pixelmap == undefined){
          console.info('createPixelMap failed');
          expect(false).assertTrue();
          done();
      }else{
          const area = { pixels: new ArrayBuffer(8),
                    offset: 0,
                    stride: 8,
                    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }}
           pixelmap.readPixels(area, () => {
               console.info('readPixels success');
           })
      }
})

writePixels⁷⁺

writePixels(area: PositionArea): Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts)
    .then( pixelmap => {
        if (pixelmap == undefined) {
            console.info('createPixelMap failed');
            expect(false).assertTrue()
            done();
        }
        const area = { pixels: new ArrayBuffer(8),
            offset: 0,
            stride: 8,
            region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
        }
        var bufferArr = new Uint8Array(area.pixels);
        for (var i = 0; i < bufferArr.length; i++) {
            bufferArr[i] = i + 1;
        }

        pixelmap.writePixels(area).then(() => {
            const readArea = { pixels: new ArrayBuffer(8),
                offset: 0,
                stride: 8,
                // region.size.width + x < opts.width, region.size.height + y < opts.height
                region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
            }        
        })
    })
    .catch(error => {
        console.log('error: ' + error);
        expect().assertFail();
        done();
    })

writePixels⁷⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

pixelmap.writePixels(area, () => {
                const readArea = {
                    pixels: new ArrayBuffer(20),
                    offset: 0,
                    stride: 8,
                    region: { size: { height: 1, width: 2 }, x: 0, y: 0 },
                }
            })

writeBufferToPixels⁷⁺

writeBufferToPixels(src: ArrayBuffer): Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

pixelMap.writeBufferToPixels(colorBuffer).then(() => {
    console.log("Succeeded in writing data from a buffer to a PixelMap.");
}).catch((err) => {
    console.error("Failed to write data from a buffer to a PixelMap.");
});

writeBufferToPixels⁷⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

pixelMap.writeBufferToPixels(colorBuffer, function(err) {
    if (err) {
        console.error("Failed to write data from a buffer to a PixelMap.");
        return;
    }
    console.log("Succeeded in writing data from a buffer to a PixelMap.");
});

getImageInfo⁷⁺

getImageInfo(): Promise<ImageInfo>

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

pixelMap.getImageInfo().then(function(info) {
    console.log("Succeeded in obtaining the image pixel map information.");
}).catch((err) => {
    console.error("Failed to obtain the image pixel map information.");
});

getImageInfo⁷⁺

getImageInfo(callback: AsyncCallback<ImageInfo>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例:

pixelmap.getImageInfo((imageInfo) => {})

getBytesNumberPerRow⁷⁺

getBytesNumberPerRow(): number

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

rowCount = pixelmap.getBytesNumberPerRow()

getPixelBytesNumber⁷⁺

getPixelBytesNumber(): number

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

pixelBytesNumber = pixelmap.getPixelBytesNumber()

release⁷⁺

release():Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

 pixelmap.release().then(() => { })
            .catch(error => {})

release⁷⁺

release(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

pixelmap.release(()=>{ })   

image.createImageSource

createImageSource(uri: string): ImageSource

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

let path = this.context.getApplicationContext().fileDirs + "test.jpg";
const imageSourceApi = image.createImageSource(path);

image.createImageSource⁷⁺

createImageSource(fd: number): ImageSource

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

const imageSourceApi = image.createImageSource(0)

ImageSource

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

属性

getImageInfo

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.getImageInfo(0,(error, imageInfo) => {})

getImageInfo

getImageInfo(callback: AsyncCallback<ImageInfo>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.getImageInfo(imageInfo => {})

getImageInfo

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

imageSourceApi.getImageInfo(0)
            .then(imageInfo => {})
			.catch(error => {})

getImageProperty⁷⁺

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

获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果。

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

imageSourceApi.getImageProperty("BitsPerSample")
            .then(data => {})
            .catch(error => {})

getImageProperty⁷⁺

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

获取图片中给定索引处图像的指定属性键的值，用callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.getImageProperty("BitsPerSample",(error,data) => {})

getImageProperty⁷⁺

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

获取图片指定属性键的值，callback形式返回结果。

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => {})

createPixelMap⁷⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

imageSourceApi.createPixelMap().then(pixelmap => {})
    						.catch(error => {})

createPixelMap⁷⁺

createPixelMap(callback: AsyncCallback<PixelMap>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.createPixelMap(pixelmap => {})

createPixelMap⁷⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.createPixelMap(decodingOptions, pixelmap => {})    

release

release(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imageSourceApi.release(() => {})

release

release(): Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

imageSourceApi.release().then(()=>{ }).catch(error => {})

image.createImagePacker

createImagePacker(): ImagePacker

创建ImagePacker实例。

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

const imagePackerApi = image.createImagePacker();

ImagePacker

图片打包器类，用于图片压缩和打包。在调用ImagePacker的方法前，需要先通过createImagePacker构建一个ImagePacker实例。

属性

packing

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

let packOpts = { format:["image/jpeg"], quality:98 }
imagePackerApi.packing(imageSourceApi, packOpts, data => {})

packing

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

let packOpts = { format:["image/jpeg"], quality:98 }
imagePackerApi.packing(imageSourceApi, packOpts)
    .then( data => { })
	.catch(error => {})

packing⁸⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

let packOpts = { format:["image/jpeg"], quality:98 }
imagePackerApi.packing(pixelMapApi, packOpts, data => {})

packing⁸⁺

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

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

系统能力： SystemCapability.Multimedia.Image

参数：

返回值：

示例：

let packOpts = { format:["image/jpeg"], quality:98 }
imagePackerApi.packing(pixelMapApi, packOpts)
    .then( data => { })
	.catch(error => {})

release

release(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.Multimedia.Image

参数：

示例：

imagePackerApi.release(()=>{})

release

release(): Promise<void>

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

系统能力： SystemCapability.Multimedia.Image

返回值：

示例：

 imagePackerApi.release().then(()=>{
            }).catch((error)=>{}) 

PositionArea⁷⁺

表示图片指定区域内的数据。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

ImageInfo

表示图片信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

Size

表示图片尺寸。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

PixelMapFormat⁷⁺

枚举，像素格式。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

AlphaType⁹⁺

枚举，透明度。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

ScaleMode⁹⁺

枚举，缩略值。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

InitializationOptions⁸⁺

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

DecodingOptions⁷⁺

解码设置选项。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

Region⁷⁺

表示区域信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

PackingOption

表示图片打包选项。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

GetImagePropertyOptions⁷⁺

表示查询图片属性的索引。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image

PropertyKey⁷⁺

枚举，Exif（Exchangeable image file format）图片信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Image