Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 ac792af0 编写于 作者: Z zengyawen
浏览文件
操作

update image apidoc 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 7eb8c090
隐藏空白更改
内联 并排
Showing with 296 addition and 523 deletion
zh-cn/application-dev/reference/apis/js-apis-image.md
浏览文件 @ ac792af0
...@@ -8,28 +8,28 @@ ...@@ -8,28 +8,28 @@
--------- ---------
``` ```
import image from './@ohos.multimedia.image'; import image from '@ohos.multimedia.image';
``` ```
## image.createPixelMap ## image.createPixelMap<sup>8+</sup>
createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions): Promise\<PixelMap> createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions): Promise\<PixelMap>
通过colors和opts创建pixelmap。 通过属性创建Pixelmap，通过Promise返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------------------- | ---- | ------------------------------------------------------------ | | ------ | ------------------------------------------------ | ---- | ------------------------------------------------------------ |
| colors | ArrayBuffer | 是 | 颜色数组。 | | colors | ArrayBuffer | 是 | 颜色数组。 |
| opts | [InitializetionOptions](#InitializationOptions) | 是 | 创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。 | | opts | [InitializetionOptions](#InitializationOptions8) | 是 | 创建像素的属性，包括透明度，尺寸，缩略值，像素格式和是否可编辑。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------ | -------------- | | -------------------------------- | -------------- |
| Promise\<PixelMap> | 返回pixelmap。 | | Promise\<[PixelMap](#pixelmap7)> | 返回pixelmap。 |
**示例：** **示例：**
...@@ -41,21 +41,21 @@ image.createPixelMap(Color, opts) ...@@ -41,21 +41,21 @@ image.createPixelMap(Color, opts)
}) })
``` ```
## image.createPixelMap ## image.createPixelMap<sup>8+</sup>
createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions) callback: AsyncCallback\<PixelMap>): void createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions) callback: AsyncCallback\<PixelMap>): void
通过属性创建pixelmap。 通过属性创建Pixelmap，通过回调函数返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | -------------------- | | -------- | ------------------------------------------------ | ---- | -------------------- |
| colors | ArrayBuffer | 是 | 颜色数组。 | | colors | ArrayBuffer | 是 | 颜色数组。 |
| opts | [InitializetionOptions](#InitializationOptions) | 是 | 属性。 | | opts | [InitializetionOptions](#InitializationOptions8) | 是 | 属性。 |
| callback | AsyncCallback\<PixelMap> | 是 | 回调表示成功或失败。 | | callback | AsyncCallback\<[PixelMap](#pixelmap7)> | 是 | 回调表示成功或失败。 |
**示例：** **示例：**
...@@ -66,21 +66,19 @@ image.createPixelMap(Color, opts, (pixelmap) => { ...@@ -66,21 +66,19 @@ image.createPixelMap(Color, opts, (pixelmap) => {
}) })
``` ```
## PixelMap<a name="PixelMap"></a> ## PixelMap<sup>7+</sup>
图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。 图像像素类，用于读取或写入图像数据以及获取图像信息。在调用PixelMap的方法前，需要先通过createPixelMap创建一个PixelMap实例。
### 属性 ### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ------- | ---- | ---- | ------------------------------------------------------------ | | ----------------------- | ------- | ---- | ---- | ------------------------------------------------------------ |
| isEditable | boolean | 是 | 否 | 设定是否图像像素可被编辑。<br/>**系统能力：** SystemCapability.Multimedia.Image | | isEditable<sup>7+</sup> | boolean | 是 | 否 | 设定是否图像像素可被编辑。<br/>**系统能力：** SystemCapability.Multimedia.Image |
### readPixelsToBuffer ### readPixelsToBuffer<sup>7+</sup>
``` readPixelsToBuffer(dst: ArrayBuffer): Promise\<void>
readPixelsToBuffer(dst: ArrayBuffer): Promise<void>
```
读取图像像素数据，结果写入ArrayBuffer里，使用Promise形式返回。 读取图像像素数据，结果写入ArrayBuffer里，使用Promise形式返回。
...@@ -123,11 +121,11 @@ pixelmap.readPixelsToBuffer(readBuffer).then(() => { ...@@ -123,11 +121,11 @@ pixelmap.readPixelsToBuffer(readBuffer).then(() => {
}) })
``` ```
### readPixelsToBuffer ### readPixelsToBuffer<sup>7+</sup>
readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\<void>): void readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\<void>): void
读取图像像素数据，结果写入ArrayBuffer里,使用callback形式返回。 读取图像像素数据，结果写入ArrayBuffer里，使用callback形式返回。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -163,7 +161,7 @@ pixelmap.readPixelsToBuffer(readBuffer, () => { ...@@ -163,7 +161,7 @@ pixelmap.readPixelsToBuffer(readBuffer, () => {
}) })
``` ```
### readPixels ### readPixels<sup>7+</sup>
readPixels(area: PositionArea): Promise\<void> readPixels(area: PositionArea): Promise\<void>
...@@ -173,9 +171,9 @@ readPixels(area: PositionArea): Promise\<void> ...@@ -173,9 +171,9 @@ readPixels(area: PositionArea): Promise\<void>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------------------------ | | ------ | ------------------------------ | ---- | ------------------------ |
| area | [PositionArea](#PositionArea) | 是 | 区域大小，根据区域读取。 | | area | [PositionArea](#positionarea7) | 是 | 区域大小，根据区域读取。 |
**返回值：** **返回值：**
...@@ -211,20 +209,20 @@ pixelmap.readPixels(area).then((data) => { ...@@ -211,20 +209,20 @@ pixelmap.readPixels(area).then((data) => {
}) })
``` ```
### readPixels ### readPixels<sup>7+</sup>
readPixels(area: PositionArea, callback: AsyncCallback\<void>): void readPixels(area: PositionArea, callback: AsyncCallback\<void>): void
读区域的像素。 读取区域内的图片数据，使用callback形式返回读取结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ------------------------------ | | -------- | ------------------------------ | ---- | ------------------------------ |
| area | [PositionArea](#PositionArea) | 是 | 区域大小，根据区域读取。 | | area | [PositionArea](#positionarea7) | 是 | 区域大小，根据区域读取。 |
| callback | AsyncCallback\<void> | 是 | 获取回调，失败时返回错误信息。 | | callback | AsyncCallback\<void> | 是 | 获取回调，失败时返回错误信息。 |
**示例：** **示例：**
...@@ -247,19 +245,19 @@ pixelmap.readPixels(area,(data) => { ...@@ -247,19 +245,19 @@ pixelmap.readPixels(area,(data) => {
} }
``` ```
### writePixels ### writePixels<sup>7+</sup>
writePixels(area: PositionArea): Promise\<void> writePixels(area: PositionArea): Promise\<void>
先创建pixelmap，将pixelmap写入指定区域内，使用Promise形式返回写入结果。 将Pixelmap写入指定区域内，使用Promise形式返回写入结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | -------------------- | | ------ | ------------------------------ | ---- | -------------------- |
| area | [PositionArea](#PositionArea) | 是 | 区域，根据区域写入。 | | area | [PositionArea](#PositionArea7) | 是 | 区域，根据区域写入。 |
**返回值：** **返回值：**
...@@ -277,20 +275,20 @@ pixelMap.writePixels(area).then(() => { ...@@ -277,20 +275,20 @@ pixelMap.writePixels(area).then(() => {
}); });
``` ```
### writePixels ### writePixels<sup>7+</sup>
writePixels(area: PositionArea, callback: AsyncCallback\<void>): void writePixels(area: PositionArea, callback: AsyncCallback\<void>): void
将指定的像素信息写入指定区域内。 将Pixelmap写入指定区域内，使用callback形式返回写入结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------- | ---- | ------------------------------ | | --------- | ------------------------------ | ---- | ------------------------------ |
| area | [PositionArea](#PositionArea) | 是 | 区域，根据区域写入。 | | area | [PositionArea](#PositionArea7) | 是 | 区域，根据区域写入。 |
| callback: | AsyncCallback\<void> | 是 | 获取回调，失败时返回错误信息。 | | callback: | AsyncCallback\<void> | 是 | 获取回调，失败时返回错误信息。 |
**示例：** **示例：**
...@@ -305,19 +303,19 @@ pixelmap.writePixels(area, () => { ...@@ -305,19 +303,19 @@ pixelmap.writePixels(area, () => {
}) })
``` ```
### writeBufferToPixels ### writeBufferToPixels<sup>7+</sup>
writeBufferToPixels(src: ArrayBuffer): Promise\<void> writeBufferToPixels(src: ArrayBuffer): Promise\<void>
将缓冲区的内容写入像素。 读取缓冲区中的图片数据，结果写入Pixelmap中，使用Promise形式返回。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------- | ---- | -------- | | ------ | ----------- | ---- | -------------- |
| src | ArrayBuffer | 是 | 缓冲区。 | | src | ArrayBuffer | 是 | 图像像素数据。 |
**返回值：** **返回值：**
...@@ -335,11 +333,11 @@ pixelMap.writeBufferToPixels(colorBuffer).then(() => { ...@@ -335,11 +333,11 @@ pixelMap.writeBufferToPixels(colorBuffer).then(() => {
}); });
``` ```
### writeBufferToPixels ### writeBufferToPixels<sup>7+</sup>
writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void
将缓冲区的内容写入像素。 读取缓冲区中的图片数据，结果写入Pixelmap中，使用Promise形式返回。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -362,7 +360,7 @@ pixelMap.writeBufferToPixels(colorBuffer, function(err) { ...@@ -362,7 +360,7 @@ pixelMap.writeBufferToPixels(colorBuffer, function(err) {
}); });
``` ```
### getImageInfo ### getImageInfo<sup>7+</sup>
getImageInfo(): Promise\<ImageInfo> getImageInfo(): Promise\<ImageInfo>
...@@ -372,9 +370,9 @@ getImageInfo(): Promise\<ImageInfo> ...@@ -372,9 +370,9 @@ getImageInfo(): Promise\<ImageInfo>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------------------------------------- | | --------------------------------- | ----------------------------------------------------------- |
| Promise\<ImageInfo> | Promise实例，用于异步获取图像像素信息，失败时返回错误信息。 | | Promise\<[ImageInfo](#imageinfo)> | Promise实例，用于异步获取图像像素信息，失败时返回错误信息。 |
**示例：** **示例：**
...@@ -386,7 +384,7 @@ pixelMap.getImageInfo().then(function(info) { ...@@ -386,7 +384,7 @@ pixelMap.getImageInfo().then(function(info) {
}); });
``` ```
### getImageInfo ### getImageInfo<sup>7+</sup>
getImageInfo(callback: AsyncCallback\<ImageInfo>): void getImageInfo(callback: AsyncCallback\<ImageInfo>): void
...@@ -396,9 +394,9 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void ...@@ -396,9 +394,9 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<ImageInfo> | 是 | 获取图像像素信息回调，异步返回图像像素信息，失败时返回错误信息。 | | callback | AsyncCallback\<[ImageInfo](#imageinfo)> | 是 | 获取图像像素信息回调，异步返回图像像素信息，失败时返回错误信息。 |
**示例:** **示例:**
...@@ -418,9 +416,9 @@ pixelmap.getImageInfo((imageInfo) => { ...@@ -418,9 +416,9 @@ pixelmap.getImageInfo((imageInfo) => {
}) })
``` ```
### getBytesNumberPerRow ### getBytesNumberPerRow<sup>7+</sup>
getBytesNumberPerRow(): Promise\<number> getBytesNumberPerRow(): number
获取图像像素每行字节数。 获取图像像素每行字节数。
...@@ -428,9 +426,9 @@ getBytesNumberPerRow(): Promise\<number> ...@@ -428,9 +426,9 @@ getBytesNumberPerRow(): Promise\<number>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | --------------------------------------------- | | ------ | -------------------- |
| Promise\<number> | Promise实例，用于异步获取图像像素的行字节数。 | | number | 图像像素的行字节数。 |
**示例：** **示例：**
...@@ -442,33 +440,9 @@ pixelmap.getBytesNumberPerRow().then((num) => { ...@@ -442,33 +440,9 @@ pixelmap.getBytesNumberPerRow().then((num) => {
}) })
``` ```
### getBytesNumberPerRow ### getPixelBytesNumber<sup>7+</sup>
getBytesNumberPerRow(callback: AsyncCallback\<number>): void
获取图像像素每行字节数。
**系统能力：** SystemCapability.Multimedia.Image getPixelBytesNumber(): number
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是 | 通过回调返回结果。 |
**示例：**
```js
pixelmap.getBytesNumberPerRow( num => {
console.info('TC_025-1 num is ' + num);
expect(num == expectNum).assertTrue();
done();
})
```
### getPixelBytesNumber
getPixelBytesNumber(): Promise\<number>
获取图像像素的总字节数。 获取图像像素的总字节数。
...@@ -476,9 +450,9 @@ getPixelBytesNumber(): Promise\<number> ...@@ -476,9 +450,9 @@ getPixelBytesNumber(): Promise\<number>
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | --------------------------------------------- | | ------ | -------------------- |
| Promise\<number> | Promise实例，用于异步获取图像像素的总字节数。 | | number | 图像像素的总字节数。 |
**示例：** **示例：**
...@@ -490,37 +464,19 @@ pixelmap.getPixelBytesNumber().then((num) => { ...@@ -490,37 +464,19 @@ pixelmap.getPixelBytesNumber().then((num) => {
}) })
``` ```
### getPixelBytesNumber ### release<sup>7+</sup>
getPixelBytesNumber(callback: AsyncCallback\<number>): void release():Promise\<void>
获取图像像素的总字节数。 释放Pixelmap对象，使用Promise形式返回释放结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **返回值：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<number> | 是 | 通过回调返回结果。 |
**示例：**
```js
pixelmap.getPixelBytesNumber((num) => {
console.info('TC_026-1 num is ' + num)
expect(num == expectNum).assertTrue()
done()
})
```
### release
release(): void
释放pixelmap对象，使用Promise形式返回释放结果。
**系统能力：** SystemCapability.Multimedia.Image | 类型 | 说明 |
| -------------- | ------------------ |
| Promise\<void> | 异步返回释放结果。 |
**示例：** **示例：**
...@@ -530,110 +486,80 @@ pixelmap.release() ...@@ -530,110 +486,80 @@ pixelmap.release()
done() done()
``` ```
## image.createImageSource ### release<sup>7+</sup>
createImageSource(uri: string): ImageSource
创建图片源。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| uri | string | 是 | 图片路径。 |
**返回值：**
| 类型 | 说明 |
| ----------- | ------------ |
| ImageSource | 返回图片源。 |
**示例：**
```js release(callback: AsyncCallback\<void>): void
const imageSourceApi = image.createImageSource('/data/local/tmp/test.jpg')
```
## image.createImageSource
createImageSource(fd: number): ImageSource
创建图片源。 释放Pixelmap对象，使用callback形式返回释放结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ | | -------- | -------------------- | ---- | ------------------ |
| fd | number | 是 | 基于fd创建图片源。 | | callback | AsyncCallback\<void> | 是 | 异步返回释放结果。 |
**返回值：**
| 类型 | 说明 |
| ----------- | ------------ |
| ImageSource | 返回图片源。 |
**示例：** **示例：**
```js ```js
const imageSourceApi = image.createImageSource(0) pixelmap.release(()=>{
expect(true).assertTrue();
console.log('TC_027-1 success');
done();
})
``` ```
## image.createImageSource ## image.createImageSource
createImageSource(data: ArrayBuffer): ImageSource createImageSource(uri: string): ImageSource
创建图片源。 通过传入的uri创建图片源实例。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------- | ---- | ------ | | ------ | ------ | ---- | ---------------------------------- |
| data | ArrayBuffer | 是 | 数组。 | | uri | string | 是 | 图片路径，当前仅支持本地绝对路径。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | ------------ | | --------------------------- | --------------------------------------- |
| ImageSource | 返回图片源。 | | [ImageSource](#imagesource) | 返回ImageSource类实例，失败时返回null。 |
**示例：** **示例：**
```js ```js
const data = new ArrayBuffer(96); const imageSourceApi = image.createImageSource('/data/local/tmp/test.jpg')
const imageSourceApi = image.createImageSource(data);
``` ```
## image.createIncrementalSource ## image.createImageSource<sup>7+</sup>
createIncrementalSource(data: ArrayBuffer): ImageSource createImageSource(fd: number): ImageSource
创建增量图片源。 通过传入文件描述符来创建图片源实例。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------- | ---- | ---- | | ------ | ------ | ---- | -------------- |
| data | ArrayBuffer | 是 | 数组 | | fd | number | 是 | 文件描述符fd。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | ------------ | | --------------------------- | --------------------------------------- |
| ImageSource | 返回图片源。 | | [ImageSource](#imagesource) | 返回ImageSource类实例，失败时返回null。 |
**示例：** **示例：**
```js ```js
const data = new ArrayBuffer(96); const imageSourceApi = image.createImageSource(0)
const imageSourceApi = image.createIncrementalSource(data);
``` ```
## ImageSource ## ImageSource
...@@ -656,10 +582,10 @@ getImageInfo(index: number, callback: AsyncCallback\<ImageInfo>): void ...@@ -656,10 +582,10 @@ getImageInfo(index: number, callback: AsyncCallback\<ImageInfo>): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ----------------------------------------------- | | -------- | -------------------------------------- | ---- | ---------------------------------------- |
| index | number | 是 | 图片序号，创建图片源时的序号，不选择时默认为0。 | | index | number | 是 | 创建图片源时的序号。 |
| callback | AsyncCallback<[ImageInfo](#ImageInfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 | | callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 |
**示例：** **示例：**
...@@ -684,7 +610,7 @@ it('TC_046', 0, async function (done) { ...@@ -684,7 +610,7 @@ it('TC_046', 0, async function (done) {
getImageInfo(callback: AsyncCallback\<ImageInfo>): void getImageInfo(callback: AsyncCallback\<ImageInfo>): void
获取指定序号的图片信息，使用callback形式返回图片信息。 获取图片信息，使用callback形式返回图片信息。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -692,7 +618,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void ...@@ -692,7 +618,7 @@ getImageInfo(callback: AsyncCallback\<ImageInfo>): void
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------------------------------- | | -------- | -------------------------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback<[ImageInfo](#ImageInfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 | | callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是 | 获取图片信息回调，异步返回图片信息对象。 |
**示例：** **示例：**
...@@ -714,15 +640,15 @@ getImageInfo(index?: number): Promise\<ImageInfo> ...@@ -714,15 +640,15 @@ getImageInfo(index?: number): Promise\<ImageInfo>
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----------------------------------------------- | | ----- | ------ | ---- | ------------------------------------- |
| index | number | 否 | 图片序号，创建图片源时的序号，不选择时默认为0。 | | index | number | 否 | 创建图片源时的序号，不选择时默认为0。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------- | ---------------------- | | -------------------------------- | ---------------------- |
| Promise\<[ImageInfo](#ImageInfo)> | 返回获取到的图片信息。 | | Promise<[ImageInfo](#imageinfo)> | 返回获取到的图片信息。 |
**示例：** **示例：**
...@@ -735,20 +661,20 @@ imageSourceApi.getImageInfo(0) ...@@ -735,20 +661,20 @@ imageSourceApi.getImageInfo(0)
}) })
``` ```
### getImageProperty ### getImageProperty<sup>7+</sup>
getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string> getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string>
获取图片中给定索引处图像的指定属性键的值。 获取图片中给定索引处图像的指定属性键的值，用Promise形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------------------- | ---- | ------------------------------------ | | ------- | ---------------------------------------------------- | ---- | ------------------------------------ |
| key | string | 是 | 图片属性名。 | | key | string | 是 | 图片属性名。 |
| options | [GetImagePropertyOptions](#GetImagePropertyOptions) | 否 | 图片属性，包括图片序号与默认属性值。 | | options | [GetImagePropertyOptions](#getimagepropertyoptions7) | 否 | 图片属性，包括图片序号与默认属性值。 |
**返回值：** **返回值：**
...@@ -762,11 +688,11 @@ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string ...@@ -762,11 +688,11 @@ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string
const w = imageSourceApi.getImageProperty("ImageWidth") const w = imageSourceApi.getImageProperty("ImageWidth")
``` ```
### getImageProperty ### getImageProperty<sup>7+</sup>
getImageProperty(key:string, callback: AsyncCallback\<string>): void getImageProperty(key:string, callback: AsyncCallback\<string>): void
获取图片中给定索引处图像的指定属性键的值，使用callback形式返回结果。 获取图片中给定索引处图像的指定属性键的值，用callback形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -783,7 +709,7 @@ getImageProperty(key:string, callback: AsyncCallback\<string>): void ...@@ -783,7 +709,7 @@ getImageProperty(key:string, callback: AsyncCallback\<string>): void
const w = imageSourceApi.getImageProperty("ImageWidth",w=>{}) const w = imageSourceApi.getImageProperty("ImageWidth",w=>{})
``` ```
### getImageProperty ### getImageProperty<sup>7+</sup>
getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback\<string>): void getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback\<string>): void
...@@ -793,11 +719,11 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa ...@@ -793,11 +719,11 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| key | string | 是 | 图片属性名。 | | key | string | 是 | 图片属性名。 |
| options | [GetImagePropertyOptions](#GetImagePropertyOptions) | 是 | 图片属性，包括图片序号与默认属性值。 | | options | [GetImagePropertyOptions](#getimagepropertyoptions7) | 是 | 图片属性，包括图片序号与默认属性值。 |
| callback | AsyncCallback\<string> | 是 | 获取图片属性回调，返回图片属性值，如获取失败则返回属性默认值。 | | callback | AsyncCallback\<string> | 是 | 获取图片属性回调，返回图片属性值，如获取失败则返回属性默认值。 |
**示例：** **示例：**
...@@ -805,107 +731,21 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa ...@@ -805,107 +731,21 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa
imageSourceApi.getImageProperty("ImageWidth",PropertyOptions,(w)=>{}) imageSourceApi.getImageProperty("ImageWidth",PropertyOptions,(w)=>{})
``` ```
### modifyImageProperty ### createPixelMap<sup>7+</sup>
modifyImageProperty(key:string, value:string, options?: GetImagePropertyOptions): Promise\<void>
修改属性的值。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------------------- | ---- | ------------------------------------ |
| key | string | 是 | 图片属性名。 |
| value | string | 是 | 属性值。 |
| options | [GetImagePropertyOptions](#GetImagePropertyOptions) | 是 | 图片属性，包括图片序号与默认属性值。 |
**返回值：**
| 类型 | 说明 |
| -------------- | --------------------------- |
| Promise\<void> | Promise实例，异步返回结果。 |
**示例：**
**示例：**
```js
imageSourceApi.modifyImageProperty("ImageWidth", "abc")
.then(() => {
const w = imageSourceApi.getImageProperty("ImageWidth")
console.info('w', w);
expect(w == 'abc').assertTrue();
done();
})
```
### modifyImageProperty
modifyImageProperty(key:string, value:string, callback: AsyncCallback\<void>): void
修改属性的值，callback返回结果。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------ |
| key | string | 是 | 图片属性名。 |
| value | string | 是 | 属性值。 |
| callback | AsyncCallback\<void> | 是 | 修改属性值，callback返回结果。 |
**示例：**
```js
imageSourceApi.modifyImageProperty("ImageWidth", "abc",() => {})
```
### modifyImageProperty
modifyImageProperty(key:string, value:string, options: GetImagePropertyOptions,callback: AsyncCallback\<void>): void
修改属性的值，callback返回结果。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ------------------------------------ |
| key | string | 是 | 图片属性名。 |
| value | string | 是 | 属性值。 |
| options | [GetImagePropertyOptions](#GetImagePropertyOptions) | 是 | 图片属性，包括图片序号与默认属性值。 |
| callback | AsyncCallback\<void> | 是 | 修改属性值，callback返回结果。 |
**示例：**
```js
let PropertyOptions = {
index:0,
defaultValue:'a'
imageSourceApi.modifyImageProperty("ImageWidth", "abc",PropertyOptions,() => {
};
```
### createPixelMap
createPixelMap(index: number, options: DecodingOptions, callback: AsyncCallback\<PixelMap>): void createPixelMap(index: number, options: DecodingOptions, callback: AsyncCallback\<PixelMap>): void
通过图片解码参数创建pixelmap对象，使用callback形式返回结果。 通过图片解码参数创建Pixelmap对象，使用callback形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------------ | ---- | -------------------- | | ------------- | ------------------------------------- | ---- | -------------------- |
| options | [DecodingOptions](#DecodingOptions) | 是 | 解码参数。 | | options | [DecodingOptions](#decodingoptions7) | 是 | 解码参数。 |
| index | number | 是 | 图片索引。 | | index | number | 是 | 图片索引。 |
| AsyncCallback | AsyncCallback<[PixelMap](#PixelMap)> | 是 | 回调表示成功或失败。 | | AsyncCallback | AsyncCallback<[PixelMap](#pixelmap7)> | 是 | 回调表示成功或失败。 |
**示例：** **示例：**
...@@ -917,7 +757,7 @@ imageSourceApi.createPixelMap().then(pixelmap => { ...@@ -917,7 +757,7 @@ imageSourceApi.createPixelMap().then(pixelmap => {
}) })
``` ```
### createPixelMap ### createPixelMap<sup>7+</sup>
createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): void createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): void
...@@ -927,10 +767,10 @@ createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): vo ...@@ -927,10 +767,10 @@ createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): vo
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| options | [DecodingOptions](#DecodingOptions) | 是 | 解码参数。 | | options | [DecodingOptions](#decodingoptions7) | 是 | 解码参数。 |
| callback | AsyncCallback<[PixelMap](#PixelMap)> | 是 | 回调表示成功或失败。 | | callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是 | 回调表示成功或失败。 |
**示例：** **示例：**
...@@ -950,7 +790,7 @@ let decodingOptions = { ...@@ -950,7 +790,7 @@ let decodingOptions = {
}) })
``` ```
### createPixelMap ### createPixelMap<sup>7+</sup>
createPixelMap(opts: DecodingOptions, callback: AsyncCallback\<PixelMap>): void createPixelMap(opts: DecodingOptions, callback: AsyncCallback\<PixelMap>): void
...@@ -960,10 +800,10 @@ createPixelMap(opts: DecodingOptions, callback: AsyncCallback\<PixelMap>): void ...@@ -960,10 +800,10 @@ createPixelMap(opts: DecodingOptions, callback: AsyncCallback\<PixelMap>): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| opts | [DecodingOptions](#DecodingOptions) | 是 | 解码参数。 | | opts | [DecodingOptions](#decodingoptions7) | 是 | 解码参数。 |
| callback | AsyncCallback<[PixelMap](#PixelMap)> | 是 | 回调表示成功或失败。 | | callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是 | 回调表示成功或失败。 |
**示例：** **示例：**
...@@ -981,103 +821,14 @@ let decodingOptions = { ...@@ -981,103 +821,14 @@ let decodingOptions = {
console.info('TC_050-1 createPixelMap '); console.info('TC_050-1 createPixelMap ');
expect(pixelmap !== null ).assertTrue(); expect(pixelmap !== null ).assertTrue();
done(); done();
}) })
```
### updateData
updateData(data: Array\<number>, isFinal: boolean, offset: number, length: number, callback: AsyncCallback\<boolean>): void
更新增量数据。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------- |
| data | Array\<number> | 是 | 增量数据。 |
| isFinal | boolean | 是 | 是否更新完。 |
| offset | number | 是 | 偏移量。 |
| length | number | 是 | 数组长。 |
| callback | AsyncCallback\<boolean> | 是 | 回调表示成功或失败。 |
**示例：**
```js
imageSourceIncrementalSApi.updateData(array, false, 0, 10,(error,data )=> {
if(data !== undefined){
expect(data).assertTrue();
console.info('TC_053-1 success');
done();
}
```
### updateData
updateData(data: Array\<number>, isFinal: boolean, offset?: number, length?: number): Promise\<boolean>
更新增量数据。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ------------ |
| data | Array\<number> | 是 | 增量数据。 |
| isFinal | boolean | 是 | 是否更新完。 |
| offset | boolean | 否 | 偏移量。 |
| length | number | 否 | 数组长。 |
**返回值：**
| 类型 | 说明 |
| ----------------- | --------------------------------- |
| Promise\<boolean> | Promise实例，异步返回成功或失败。 |
**示例：**
```js
imageSourceIncrementalSApi.updateData(array, false, 0, 10).then(data => {
expect(data).assertTrue();
console.info('TC_053 success');
done();
})
```
### updateData
updateData(data: Array\<number>, isFinal: boolean, callback: AsyncCallback\<boolean>): void
更新增量数据。
**系统能力：** SystemCapability.Multimedia.Image
**参数：**
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------- |
| data | Array\<number> | 是 | 增量数据。 |
| isFinal | boolean | 是 | 是否更新完。 |
| callback | AsyncCallback\<boolean> | 是 | 回调表示成功或失败。 |
**示例：**
```js
imageSourceIncrementalSApi.updateData(array, false,(error,data) => {
if(data !== undefined){
expect(data).assertTrue();
console.info('TC_053-2 success');
done();
}
``` ```
### release ### release
release(callback: AsyncCallback\<void>): void release(callback: AsyncCallback\<void>): void
释放图片源。 释放图片源实例，使用callback形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -1102,7 +853,7 @@ imageSourceApi.release(() => { ...@@ -1102,7 +853,7 @@ imageSourceApi.release(() => {
release(): Promise\<void> release(): Promise\<void>
释放图片源。 释放图片源实例，使用Promise形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -1126,15 +877,15 @@ release(): Promise\<void> ...@@ -1126,15 +877,15 @@ release(): Promise\<void>
createImagePacker(): ImagePacker createImagePacker(): ImagePacker
创建imagepacker实例。 创建ImagePacker实例。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------- | ----------------- | | ----------- | ---------------------- |
| ImagePacker | 返回ImagePacker。 | | ImagePacker | 返回ImagePackers实例。 |
**示例：** **示例：**
...@@ -1150,7 +901,7 @@ const imagePackerApi = image.createImagePacker(); ...@@ -1150,7 +901,7 @@ const imagePackerApi = image.createImagePacker();
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | | ---------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
| supportedFormats | Array\<string> | 是 | 否 | 图片打包支持的格式，jpg。<br/>**系统能力：** SystemCapability.Multimedia.Image | | supportedFormats | Array\<string> | 是 | 否 | 图片打包支持的格式，jpeg。<br/>**系统能力：** SystemCapability.Multimedia.Image |
### packing ### packing
...@@ -1164,8 +915,8 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra ...@@ -1164,8 +915,8 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------- | | -------- | ------------------------------- | ---- | ---------------------------------- |
| source | [ImageSource](#ImageSource) | 是 | 打包的图片源。 | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 |
| option | [PackingOption](#PackingOption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
| callback | AsyncCallback<Array\<number>> | 是 | 获取图片打包回调，返回打包后数据。 | | callback | AsyncCallback<Array\<number>> | 是 | 获取图片打包回调，返回打包后数据。 |
**示例：** **示例：**
...@@ -1183,7 +934,7 @@ let packOpts = { format:["image/jpeg"], quality:98 } ...@@ -1183,7 +934,7 @@ let packOpts = { format:["image/jpeg"], quality:98 }
packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> packing(source: ImageSource, option: PackingOption): Promise<Array\<number>>
图片压缩或重新打包，使用promise形式返回结果。 图片压缩或重新打包，使用Promise形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
...@@ -1191,8 +942,8 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> ...@@ -1191,8 +942,8 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------- | ---- | -------------- | | ------ | ------------------------------- | ---- | -------------- |
| source | [ImageSource](#ImageSource) | 是 | 打包的图片源。 | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 |
| option | [PackingOption](#PackingOption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
**返回值：** **返回值：**
...@@ -1216,15 +967,15 @@ let packOpts = { format:["image/jpeg"], quality:98 } ...@@ -1216,15 +967,15 @@ let packOpts = { format:["image/jpeg"], quality:98 }
release(callback: AsyncCallback\<void>): void release(callback: AsyncCallback\<void>): void
释放packer对象。 释放图片打包实例，使用callback形式返回结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------- | | -------- | -------------------- | ---- | ------------------------------ |
| callback | AsyncCallback\<void> | 是 | 回调表示成功还是失败。 | | callback | AsyncCallback\<void> | 是 | 释放回调，失败时返回错误信息。 |
**示例：** **示例：**
...@@ -1239,15 +990,15 @@ imagePackerApi.release(()=>{ ...@@ -1239,15 +990,15 @@ imagePackerApi.release(()=>{
release(): Promise\<void> release(): Promise\<void>
释放packer对象。 释放图片打包实例，使用Promise形式返回释放结果。
**系统能力：** SystemCapability.Multimedia.Image **系统能力：** SystemCapability.Multimedia.Image
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| :------------- | :------------------------------ | | :------------- | :------------------------------------------------------ |
| Promise\<void> | Promise实例，用于异步返回结果。 | | Promise\<void> | Promise实例，用于异步获取释放结果，失败时返回错误信息。 |
**示例：** **示例：**
...@@ -1258,128 +1009,150 @@ imagePackerApi.release(); ...@@ -1258,128 +1009,150 @@ imagePackerApi.release();
done(); done();
``` ```
## PositionArea<a name="PositionArea"></a> ## PositionArea<sup>7+</sup>
表示图片指定区域内的数据。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------------------ | ---- | ---- | -------------------- |
| pixels | ArrayBuffer | 是 | 否 | 像素。 |
| offset | number | 是 | 否 | 偏移量。 |
| stride | number | 是 | 否 | 像素间距。 |
| region | [Region](#region8) | 是 | 否 | 区域，按照区域读写。 |
| 名称 | 类型 | 可读 | 可写 | 说明 | ## **ImageInfo**
| ------ | ----------------- | ---- | ---- | ------------------------------------------------------------ |
| pixels | ArrayBuffer | 是 | 否 | 像素。<br>**系统能力：** SystemCapability.Multimedia.Image |
| offset | number | 是 | 否 | 偏移量。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| stride | number | 是 | 否 | 像素间距。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| region | [Region](#Region) | 是 | 否 | 区域，按照区域读写。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## **ImageInfo<a name="ImageInfo"></a>** 表示图片信息。
| 名称 | 类型 | 可读 | 可写 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| ----------- | --------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| size | [Size](#Size) | 是 | 是 | 图片大小。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| pixelFormat | [PixelMapFormat](#PixelMapFormat) | 是 | 是 | 图片格式。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| colorSpace | [ColorSpace](#ColorSpace) | 是 | 是 | 色域。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| alphaType | [AlphaType](#AlphaType) | 是 | 是 | 透明度。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## Size<a name="Size"></a> | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ------------- | ---- | ---- | ---------- |
| size | [Size](#size) | 是 | 是 | 图片大小。 |
| 名称 | 类型 | 可读 | 可写 | 说明 | ## Size
| ------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| height | number | 是 | 是 | 输出图片的高。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| width | number | 是 | 是 | 输出图片的宽。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## PixelMapFormat<a name="PixelMapFormat"></a> 表示图片尺寸。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | -------------- |
| height | number | 是 | 是 | 输出图片的高。 |
| width | number | 是 | 是 | 输出图片的宽。 |
## PixelMapFormat<sup>7+</sup>
枚举，像素格式。 枚举，像素格式。
| 名称 | 默认值 | 描述 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| --------- | ------ | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知格式。<br/>**系统能力：** SystemCapability.Multimedia.Image | | 名称 | 默认值 | 描述 |
| ARGB_8888 | 1 | 格式为ARGB_8888。<br/>**系统能力：** SystemCapability.Multimedia.Image | | --------- | ------ | ----------------- |
| RGB_565 | 2 | 格式为RGB_565。<br/>**系统能力：** SystemCapability.Multimedia.Image | | UNKNOWN | 0 | 未知格式。 |
| RGBA_8888 | 3 | 格式为RGBA_8888。 |
## ColorSpace<a name="ColorSpace"></a> | RGB_565 | 2 | 格式为RGB_565。 |
枚举，色块。 ## AlphaType<sup>8+</sup>
| 名称 | 默认值 | 描述 |
| -------------------- | ------ | ------------------------------------------------------------ |
| UNKNOWN | 0 | 色块基于unknown color space。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| DISPLAY_P3 | 1 | 色块基于 SMPTE RP 431-2-2007 and IEC 61966-2.1:199。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| SRGB | 2 | 色块基于IEC 61966-2.1:1999。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| LINEAR_SRGB | 3 | 色块基于the IEC 61966-2.1:1999。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| EXTENDED_SRGB | 4 | 色块基于IEC 61966-2-2:2003。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| LINEAR_EXTENDED_SRGB | 5 | 色块基于IEC 61966-2-2:2003。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| GENERIC_XYZ | 6 | 色块基于D50。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| GENERIC_LAB | 7 | 色块基于 CIE XYZ D50。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ACES | 8 | 色块基于SMPTE ST 2065-1:2012。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ACES_CG | 9 | 色块基于Academy S-2014-004。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ADOBE_RGB_1998 | 10 | 色块基于 Adobe RGB。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| DCI_P3 | 11 | 色块基于SMPTE RP 431-2-2007。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ITU_709 | 12 | 色块基于Rec.ITU-R BT.709-5。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ITU_2020 | 13 | 色块基于Rec.ITU-R BT.2020-1。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| ROMM_RGB | 14 | 色块基于ISO 22028-2:2013。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| NTSC_1953 | 15 | 色块基于NTSC 1953 standard。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| SMPTE_C | 16 | 色块基于 SMPTE C。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## AlphaType<a name="AlphaType"></a>
枚举，透明度。 枚举，透明度。
| 名称 | 默认值 | 描述 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| -------- | ------ | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知透明度。<br/>**系统能力：** SystemCapability.Multimedia.Image | | 名称 | 默认值 | 描述 |
| OPAQUE | 1 | 没有alpha或图片全透明。<br/>**系统能力：** SystemCapability.Multimedia.Image | | -------- | ------ | ----------------------- |
| PREMUL | 2 | RGB前乘alpha。<br/>**系统能力：** SystemCapability.Multimedia.Image | | UNKNOWN | 0 | 未知透明度。 |
| UNPREMUL | 3 | RGB不前乘alpha。<br/>**系统能力：** SystemCapability.Multimedia.Image | | OPAQUE | 1 | 没有alpha或图片全透明。 |
| PREMUL | 2 | RGB前乘alpha。 |
| UNPREMUL | 3 | RGB不前乘alpha。 |
## ScaleMode<a name="ScaleMode"></a> ## ScaleMode<sup>8+</sup>
枚举，缩略值。 枚举，缩略值。
| 名称 | 默认值 | 描述 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| --------------- | ------ | ------------------------------------------------------------ |
| CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| FIT_TARGET_SIZE | 2 | 图像适合目标尺寸的效果。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## InitializationOptions<a name="InitializationOptions"></a> | 名称 | 默认值 | 描述 |
| --------------- | ------ | -------------------------------------------------- |
| CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 |
| FIT_TARGET_SIZE | 2 | 图像适合目标尺寸的效果。 |
| 名称 | 类型 | 可读 | 可写 | 说明 | ## InitializationOptions<sup>8+</sup>
| ----------- | --------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| alphaType | [AlphaType](#AlphaType) | 是 | 是 | 透明度。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| editable | boolean | 是 | 是 | 是否可编辑。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| pixelFormat | [PixelMapFormat](#PixelMapFormat) | 是 | 是 | 像素格式。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| scalemode | [ScaleMode](#ScaleMode) | 是 | 是 | 缩略值。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| size | [Size](#Size) | 是 | 是 | 创建图片大小。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## DecodingOptions<a name="DecodingOptions"></a> **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ---------------------------------- | ---- | ---- | -------------- |
| alphaType | [AlphaType](#alphatype8) | 是 | 是 | 透明度。 |
| editable | boolean | 是 | 是 | 是否可编辑。 |
| pixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 像素格式。 |
| scaleMode | [ScaleMode](#scalemode8) | 是 | 是 | 缩略值。 |
| size | [Size](#size) | 是 | 是 | 创建图片大小。 |
## DecodingOptions<sup>7+</sup>
解码设置选项。 解码设置选项。
| 名称 | 类型 | 可读 | 可写 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| ------------------ | --------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| sampleSize | number | 是 | 是 | 缩略图采样大小。<br/>**系统能力：** SystemCapability.Multimedia.Image | | 名称 | 类型 | 可读 | 可写 | 说明 |
| rotateDegrees | number | 是 | 是 | 旋转角度。<br/>**系统能力：** SystemCapability.Multimedia.Image | | ------------------ | ---------------------------------- | ---- | ---- | ---------------- |
| editable | boolean | 是 | 是 | 是否可编辑。<br/>**系统能力：** SystemCapability.Multimedia.Image | | sampleSize | number | 是 | 是 | 缩略图采样大小。 |
| desiredSize | [Size](#Size) | 是 | 是 | 期望输出大小。<br/>**系统能力：** SystemCapability.Multimedia.Image | | rotateDegrees | number | 是 | 是 | 旋转角度。 |
| desiredRegion | [Region](#Region) | 是 | 是 | 解码区域。<br/>**系统能力：** SystemCapability.Multimedia.Image | | editable | boolean | 是 | 是 | 是否可编辑。 |
| desiredPixelFormat | [PixelMapFormat](#PixelMapFormat) | 是 | 是 | 解码的像素格式。<br/>**系统能力：** SystemCapability.Multimedia.Image | | desiredSize | [Size](#size) | 是 | 是 | 期望输出大小。 |
| reusedPixelMap | [PixelMap](#PixelMap) | 是 | 是 | 将当前buffer地址给新创建的pixelmap。<br/>**系统能力：** SystemCapability.Multimedia.Image | | desiredRegion | [Region](#region8) | 是 | 是 | 解码区域。 |
| desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 解码的像素格式。 |
## Region<a name="Region"></a> | index | numer | 是 | 是 | 解码图片序号 |
| 名称 | 类型 | 可读 | 可写 | 说明 | ## Region<sup>8+</sup>
| ---- | ------------- | ---- | ---- | ------------------------------------------------------------ |
| size | [Size](#Size) | 是 | 是 | 区域大小。<br/>**系统能力：** SystemCapability.Multimedia.Image | 表示区域信息。
| x | number | 是 | 是 | 区域坐标。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| y | number | 是 | 是 | 区域坐标。<br/>**系统能力：** SystemCapability.Multimedia.Image | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
## PackingOption<a name="PackingOption"></a> | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ------------- | ---- | ---- | ---------- |
| 名称 | 类型 | 可读 | 可写 | 说明 | | size | [Size](#size) | 是 | 是 | 区域大小。 |
| ------- | ------ | ---- | ---- | ------------------------------------------------------------ | | x | number | 是 | 是 | 区域坐标。 |
| format | string | 是 | 是 | 目标格式。<br/>**系统能力：** SystemCapability.Multimedia.Image | | y | number | 是 | 是 | 区域坐标。 |
| quality | number | 是 | 是 | 目标图片质量。<br/>**系统能力：** SystemCapability.Multimedia.Image |
## PackingOption
## GetImagePropertyOptions<a name="GetImagePropertyOptions"></a>
表示图片打包选项。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ---------- | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| index | number | 是 | 是 | 图片序号。<br/>**系统能力：** SystemCapability.Multimedia.Image |
| defaultValue | string | 是 | 是 | 默认属性值<br/>**系统能力：** SystemCapability.Multimedia.Image | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------ | ---- | ---- | -------------- |
| format | string | 是 | 是 | 目标格式。 |
| quality | number | 是 | 是 | 目标图片质量。 |
## GetImagePropertyOptions<sup>7+</sup>
表示查询图片属性的索引。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------------ |
| index | number | 是 | 是 | 图片序号。 |
| defaultValue | string | 是 | 是 | 默认属性值。 |
## PropertyKey<sup>7+</sup>
枚举，Exif（Exchangeable image file format）图片信息。
| 名称 | 默认值 | 说明 |
| ----------------- | ----------------- | -------------------- |
| 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。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或