导入模块

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

image.createPixelMap8+

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

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

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

参数：

返回值：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelmap) => {
    console.log('Succeeded in creating pixelmap.');
}).catch(error => {
    console.log('Failed to create pixelmap.');
})

image.createPixelMap8+

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

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

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

参数：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (error, pixelmap) => {
    if(error) {
        console.log('Failed to create pixelmap.');
    } else {
        console.log('Succeeded in creating pixelmap.');
    }
})

PixelMap7+

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

属性

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

readPixelsToBuffer7+

readPixelsToBuffer(dst: ArrayBuffer): Promise<void>

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

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

参数：

返回值：

示例：

const readBuffer = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
pixelmap.readPixelsToBuffer(readBuffer).then(() => {
    console.log('Succeeded in reading image pixel data.');  //符合条件则进入 
}).catch(error => {
    console.log('Failed to read image pixel data.');  //不符合条件则进入
})

readPixelsToBuffer7+

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

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

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

参数：

示例：

const readBuffer = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
pixelmap.readPixelsToBuffer(readBuffer, (err, res) => {
    if(err) {
        console.log('Failed to read image pixel data.');  //不符合条件则进入
    } else {
        console.log('Succeeded in reading image pixel data.');  //符合条件则进入
    }
})

readPixels7+

readPixels(area: PositionArea): Promise<void>

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

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

参数：

返回值：

示例：

const area = {
    pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
}
pixelmap.readPixels(area).then(() => {
    console.log('Succeeded in reading the image data in the area.'); //符合条件则进入
}).catch(error => {
    console.log('Failed to read the image data in the area.'); //不符合条件则进入
})

readPixels7+

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

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

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

参数：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err, pixelmap) => {
    if(pixelmap == undefined){
        console.info('createPixelMap failed.');
    } else {
        const area = { pixels: new ArrayBuffer(8),
            offset: 0,
            stride: 8,
            region: { size: { height: 1, width: 2 }, x: 0, y: 0 }};
        pixelmap.readPixels(area, () => {
            console.info('readPixels success');
        })
    }
})

writePixels7+

writePixels(area: PositionArea): Promise<void>

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

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

参数：

返回值：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts)
    .then( pixelmap => {
        if (pixelmap == undefined) {
            console.info('createPixelMap failed.');
        }
        const area = { pixels: new ArrayBuffer(8),
            offset: 0,
            stride: 8,
            region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
        }
        let bufferArr = new Uint8Array(area.pixels);
        for (var i = 0; i < bufferArr.length; i++) {
            bufferArr[i] = i + 1;
        }

        pixelmap.writePixels(area).then(() => {
            console.info('Succeeded to write pixelmap into the specified area.');
        })
    }).catch(error => {
        console.log('error: ' + error);
    })

writePixels7+

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

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

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

参数：

示例：

const area = { pixels: new ArrayBuffer(8),
    offset: 0,
    stride: 8,
    region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
}
let bufferArr = new Uint8Array(area.pixels);
for (var i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
}
pixelmap.writePixels(area, (error) => {
    if (error != undefined) {
        console.info('Failed to write pixelmap into the specified area.');
    } else {
        console.info('Succeeded to write pixelmap into the specified area.');
    }
})

writeBufferToPixels7+

writeBufferToPixels(src: ArrayBuffer): Promise<void>

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

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

参数：

返回值：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
for (var i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
}
pixelmap.writeBufferToPixels(color).then(() => {
    console.log("Succeeded in writing data from a buffer to a PixelMap.");
}).catch((err) => {
    console.error("Failed to write data from a buffer to a PixelMap.");
})

writeBufferToPixels7+

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

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

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

参数：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
for (var i = 0; i < bufferArr.length; i++) {
    bufferArr[i] = i + 1;
}
pixelmap.writeBufferToPixels(color, function(err) {
    if (err) {
        console.error("Failed to write data from a buffer to a PixelMap.");
        return;
    } else {
        console.log("Succeeded in writing data from a buffer to a PixelMap.");
    }
});

getImageInfo7+

getImageInfo(): Promise<ImageInfo>

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

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

返回值：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let opts = { editable: true, pixelFormat: 2, size: { height: 6, width: 8 } }
image.createPixelMap(color, opts).then(pixelmap => {
    if (pixelmap == undefined) {
        console.error("Failed to obtain the image pixel map information.");
    }
    pixelmap.getImageInfo().then(imageInfo => {
        if (imageInfo == undefined) {
            console.error("Failed to obtain the image pixel map information.");
        }
        if (imageInfo.size.height == 4 && imageInfo.size.width == 6) {
            console.log("Succeeded in obtaining the image pixel map information.");
        }
    })
})

