电子说
说明: 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 :[
gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
import image from '@ohos.multimedia.image';
createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise
通过属性创建PixelMap,通过Promise返回结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
colors | ArrayBuffer | 是 | BGRA_8888格式的颜色数组。 |
options | [InitializationOptions] | 是 | 创建像素的属性,包括透明度,尺寸,缩略值,像素格式和是否可编辑。 |
返回值:
类型 | 说明 |
---|---|
Promise<[PixelMap]> | 返回Pixelmap。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts)
.then((pixelmap) = > {
})
createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback): void
通过属性创建PixelMap,通过回调函数返回结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
colors | ArrayBuffer | 是 | BGRA_8888格式的颜色数组。 |
options | [InitializationOptions] | 是 | 属性。 |
callback | AsyncCallback<[PixelMap]> | 是 | 通过回调返回PixelMap对象。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) = > {
})
图像像素类,用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前,需要先通过createPixelMap创建一个PixelMap实例。
系统能力: SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
isEditable7+ | boolean | 是 | 否 | 设定是否图像像素可被编辑。 |
readPixelsToBuffer(dst: ArrayBuffer): Promise
读取图像像素数据,结果写入ArrayBuffer里,使用Promise形式返回。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dst | ArrayBuffer | 是 | 缓冲区,函数执行结束后获取的图像像素数据写入到该内存区域内。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于获取结果,失败时返回错误信息。 |
示例:
const readBuffer = new ArrayBuffer(400);
pixelmap.readPixelsToBuffer(readBuffer).then(() = > {
console.log('Succeeded in reading image pixel data.'); //符合条件则进入
}).catch(error = > {
console.log('Failed to read image pixel data.'); //不符合条件则进入
})
readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback): void
读取图像像素数据,结果写入ArrayBuffer里,使用callback形式返回。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
dst | ArrayBuffer | 是 | 缓冲区,函数执行结束后获取的图像像素数据写入到该内存区域内。 |
callback | AsyncCallback | 是 | 获取回调,失败时返回错误信息。 |
示例:
const readBuffer = new ArrayBuffer(400);
pixelmap.readPixelsToBuffer(readBuffer, (err, res) = > {
if(err) {
console.log('Failed to read image pixel data.'); //不符合条件则进入
} else {
console.log('Succeeded in reading image pixel data.'); //符合条件则进入
}
})
readPixels(area: PositionArea): Promise
读取区域内的图片数据,使用Promise形式返回读取结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
area | [PositionArea] | 是 | 区域大小,根据区域读取。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于获取读取结果,失败时返回错误信息。 |
示例:
const area = new ArrayBuffer(400);
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.'); //不符合条件则进入
})
readPixels(area: PositionArea, callback: AsyncCallback): void
读取区域内的图片数据,使用callback形式返回读取结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
area | [PositionArea] | 是 | 区域大小,根据区域读取。 |
callback | AsyncCallback | 是 | 获取回调,失败时返回错误信息。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(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');
})
}
})
writePixels(area: PositionArea): Promise
将PixelMap写入指定区域内,使用Promise形式返回写入结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
area | [PositionArea] | 是 | 区域,根据区域写入。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于获取写入结果,失败时返回错误信息。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(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(() = > {
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);
})
writePixels(area: PositionArea, callback: AsyncCallback): void
将PixelMap写入指定区域内,使用callback形式返回写入结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
area | [PositionArea] | 是 | 区域,根据区域写入。 |
callback: | AsyncCallback | 是 | 获取回调,失败时返回错误信息。 |
示例:
const area = new ArrayBuffer(400);
pixelmap.writePixels(area, (error) = > {
if (error!=undefined) {
console.info('Failed to write pixelmap into the specified area.');
} else {
const readArea = {
pixels: new ArrayBuffer(20),
offset: 0,
stride: 8,
region: { size: { height: 1, width: 2 }, x: 0, y: 0 },
}
}
})
writeBufferToPixels(src: ArrayBuffer): Promise
读取缓冲区中的图片数据,结果写入PixelMap中,使用Promise形式返回。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
src | ArrayBuffer | 是 | 图像像素数据。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于获取结果,失败时返回错误信息。 |
示例:
const color = new ArrayBuffer(96);
const pixelMap = new ArrayBuffer(400);
let bufferArr = new Unit8Array(color);
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.");
})
writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback): void
读取缓冲区中的图片数据,结果写入PixelMap中,使用callback形式返回。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
src | ArrayBuffer | 是 | 图像像素数据。 |
callback | AsyncCallback | 是 | 获取回调,失败时返回错误信息。 |
示例:
const color = new ArrayBuffer(96);
const pixelMap = new ArrayBuffer(400);
let bufferArr = new Unit8Array(color);
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.");
}
});
getImageInfo(): Promise
获取图像像素信息,使用Promise形式返回获取的图像像素信息。
系统能力: SystemCapability.Multimedia.Image.Core
返回值:
类型 | 说明 |
---|---|
Promise<[ImageInfo]> | Promise实例,用于异步获取图像像素信息,失败时返回错误信息。 |
示例:
const pixelMap = new ArrayBuffer(400);
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(callback: AsyncCallback): void
获取图像像素信息,使用callback形式返回获取的图像像素信息。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[ImageInfo]> | 是 | 获取图像像素信息回调,异步返回图像像素信息,失败时返回错误信息。 |
示例:
pixelmap.getImageInfo((imageInfo) = > {
console.log("Succeeded in obtaining the image pixel map information..");
})
getBytesNumberPerRow(): number
获取图像像素每行字节数。
系统能力: SystemCapability.Multimedia.Image.Core
返回值:
类型 | 说明 |
---|---|
number | 图像像素的行字节数。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err,pixelmap) = > {
let rowCount = pixelmap.getBytesNumberPerRow();
})
getPixelBytesNumber(): number
获取图像像素的总字节数。
系统能力: SystemCapability.Multimedia.Image.Core
返回值:
类型 | 说明 |
---|---|
number | 图像像素的总字节数。 |
示例:
let pixelBytesNumber = pixelmap.getPixelBytesNumber();
release():Promise
释放PixelMap对象,使用Promise形式返回释放结果。
系统能力: SystemCapability.Multimedia.Image.Core
返回值:
类型 | 说明 |
---|---|
Promise | 异步返回释放结果。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) = > {
pixelmap.release().then(() = > {
console.log('Succeeded in releasing pixelmap object.');
}).catch(error = > {
console.log('Failed to release pixelmap object.');
})
})
release(callback: AsyncCallback): void
释放PixelMap对象,使用callback形式返回释放结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 异步返回释放结果。 |
示例:
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) = > {
pixelmap.release().then(() = > {
console.log('Succeeded in releasing pixelmap object.');
}).catch(error = > {
console.log('Failed to release pixelmap object.');
})
})
createImageSource(uri: string): ImageSource
通过传入的uri创建图片源实例。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
uri | string | 是 | 图片路径,当前仅支持应用沙箱路径。 |
返回值:
类型 | 说明 |
---|---|
[ImageSource] | 返回ImageSource类实例,失败时返回undefined。 |
示例:
let path = this.context.getApplicationContext().fileDirs + "test.jpg";
const imageSourceApi = image.createImageSource(path);
createImageSource(fd: number): ImageSource
通过传入文件描述符来创建图片源实例。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
fd | number | 是 | 文件描述符fd。 |
返回值:
类型 | 说明 |
---|---|
[ImageSource] | 返回ImageSource类实例,失败时返回undefined。 |
示例:
const imageSourceApi = image.createImageSource(0)
createImageSource(buf: ArrayBuffer): ImageSource
通过缓冲区创建图片源实例。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
buf | ArrayBuffer | 是 | 图像缓冲区数组。 |
示例:
const buf = new ArrayBuffer(96);
image.createImageSource(buf, () = > { })
function CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource
通过缓冲区以增量的方式创建图片源实例。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
buf | ArrayBuffer | 是 | 增量数据。 |
options | [SourceOptions] | 否 | 图片属性,包括图片序号与默认属性值。 |
返回值:
类型 | 说明 |
---|---|
[ImageSource] | 返回图片源,失败时返回undefined。 |
示例:
const buf = new ArrayBuffer(96);
const imageSourceApi = image.createIncrementalSource(buf);
图片源类,用于获取图片相关信息。在调用ImageSource的方法前,需要先通过createImageSource构建一个ImageSource实例。
系统能力: SystemCapability.Multimedia.Image.ImageSource
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
supportedFormats | Array | 是 | 否 | 支持的图片格式,包括:png,jpeg,wbmp,bmp,gif,webp,heif等。 |
getImageInfo(index: number, callback: AsyncCallback): void
获取指定序号的图片信息,使用callback形式返回图片信息。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
index | number | 是 | 创建图片源时的序号。 |
callback | AsyncCallback<[ImageInfo]> | 是 | 获取图片信息回调,异步返回图片信息对象。 |
示例:
imageSourceApi.getImageInfo(0,(error, imageInfo) = > {
if(error) {
console.log('getImageInfo failed.');
} else {
console.log('getImageInfo succeeded.');
}
})
getImageInfo(callback: AsyncCallback): void
获取图片信息,使用callback形式返回图片信息。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[ImageInfo]> | 是 | 获取图片信息回调,异步返回图片信息对象。 |
示例:
imageSourceApi.getImageInfo(imageInfo = > {
console.log('Succeeded in obtaining the image information.');
})
getImageInfo(index?: number): Promise
获取图片信息,使用Promise形式返回图片信息。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
index | number | 否 | 创建图片源时的序号,不选择时默认为0。 |
返回值:
类型 | 说明 |
---|---|
Promise<[ImageInfo]> | 返回获取到的图片信息。 |
示例:
imageSourceApi.getImageInfo(0)
.then(imageInfo = > {
console.log('Succeeded in obtaining the image information.');
}).catch(error = > {
console.log('Failed to obtain the image information.');
})
getImageProperty(key:string, options?: GetImagePropertyOptions): Promise
获取图片中给定索引处图像的指定属性键的值,用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 图片属性名。 |
options | [GetImagePropertyOptions] | 否 | 图片属性,包括图片序号与默认属性值。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于异步获取图片属性值,如获取失败则返回属性默认值。 |
示例:
imageSourceApi.getImageProperty("BitsPerSample")
.then(data = > {
console.log('Succeeded in getting the value of the specified attribute key of the image.');
})
getImageProperty(key:string, callback: AsyncCallback): void
获取图片中给定索引处图像的指定属性键的值,用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 图片属性名。 |
callback | AsyncCallback | 是 | 获取图片属性回调,返回图片属性值,如获取失败则返回属性默认值。 |
示例:
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.');
}
})
getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback): void
获取图片指定属性键的值,callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 图片属性名。 |
options | [GetImagePropertyOptions] | 是 | 图片属性,包括图片序号与默认属性值。 |
callback | AsyncCallback | 是 | 获取图片属性回调,返回图片属性值,如获取失败则返回属性默认值。 |
示例:
const property = new ArrayBuffer(400);
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.');
}
})
modifyImageProperty(key: string, value: string): Promise
通过指定的键修改图片属性的值,使用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 图片属性名。 |
value | string | 是 | 属性值。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,异步返回结果。 |
示例:
imageSourceApi.modifyImageProperty("ImageWidth", "abc")
.then(() = > {
const w = imageSourceApi.getImageProperty("ImageWidth")
console.info('w', w);
})
modifyImageProperty(key: string, value: string, callback: AsyncCallback): void
通过指定的键修改图片属性的值,callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | string | 是 | 图片属性名。 |
value | string | 是 | 属性值。 |
callback | AsyncCallback | 是 | 修改属性值,callback返回结果。 |
示例:
imageSourceApi.modifyImageProperty("ImageWidth", "abc",() = > {})
updateData(buf: ArrayBuffer, isFinished: boolean, value: number, length: number): Promise
更新增量数据,使用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
buf | ArrayBuffer | 是 | 增量数据。 |
isFinished | boolean | 是 | 是否更新完。 |
value | number | 否 | 偏移量。 |
length | number | 否 | 数组长。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,异步返回结果。 |
示例:
const array = new ArrayBuffer(100);
imageSourceIncrementalSApi.updateData(array, false, 0, 10).then(data = > {
console.info('Succeeded in updating data.');
})
updateData(buf: ArrayBuffer, isFinished: boolean, value: number, length: number, callback: AsyncCallback): void
更新增量数据,callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
buf | ArrayBuffer | 是 | 增量数据。 |
isFinished | boolean | 是 | 是否更新完。 |
value | number | 否 | 偏移量。 |
length | number | 否 | 数组长。 |
callback | AsyncCallback | 是 | 回调表示成功或失败。 |
示例:
const array = new ArrayBuffer(100);
imageSourceIncrementalSApi.updateData(array, false, 0, 10,(error,data )= > {
if(data !== undefined){
console.info('Succeeded in updating data.');
}
})
createPixelMap(options?: DecodingOptions): Promise
通过图片解码参数创建PixelMap对象。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
options | [DecodingOptions] | 否 | 解码参数。 |
返回值:
类型 | 说明 |
---|---|
Promise<[PixelMap]> | 异步返回Promise对象。 |
示例:
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.');
})
createPixelMap(callback: AsyncCallback): void
通过默认参数创建PixelMap对象,使用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[PixelMap]> | 是 | 通过回调返回PixelMap对象。 |
示例:
imageSourceApi.createPixelMap(pixelmap = > {
console.log('Succeeded in creating pixelmap object.');
}).catch(error = > {
console.log('Failed to create pixelmap object.');
})
createPixelMap(options: DecodingOptions, callback: AsyncCallback): void
通过图片解码参数创建PixelMap对象。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
options | [DecodingOptions] | 是 | 解码参数。 |
callback | AsyncCallback<[PixelMap]> | 是 | 通过回调返回PixelMap对象。 |
示例:
const decodingOptions = new ArrayBuffer(400);
imageSourceApi.createPixelMap(decodingOptions, pixelmap = > {
console.log('Succeeded in creating pixelmap object.');
})
release(callback: AsyncCallback): void
释放图片源实例,使用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 资源释放回调,失败时返回错误信息。 |
示例:
imageSourceApi.release(() = > {
console.log('release succeeded.');
})
release(): Promise
释放图片源实例,使用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageSource
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,异步返回结果。 |
示例:
imageSourceApi.release().then(()= >{
console.log('Succeeded in releasing the image source instance.');
}).catch(error = > {
console.log('Failed to release the image source instance.');
})
createImagePacker(): ImagePacker
创建ImagePacker实例。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
返回值:
类型 | 说明 |
---|---|
[ImagePacker] | 返回ImagePacker实例。 |
示例:
const imagePackerApi = image.createImagePacker();
图片打包器类,用于图片压缩和打包。在调用ImagePacker的方法前,需要先通过createImagePacker构建一个ImagePacker实例。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
supportedFormats | Array | 是 | 否 | 图片打包支持的格式,jpeg。 |
packing(source: ImageSource, option: PackingOption, callback: AsyncCallback): void
图片压缩或重新打包,使用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
source | [ImageSource] | 是 | 打包的图片源。 |
option | [PackingOption] | 是 | 设置打包参数。 |
callback | AsyncCallback | 是 | 获取图片打包回调,返回打包后数据。 |
示例:
let packOpts = { format:"image/jpeg", quality:98 };
const imageSourceApi = new ArrayBuffer(400);
imagePackerApi.packing(imageSourceApi, packOpts, data = > {})
packing(source: ImageSource, option: PackingOption): Promise
图片压缩或重新打包,使用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
source | [ImageSource] | 是 | 打包的图片源。 |
option | [PackingOption] | 是 | 设置打包参数。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于异步获取压缩或打包后的数据。 |
示例:
let packOpts = { format:"image/jpeg", quality:98 }
const imageSourceApi = new ArrayBuffer(400);
imagePackerApi.packing(imageSourceApi, packOpts)
.then( data = > {
console.log('packing succeeded.');
}).catch(error = > {
console.log('packing failed.');
})
packing(source: PixelMap, option: PackingOption, callback: AsyncCallback): void
图片压缩或重新打包,使用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
source | [PixelMap] | 是 | 打包的PixelMap资源。 |
option | [PackingOption] | 是 | 设置打包参数。 |
callback | AsyncCallback | 是 | 获取图片打包回调,返回打包后数据。 |
示例:
let packOpts = { format:"image/jpeg", quality:98 }
const pixelMapApi = new ArrayBuffer(400);
imagePackerApi.packing(pixelMapApi, packOpts, data = > {
console.log('Succeeded in packing the image.');
}).catch(error = > {
console.log('Failed to pack the image.');
})
packing(source: PixelMap, option: PackingOption): Promise
图片压缩或重新打包,使用Promise形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
source | [PixelMap] | 是 | 打包的PixelMap源。 |
option | [PackingOption] | 是 | 设置打包参数。 |
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于异步获取压缩或打包后的数据。 |
示例:
let packOpts = { format:"image/jpeg", quality:98 }
const pixelMapApi = new ArrayBuffer(400);
imagePackerApi.packing(pixelMapApi, packOpts)
.then( data = > {
console.log('Succeeded in packing the image.');
}).catch(error = > {
console.log('Failed to pack the image..');
})
release(callback: AsyncCallback): void
释放图片打包实例,使用callback形式返回结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 释放回调,失败时返回错误信息。 |
示例:
imagePackerApi.release(()= >{
console.log('Succeeded in releasing image packaging.');
})
release(): Promise
释放图片打包实例,使用Promise形式返回释放结果。
系统能力: SystemCapability.Multimedia.Image.ImagePacker
返回值:
类型 | 说明 |
---|---|
Promise | Promise实例,用于异步获取释放结果,失败时返回错误信息。 |
示例:
imagePackerApi.release().then(()= >{
console.log('Succeeded in releasing image packaging.');
}).catch((error)= >{
console.log('Failed to release image packaging.');
})
createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver
通过宽、高、图片格式、容量创建ImageReceiver实例。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
width | number | 是 | 图像的默认宽度。 |
height | number | 是 | 图像的默认高度。 |
format | number | 是 | 图像格式。 |
capacity | number | 是 | 同时访问的最大图像数。 |
返回值:
类型 | 说明 |
---|---|
[ImageReceiver] | 如果操作成功,则返回ImageReceiver实例。 |
示例:
var receiver = image.createImageReceiver(8192, 8, 4, 8);
图像接收类,用于获取组件surface id,接收最新的图片和读取下一张图片,以及释放ImageReceiver实例。
在调用以下方法前需要先创建ImageReceiver实例。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
size9+ | [Size] | 是 | 否 | 图片大小。 |
capacity9+ | number | 是 | 否 | 同时访问的图像数。 |
format9+ | [ImageFormat] | 是 | 否 | 图像格式。 |
getReceivingSurfaceId(callback: AsyncCallback): void
用于获取一个surface id供Camera或其他组件使用。使用callback返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 回调函数,返回surface id。 |
示例:
receiver.getReceivingSurfaceId((err, id) = > {
if(err) {
console.log('getReceivingSurfaceId failed.');
} else {
console.log('getReceivingSurfaceId succeeded.');
}
});
getReceivingSurfaceId(): Promise
用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
返回值:
类型 | 说明 |
---|---|
Promise | 异步返回surface id。 |
示例:
receiver.getReceivingSurfaceId().then( id = > {
console.log('getReceivingSurfaceId succeeded.');
}).catch(error = > {
console.log('getReceivingSurfaceId failed.');
})
readLatestImage(callback: AsyncCallback): void
从ImageReceiver读取最新的图片,并使用callback返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[Image]> | 是 | 回调函数,返回最新图像。 |
示例:
receiver.readLatestImage((err, img) = > {
if(err) {
console.log('readLatestImage failed.');
} else {
console.log('readLatestImage succeeded.');
}
});
readLatestImage(): Promise
从ImageReceiver读取最新的图片,并使用promise返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
返回值:
类型 | 说明 |
---|---|
Promise<[Image]> | 异步返回最新图片。 |
示例:
receiver.readLatestImage().then(img = > {
console.log('readLatestImage succeeded.');
}).catch(error = > {
console.log('readLatestImage failed.');
})
readNextImage(callback: AsyncCallback): void
从ImageReceiver读取下一张图片,并使用callback返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<[Image]> | 是 | 回调函数,返回下一张图片。 |
示例:
receiver.readNextImage((err, img) = > {
if(err) {
console.log('readNextImage failed.');
} else {
console.log('readNextImage succeeded.');
}
});
readNextImage(): Promise
从ImageReceiver读取下一张图片,并使用promise返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
返回值:
类型 | 说明 |
---|---|
Promise<[Image]> | 异步返回下一张图片。 |
示例:
receiver.readNextImage().then(img = > {
console.log('readNextImage succeeded.');
}).catch(error = > {
console.log('readNextImage failed.');
})
on(type: 'imageArrival', callback: AsyncCallback): void
接收图片时注册回调。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | 注册事件的类型,固定为'imageArrival',接收图片时触发。 |
callback | AsyncCallback | 是 | 注册的事件回调。 |
示例:
receiver.on('imageArrival', () = > {})
release(callback: AsyncCallback): void
释放ImageReceiver实例并使用回调返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 回调函数,返回操作结果。 |
示例:
receiver.release(() = > {})
release(): Promise
释放ImageReceiver实例并使用promise返回结果。
系统能力: SystemCapability.Multimedia.Image.ImageReceiver
返回值:
类型 | 说明 |
---|---|
Promise | 异步返回操作结果。 |
示例:
receiver.release().then(() = > {
console.log('release succeeded.');
}).catch(error = > {
console.log('release failed.');
})
提供基本的图像操作,包括获取图像信息、读写图像数据。调用[readNextImage]和[readLatestImage]接口时会返回image。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
clipRect9+ | [Region] | 是 | 是 | 要裁剪的图像区域。 |
size9+ | [Size] | 是 | 否 | 图像大小。 |
format9+ | number | 是 | 否 | 图像格式,参考[PixelMapFormat]。 |
getComponent(componentType: ComponentType, callback: AsyncCallback): void
根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
componentType | [ComponentType] | 是 | 图像的组件类型。 |
callback | AsyncCallback<[Component]> | 是 | 用于返回组件缓冲区。 |
示例:
img.getComponent(4, (err, component) = > {
if(err) {
console.log('getComponent failed.');
} else {
console.log('getComponent succeeded.');
}
})
getComponent(componentType: ComponentType): Promise
根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
componentType | [ComponentType] | 是 | 图像的组件类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<[Component]> | 用于返回组件缓冲区的promise实例。 |
示例:
img.getComponent(4).then(component = > { })
release(callback: AsyncCallback): void
释放当前图像并使用callback返回结果。
在接收另一个图像前必须先释放对应资源。
系统能力: SystemCapability.Multimedia.Image.Core
参数:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback | 是 | 返回操作结果。 |
示例:
img.release(() = >{
console.log('release succeeded.');
}).catch(error = > {
console.log('release failed.');
})
release(): Promise
释放当前图像并使用Promise方式返回结果。
在接收另一个图像前必须先释放对应资源。
系统能力: SystemCapability.Multimedia.Image.Core
返回值:
类型 | 说明 |
---|---|
Promise | promise返回操作结果。 |
示例:
img.release().then(() = >{
console.log('release succeeded.');
}).catch(error = > {
console.log('release failed.');
})
表示图片指定区域内的数据。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
pixels | ArrayBuffer | 是 | 否 | 像素。 |
offset | number | 是 | 否 | 偏移量。 |
stride | number | 是 | 否 | 像素间距,stride >= region.size.width*4。 |
region | [Region] | 是 | 否 | 区域,按照区域读写。写入的区域宽度加X坐标不能大于原图的宽度,写入的区域高度加Y坐标不能大于原图的高度 |
表示图片信息。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
size | [Size] | 是 | 是 | 图片大小。 |
表示图片尺寸。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
height | number | 是 | 是 | 输出图片的高。 |
width | number | 是 | 是 | 输出图片的宽。 |
枚举,图片像素格式。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 默认值 | 描述 |
---|---|---|
UNKNOWN | 0 | 未知格式。 |
RGBA_8888 | 3 | 格式为RGBA_8888。 |
RGB_565 | 2 | 格式为RGB_565。 |
枚举,图像的透明度类型。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 默认值 | 描述 |
---|---|---|
UNKNOWN | 0 | 未知透明度。 |
OPAQUE | 1 | 没有alpha或图片全透明。 |
PREMUL | 2 | RGB前乘alpha。 |
UNPREMUL | 3 | RGB不前乘alpha。 |
枚举,图像的缩放模式。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 默认值 | 描述 |
---|---|---|
CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 |
FIT_TARGET_SIZE | 2 | 图像适合目标尺寸的效果。 |
PixelMap的初始化选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Code
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
alphaType9+ | [AlphaType] | 是 | 是 | 透明度。 |
editable | boolean | 是 | 是 | 是否可编辑。 |
pixelFormat | [PixelMapFormat] | 是 | 是 | 像素格式。 |
scaleMode9+ | [ScaleMode] | 是 | 是 | 缩略值。 |
size | [Size] | 是 | 是 | 创建图片大小。 |
图像解码设置选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageSource
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
sampleSize | number | 是 | 是 | 缩略图采样大小。 |
rotate | number | 是 | 是 | 旋转角度。 |
editable | boolean | 是 | 是 | 是否可编辑。 |
desiredSize | [Size] | 是 | 是 | 期望输出大小。 |
desiredRegion | [Region] | 是 | 是 | 解码区域。 |
desiredPixelFormat | [PixelMapFormat] | 是 | 是 | 解码的像素格式。 |
index | number | 是 | 是 | 解码图片序号。 |
表示区域信息。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
size | [Size] | 是 | 是 | 区域大小。 |
x | number | 是 | 是 | 区域横坐标。 |
y | number | 是 | 是 | 区域纵坐标。 |
表示图片打包选项。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImagePacker
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
format | string | 是 | 是 | 目标格式。 |
quality | number | 是 | 是 | JPEG编码中设定输出图片质量的参数,取值范围为1-100。 |
表示查询图片属性的索引。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageSource
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
index | number | 是 | 是 | 图片序号。 |
defaultValue | string | 是 | 是 | 默认属性值。 |
枚举,Exif(Exchangeable image file format)图片信息。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 默认值 | 说明 |
---|---|---|
BITS_PER_SAMPLE | "BitsPerSample" | 每个像素比特数。 |
ORIENTATION | "Orientation" | 图片方向。 |
IMAGE_LENGTH | "ImageLength" | 图片长度。 |
IMAGE_WIDTH | "ImageWidth" | 图片宽度。 |
GPS_LATITUDE | "GPSLatitude" | 图片纬度。 |
GPS_LONGITUDE | "GPSLongitude" | 图片经度。 |
GPS_LATITUDE_REF | "GPSLatitudeRef" | 纬度引用,例如N或S。 |
GPS_LONGITUDE_REF | "GPSLongitudeRef" | 经度引用,例如W或E。 |
枚举,图片格式。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 默认值 | 描述 |
---|---|---|
YCBCR_422_SP | 1000 | YCBCR422半平面格式。 |
JPEG | 2000 | JPEG编码格式。 |
枚举,图像的组件类型。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver
名称 | 默认值 | 描述 |
---|---|---|
YUV_Y | 1 | 亮度信息。 |
YUV_U | 2 | 色度信息。 |
YUV_V | 3 | 色度信息。 |
JPEG | 4 | Jpeg 类型。 |
描述图像颜色分量。
系统能力: 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
componentType | [ComponentType] | 是 | 否 | 组件类型。 |
rowStride | number | 是 | 否 | 行距。 |
pixelStride | number | 是 | 否 | 像素间距。 |
byteBuffer | ArrayBuffer | 是 | 否 | 组件缓冲区。 |
编译错误返回的响应码。
名称HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿 | 值 | 说明 |
---|---|---|
ERR_MEDIA_INVALID_VALUE | -1 | 无效大小。 |
SUCCESS | 0 | 操作成功。 |
ERROR | 62980096 | 操作失败。 |
ERR_IPC | 62980097 | ipc错误。 |
ERR_SHAMEM_NOT_EXIST | 62980098 | 共享内存错误。 |
ERR_SHAMEM_DATA_ABNORMAL | 62980099 | 共享内存错误。 |
ERR_IMAGE_DECODE_ABNORMAL | 62980100 | 图像解码错误。 |
ERR_IMAGE_DATA_ABNORMAL | 62980101 | 图像输入数据错误。 |
ERR_IMAGE_MALLOC_ABNORMAL | 62980102 | 图像malloc错误。 |
ERR_IMAGE_DATA_UNSUPPORT | 62980103 | 不支持图像类型。 |
ERR_IMAGE_INIT_ABNORMAL | 62980104 | 图像初始化错误。 |
ERR_IMAGE_GET_DATA_ABNORMAL | 62980105 | 图像获取数据错误。 |
ERR_IMAGE_TOO_LARGE | 62980106 | 图像数据太大。 |
ERR_IMAGE_TRANSFORM | 62980107 | 图像转换错误。 |
ERR_IMAGE_COLOR_CONVERT | 62980108 | 图像颜色转换错误。 |
ERR_IMAGE_CROP | 62980109 | 裁剪错误。 |
ERR_IMAGE_SOURCE_DATA | 62980110 | 图像源数据错误。 |
ERR_IMAGE_SOURCE_DATA_INCOMPLETE | 62980111 | 图像源数据不完整。 |
ERR_IMAGE_MISMATCHED_FORMAT | 62980112 | 图像格式不匹配。 |
ERR_IMAGE_UNKNOWN_FORMAT | 62980113 | 图像未知格式。 |
ERR_IMAGE_SOURCE_UNRESOLVED | 62980114 | 图像源未解析。 |
ERR_IMAGE_INVALID_PARAMETER | 62980115 | 图像无效参数。 |
ERR_IMAGE_DECODE_FAILED | 62980116 | 解码失败。 |
ERR_IMAGE_PLUGIN_REGISTER_FAILED | 62980117 | 注册插件失败。 |
ERR_IMAGE_PLUGIN_CREATE_FAILED | 62980118 | 创建插件失败。 |
ERR_IMAGE_ENCODE_FAILED | 62980119 | 图像编码失败。 |
ERR_IMAGE_ADD_PIXEL_MAP_FAILED | 62980120 | 图像添加像素映射失败。 |
ERR_IMAGE_HW_DECODE_UNSUPPORT | 62980121 | 不支持图像硬件解码。 |
ERR_IMAGE_DECODE_HEAD_ABNORMAL | 62980122 | 图像解码头错误。 |
ERR_IMAGE_DECODE_EXIF_UNSUPPORT | 62980123 | 图像解码exif取消支持。 |
ERR_IMAGE_PROPERTY_NOT_EXIST | 62980124 | 图像属性不存在;错误代码被媒体占用,图像从150开始。 |
ERR_IMAGE_READ_PIXELMAP_FAILED | 62980246 | 读取像素地图失败。 |
ERR_IMAGE_WRITE_PIXELMAP_FAILED | 62980247 | 写入像素映射失败。 |
ERR_IMAGE_PIXELMAP_NOT_ALLOW_MODIFY | 62980248 | pixelmap不允许修改。 |
ERR_IMAGE_CONFIG_FAILED | 62980259 | 配置错误。 |
审核编辑 黄宇 |
全部0条评论
快来发表一下你的评论吧 !