getImageInfo7+

getImageInfo(callback: AsyncCallback<ImageInfo>): void

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

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

参数：

示例:

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err, pixelmap) => {
    if (pixelmap == undefined) {
        console.error("Failed to obtain the image pixel map information.");
    }
    pixelmap.getImageInfo((err, imageInfo) => {
        if (imageInfo == undefined) {
            console.error("Failed to obtain the image pixel map information.");
        }
        if (imageInfo.size.height == 4 && imageInfo.size.width == 6) {
            console.log("Succeeded in obtaining the image pixel map information.");
        }
    })
})

getBytesNumberPerRow7+

getBytesNumberPerRow(): number

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

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

返回值：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err,pixelmap) => {
    let rowCount = pixelmap.getBytesNumberPerRow();
})

getPixelBytesNumber7+

getPixelBytesNumber(): number

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

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

返回值：

示例：

let pixelBytesNumber = pixelmap.getPixelBytesNumber();

getDensity9+

getDensity():number

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

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

返回值：

示例：

let getDensity = pixelmap.getDensity();

opacity9+

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

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

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

参数：

示例：

var rate = 0.5;
pixelmap.opacity(rate, (err) => {
    if (err) {
        console.error("Failed to set opacity.");
        return;
    } else {
        console.log("Succeeded in setting opacity.");
    }
})

opacity9+

opacity(rate: number): Promise<void>

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.opacity(0.5);
}

createAlphaPixelmap9+

createAlphaPixelmap(): Promise<PixelMap>

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

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

返回值：

示例：

async function Demo() {
    await pixelmap.createAlphaPixelmap();
}   

createAlphaPixelmap9+

createAlphaPixelmap(callback: AsyncCallback<PixelMap>): void

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

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

参数：

示例：

pixelmap.createAlphaPixelmap((err, alphaPixelMap) => {
    if (alphaPixelMap == undefined) {
        console.info('Failed to obtain new pixel map.');
    } else {
        console.info('Succeed in obtaining new pixel map.');
    }
})

scale9+

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

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

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

参数：

示例：

async function Demo() {
    await pixelmap.scale(2.0, 1.0);
}

scale9+

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

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.scale(2.0, 1.0);
}

translate9+

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

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

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

参数：

示例：

async function Demo() {
    await pixelmap.translate(3.0, 1.0);
}

translate9+

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

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.translate(3.0, 1.0);
}

rotate9+

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

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

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

参数：

示例：

var angle = 90.0;
pixelmap.rotate(angle, (err) => {
    if (err) {
        console.error("Failed to set rotation.");
        return;
    } else {
        console.log("Succeeded in setting rotation.");
    }
})

rotate9+

rotate(angle: number): Promise<void>

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.rotate(90.0);
}

flip9+

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

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

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

参数：

示例：

async function Demo() {
    await pixelmap.flip(false, true);
}

flip9+

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

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.flip(false, true);
}

crop9+

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

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

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

参数：

示例：

async function Demo() {
    await pixelmap.crop({ x: 0, y: 0, size: { height: 100, width: 100 } });
}

crop9+

crop(region: Region): Promise<void>

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

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

参数：

返回值：

示例：

async function Demo() {
    await pixelmap.crop({ x: 0, y: 0, size: { height: 100, width: 100 } });
}

release7+

release():Promise<void>

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

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

返回值：

示例：

pixelmap.release().then(() => {
    console.log('Succeeded in releasing pixelmap object.');
}).catch(error => {
    console.log('Failed to release pixelmap object.');
})

release7+

release(callback: AsyncCallback<void>): void

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

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

参数：

示例：

pixelmap.release(() => {
    console.log('Succeeded in releasing pixelmap object.');
})

image.createImageSource

createImageSource(uri: string): ImageSource

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

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

参数：

返回值：

示例：

//Stage模型
const context = getContext(this);
const path = context.cacheDir + "/test.jpg";
const imageSourceApi = image.createImageSource(path);

//FA模型
import featureAbility from '@ohos.ability.featureAbility';

const context = featureAbility.getContext();
const path = context.getCacheDir() + "/test.jpg";
const imageSourceApi = image.createImageSource(path);

image.createImageSource9+

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

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

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

参数：

返回值：

示例：

var sourceOptions = { sourceDensity: 120 };
let imageSource = image.createImageSource('test.png', sourceOptions);

image.createImageSource7+

createImageSource(fd: number): ImageSource

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

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

参数：

返回值：

示例：

const imageSourceApi = image.createImageSource(0);

image.createImageSource9+

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

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

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

参数：

返回值：

示例：

var sourceOptions = { sourceDensity: 120 };
const imageSourceApi = image.createImageSource(0, sourceOptions);

image.createImageSource9+

createImageSource(buf: ArrayBuffer): ImageSource

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

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

参数：

示例：

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

image.createImageSource9+

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

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

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

参数：

返回值：

示例：

const data = new ArrayBuffer(112);
const imageSourceApi = image.createImageSource(data);

image.CreateIncrementalSource9+

CreateIncrementalSource(buf: ArrayBuffer): ImageSource

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

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

参数：

返回值：

示例：

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

image.CreateIncrementalSource9+

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

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

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

参数：

返回值：

示例：

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

ImageSource

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

属性

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

getImageInfo

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

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

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

参数：

示例：

imageSourceApi.getImageInfo(0,(error, imageInfo) => { 
    if(error) {
        console.log('getImageInfo failed.');
    } else {
        console.log('getImageInfo succeeded.');
    }
})

getImageInfo

getImageInfo(callback: AsyncCallback<ImageInfo>): void

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

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

参数：

示例：

imageSourceApi.getImageInfo(imageInfo => { 
    console.log('Succeeded in obtaining the image information.');
})

getImageInfo

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

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

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

参数：

返回值：

示例：

imageSourceApi.getImageInfo(0)
    .then(imageInfo => {
        console.log('Succeeded in obtaining the image information.');
    }).catch(error => {
        console.log('Failed to obtain the image information.');
    })

getImageProperty7+

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

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

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

参数：

返回值：

示例：

imageSourceApi.getImageProperty("BitsPerSample")
    .then(data => {
        console.log('Succeeded in getting the value of the specified attribute key of the image.');
    })

getImageProperty7+

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

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

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

参数：

示例：

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

getImageProperty7+

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

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

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

参数：

示例：

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

modifyImageProperty9+

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

通过指定的键修改图片属性的值，使用Promise形式返回结果。

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

参数：

返回值：

示例：

imageSourceApi.modifyImageProperty("ImageWidth", "120").then(() => {
    const w = imageSourceApi.getImageProperty("ImageWidth")
    console.info('w', w);
})

modifyImageProperty9+

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

通过指定的键修改图片属性的值，callback形式返回结果。

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

参数：

示例：

imageSourceApi.modifyImageProperty("ImageWidth", "120",() => {})

updateData9+

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

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

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

参数：

返回值：

示例：

const array = new ArrayBuffer(100);
imageSourceApi.updateData(array, false, 0, 10).then(data => {
    console.info('Succeeded in updating data.');
})

updateData9+

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

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

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

参数：

示例：

const array = new ArrayBuffer(100);
imageSourceApi.updateData(array, false, 0, 10,(error,data )=> {
    if(data !== undefined){
        console.info('Succeeded in updating data.');     
    }
})

createPixelMap7+

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

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

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

参数：

返回值：

示例：

imageSourceApi.createPixelMap().then(pixelmap => {
    console.log('Succeeded in creating pixelmap object through image decoding parameters.');
}).catch(error => {
    console.log('Failed to create pixelmap object through image decoding parameters.');
})

createPixelMap7+

createPixelMap(callback: AsyncCallback<PixelMap>): void

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

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

参数：

示例：

imageSourceApi.createPixelMap((err, pixelmap) => {
                    console.info('Succeeded in creating pixelmap object.');
                })

createPixelMap7+

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

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

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

参数：

示例：

let decodingOptions = {
    sampleSize: 1,
    editable: true,
    desiredSize: { width: 1, height: 2 },
    rotate: 10,
    desiredPixelFormat: 3,
    desiredRegion: { size: { height: 1, width: 2 }, x: 0, y: 0 },
    index: 0
};
imageSourceApi.createPixelMap(decodingOptions, pixelmap => { 
    console.log('Succeeded in creating pixelmap object.');
})

release

release(callback: AsyncCallback<void>): void

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

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

参数：

示例：

imageSourceApi.release(() => { 
    console.log('release succeeded.');
})

release

release(): Promise<void>

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

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

返回值：

示例：

imageSourceApi.release().then(()=>{
    console.log('Succeeded in releasing the image source instance.');
}).catch(error => {
    console.log('Failed to release the image source instance.');
})

image.createImagePacker

createImagePacker(): ImagePacker

创建ImagePacker实例。

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

返回值：

示例：

const imagePackerApi = image.createImagePacker();

ImagePacker

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

属性

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

packing

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

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

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

参数：

示例：

const imageSourceApi = image.createImageSource(0);
let packOpts = { format:"image/jpeg", quality:98 };
imagePackerApi.packing(imageSourceApi, packOpts, data => {})

packing

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

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

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

参数：

返回值：

示例：

const imageSourceApi = image.createImageSource(0);
let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(imageSourceApi, packOpts)
    .then( data => {
        console.log('packing succeeded.');
    }).catch(error => {
        console.log('packing failed.');
    })

packing8+

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

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

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

参数：

示例：

const color = new ArrayBuffer(96);  //96为需要创建的像素buffer大小，取值为：height * width *4
let bufferArr = new Uint8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelmap) => {
    let packOpts = { format:"image/jpeg", quality:98 }
    imagePackerApi.packing(pixelmap, packOpts, data => { 
        console.log('Succeeded in packing the image.');
    })
})

packing8+

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

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

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

参数：

返回值：

示例：

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

release

release(callback: AsyncCallback<void>): void

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

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

参数：

示例：

imagePackerApi.release(()=>{ 
    console.log('Succeeded in releasing image packaging.');
})

release

release(): Promise<void>

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

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

返回值：

示例：

imagePackerApi.release().then(()=>{
    console.log('Succeeded in releasing image packaging.');
}).catch((error)=>{ 
    console.log('Failed to release image packaging.'); 
}) 

image.createImageReceiver9+

createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver

通过宽、高、图片格式、容量创建ImageReceiver实例。

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

参数：

返回值：

示例：

var receiver = image.createImageReceiver(8192, 8, 2000, 8);

ImageReceiver9+

图像接收类，用于获取组件surface id，接收最新的图片和读取下一张图片，以及释放ImageReceiver实例。

在调用以下方法前需要先创建ImageReceiver实例。

属性

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

getReceivingSurfaceId9+

getReceivingSurfaceId(callback: AsyncCallback<string>): void

用于获取一个surface id供Camera或其他组件使用。使用callback返回结果。

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

参数：

示例:

receiver.getReceivingSurfaceId((err, id) => { 
    if(err) {
        console.log('getReceivingSurfaceId failed.');
    } else {
        console.log('getReceivingSurfaceId succeeded.');
    }
});

getReceivingSurfaceId9+

getReceivingSurfaceId(): Promise<string>

用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。

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

返回值：

示例：

receiver.getReceivingSurfaceId().then( id => { 
    console.log('getReceivingSurfaceId succeeded.');
}).catch(error => {
    console.log('getReceivingSurfaceId failed.');
})

readLatestImage9+

readLatestImage(callback: AsyncCallback<Image>): void

从ImageReceiver读取最新的图片，并使用callback返回结果。

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

参数：

示例：

receiver.readLatestImage((err, img) => { 
    if(err) {
        console.log('readLatestImage failed.');
    } else {
        console.log('readLatestImage succeeded.');
    }
});

readLatestImage9+

readLatestImage(): Promise<Image>

从ImageReceiver读取最新的图片，并使用promise返回结果。

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

返回值：

示例：

receiver.readLatestImage().then(img => {
    console.log('readLatestImage succeeded.');
}).catch(error => {
    console.log('readLatestImage failed.');
})

readNextImage9+

readNextImage(callback: AsyncCallback<Image>): void

从ImageReceiver读取下一张图片，并使用callback返回结果。

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

参数：

示例：

receiver.readNextImage((err, img) => { 
    if(err) {
        console.log('readNextImage failed.');
    } else {
        console.log('readNextImage succeeded.');
    }
});

readNextImage9+

readNextImage(): Promise<Image>

从ImageReceiver读取下一张图片，并使用promise返回结果。

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

返回值：

示例：

receiver.readNextImage().then(img => {
    console.log('readNextImage succeeded.');
}).catch(error => {
    console.log('readNextImage failed.');
})

on9+

on(type: 'imageArrival', callback: AsyncCallback<void>): void

接收图片时注册回调。

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

参数：

示例：

receiver.on('imageArrival', () => {})

release9+

release(callback: AsyncCallback<void>): void

释放ImageReceiver实例并使用回调返回结果。

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

参数：

示例：

receiver.release(() => {})

release9+

release(): Promise<void>

释放ImageReceiver实例并使用promise返回结果。

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

返回值：

示例：

receiver.release().then(() => {
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})

image.createImageCreator9+

createImageCreator(width: number, height: number, format: number, capacity: number): ImageCreator

通过宽、高、图片格式、容量创建ImageCreator实例。

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

参数：

返回值：

示例：

var creator = image.createImageCreator(8192, 8, 4, 8);

ImageCreator9+

图像创建模块，用于请求图像原生数据区域，并开放给应用编译原生图像数据的能力。

在调用以下方法前需要先创建ImageCreator实例。

属性

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

dequeueImage9+

dequeueImage(callback: AsyncCallback<Image>): void

从空闲队列中获取buffer图片，用于绘制UI内容，并使用callback返回结果。

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

参数：

示例：

creator.dequeueImage((err, img) => {
    if (err) {
        console.info('dequeueImage failded.');
    }
    console.info('dequeueImage succeeded.');
});

dequeueImage9+

dequeueImage(): Promise<Image>

从空闲队列中获取buffer图片，用于绘制UI内容，并使用promise返回结果。

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

返回值：

示例：

creator.dequeueImage().then(img => {
    console.info('dequeueImage succeeded.');
}).catch(error => {
    console.log('dequeueImage failed: ' + error);
})

queueImage9+

queueImage(interface: Image, callback: AsyncCallback<void>): void

将绘制好的图片放入Dirty队列，并使用callback返回结果。

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

参数：

示例：

creator.dequeueImage().then(img => {
    //绘制图片
    img.getComponent(4).then(component => {
        var bufferArr = new Uint8Array(component.byteBuffer);
        for (var 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) => {
        if (err) {
            console.info('queueImage failed: ' + err);
        }
        console.info('queueImage succeeded');
    })
})

queueImage9+

queueImage(interface: Image): Promise<void>

将绘制好的图片放入Dirty队列，并使用promise返回结果。

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

参数：

返回值：

示例：

creator.dequeueImage().then(img => {
    //绘制图片
    img.getComponent(4).then(component => {
        var bufferArr = new Uint8Array(component.byteBuffer);
        for (var 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('queueImage succeeded.');
    }).catch(error => {
        console.info('queueImage failed: ' + error);
    })
})

on9+

on(type: 'imageRelease', callback: AsyncCallback<void>): void

监听imageRelease事件，并使用callback返回结果。

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

参数：

示例：

creator.on('imageRelease', (err) => {
    if (err) {
        console.info('on faild' + err);
    }
    console.info('on succeeded');
})

release9+

release(callback: AsyncCallback<void>): void

释放当前图像，并使用callback返回结果。

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

参数：

示例：

creator.release((err) => {
    if (err) {
        console.info('release failed: ' + err);
    }
    console.info('release succeeded');
});

release9+

release(): Promise<void>

释放当前图像，并使用promise返回结果。

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

返回值：

示例：

creator.release().then(() => {
    console.info('release succeeded');
}).catch(error => {
    console.info('release failed');
})

Image9+

提供基本的图像操作，包括获取图像信息、读写图像数据。调用readNextImage和readLatestImage接口时会返回image。

属性

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

getComponent9+

getComponent(componentType: ComponentType, callback: AsyncCallback<Component>): void

根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。

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

参数：

示例：

img.getComponent(4, (err, component) => {
    if(err) {
        console.log('getComponent failed.');
    } else {
        console.log('getComponent succeeded.');
    }
})

getComponent9+

getComponent(componentType: ComponentType): Promise<Component>

根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。

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

参数：

返回值：

示例：

img.getComponent(4).then(component => { })

release9+

release(callback: AsyncCallback<void>): void

释放当前图像并使用callback返回结果。

在接收另一个图像前必须先释放对应资源。

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

参数：

示例：

img.release(() =>{ 
    console.log('release succeeded.');
}) 

release9+

release(): Promise<void>

释放当前图像并使用Promise方式返回结果。

在接收另一个图像前必须先释放对应资源。

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

返回值：

示例：

img.release().then(() =>{
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})

PositionArea7+

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

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

ImageInfo

表示图片信息。

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

Size

表示图片尺寸。

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

PixelMapFormat7+

枚举，图片像素格式。

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

AlphaType9+

枚举，图像的透明度类型。

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

ScaleMode9+

枚举，图像的缩放模式。

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

SourceOptions9+

ImageSource的初始化选项。

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

InitializationOptions8+

PixelMap的初始化选项。

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

DecodingOptions7+

图像解码设置选项。

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

Region7+

表示区域信息。

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

PackingOption

表示图片打包选项。

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

GetImagePropertyOptions7+

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

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

PropertyKey7+

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

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

ImageFormat9+

枚举，图片格式。

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

ComponentType9+

枚举，图像的组件类型。

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

Component9+

描述图像颜色分量。

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

ResponseCode

编译错误返回的响应码。