js-apis-image.md 54.2 KB
Newer Older
Z
zengyawen 已提交
1
# 图片处理
X
xiaok 已提交
2

Z
zengyawen 已提交
3
> **说明:**
H
update  
HelloCrease 已提交
4
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
5

Z
zengyawen 已提交
6
## 导入模块
X
xiaok 已提交
7

Z
zengyawen 已提交
8
```js
Z
zengyawen 已提交
9
import image from '@ohos.multimedia.image';
X
xiaok 已提交
10 11
```

Z
zengyawen 已提交
12
## image.createPixelMap<sup>8+</sup>
13
createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise\<PixelMap>
X
xiaok 已提交
14

Z
zengyawen 已提交
15
通过属性创建PixelMap,通过Promise返回结果。
X
xiaok 已提交
16 17 18 19 20

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

H
update  
HelloCrease 已提交
21 22
| 名称    | 类型                                             | 必填 | 说明                                                         |
| ------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ |
X
xu-rui-w 已提交
23
| colors  | ArrayBuffer                                      | 是   | BGRA_8888格式的颜色数组。                                    |
24
| options | [InitializationOptions](#initializationoptions8) | 是   | 创建像素的属性,包括透明度,尺寸,缩略值,像素格式和是否可编辑。 |
X
xiaok 已提交
25 26 27

**返回值:**

Z
zengyawen 已提交
28 29
| 类型                             | 说明           |
| -------------------------------- | -------------- |
Z
zengyawen 已提交
30
| Promise\<[PixelMap](#pixelmap7)> | 返回Pixelmap。 |
X
xiaok 已提交
31 32 33 34

**示例:**

```js
X
xu-rui-w 已提交
35
const color = new ArrayBuffer(96);
X
xu-rui-w 已提交
36
let bufferArr = new Unit8Array(color);
X
xu-rui-w 已提交
37 38 39 40
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts)
    .then((pixelmap) => {
        })
X
xiaok 已提交
41 42
```

Z
zengyawen 已提交
43
## image.createPixelMap<sup>8+</sup>
X
xiaok 已提交
44

45
createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback\<PixelMap>): void
X
xiaok 已提交
46

Z
zengyawen 已提交
47
通过属性创建PixelMap,通过回调函数返回结果。
X
xiaok 已提交
48 49 50 51 52

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
53 54
| 名称     | 类型                                             | 必填 | 说明                       |
| -------- | ------------------------------------------------ | ---- | -------------------------- |
X
xu-rui-w 已提交
55
| colors   | ArrayBuffer                                      | 是   | BGRA_8888格式的颜色数组。  |
56
| options  | [InitializationOptions](#initializationoptions8) | 是   | 属性。                     |
Z
zengyawen 已提交
57
| callback | AsyncCallback\<[PixelMap](#pixelmap7)>           | 是   | 通过回调返回PixelMap对象。 |
X
xiaok 已提交
58 59 60 61

**示例:**

```js
X
xu-rui-w 已提交
62
const color = new ArrayBuffer(96);
X
xu-rui-w 已提交
63
let bufferArr = new Unit8Array(color);
X
xu-rui-w 已提交
64 65 66
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => {
        })
X
xiaok 已提交
67 68
```

Z
zengyawen 已提交
69
## PixelMap<sup>7+</sup>
Z
zengyawen 已提交
70 71 72 73 74

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

 ### 属性

Z
zengyawen 已提交
75
**系统能力:** SystemCapability.Multimedia.Image
Z
zhang-xiaobo1997 已提交
76 77 78 79

| 名称                    | 类型    | 可读 | 可写 | 说明                       |
| ----------------------- | ------- | ---- | ---- | -------------------------- |
| isEditable<sup>7+</sup> | boolean | 是   | 否   | 设定是否图像像素可被编辑。 |
Z
zengyawen 已提交
80

Z
zengyawen 已提交
81
### readPixelsToBuffer<sup>7+</sup>
X
xiaok 已提交
82

Z
zengyawen 已提交
83
readPixelsToBuffer(dst: ArrayBuffer): Promise\<void>
X
xiaok 已提交
84 85 86 87 88 89 90 91 92 93 94 95 96

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

| 参数名 | 类型        | 必填 | 说明                                                         |
| ------ | ----------- | ---- | ------------------------------------------------------------ |
| dst    | ArrayBuffer | 是   | 缓冲区,函数执行结束后获取的图像像素数据写入到该内存区域内。 |

**返回值:**

Z
zengyawen 已提交
97 98 99
| 类型           | 说明                                            |
| :------------- | :---------------------------------------------- |
| Promise\<void> | Promise实例,用于获取结果,失败时返回错误信息。 |
X
xiaok 已提交
100 101 102 103

**示例:**

```js
X
xu-rui-w 已提交
104 105 106 107 108
pixelmap.readPixelsToBuffer(ReadBuffer).then(() => {
    console.log('readPixelsToBuffer succeeded.');  //符合条件则进入 
}).catch(error => {
    console.log('readPixelsToBuffer failed.');  //不符合条件则进入
})
X
xiaok 已提交
109 110
```

Z
zengyawen 已提交
111
### readPixelsToBuffer<sup>7+</sup>
X
xiaok 已提交
112

Z
zengyawen 已提交
113
readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\<void>): void
X
xiaok 已提交
114

Z
zengyawen 已提交
115
读取图像像素数据,结果写入ArrayBuffer里,使用callback形式返回。
X
xiaok 已提交
116 117 118 119 120

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
121 122 123 124
| 参数名   | 类型                 | 必填 | 说明                                                         |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| dst      | ArrayBuffer          | 是   | 缓冲区,函数执行结束后获取的图像像素数据写入到该内存区域内。 |
| callback | AsyncCallback\<void> | 是   | 获取回调,失败时返回错误信息。                               |
X
xiaok 已提交
125 126 127 128

**示例:**

```js
X
xu-rui-w 已提交
129 130 131 132 133 134 135
pixelmap.readPixelsToBuffer(ReadBuffer, (err, res) => {
    if(err) {
        console.log('readPixelsToBuffer failed.');  //不符合条件则进入
    } else {
        console.log('readPixelsToBuffer succeeded.');  //符合条件则进入
    }
})
X
xiaok 已提交
136 137
```

Z
zengyawen 已提交
138
### readPixels<sup>7+</sup>
X
xiaok 已提交
139

Z
zengyawen 已提交
140
readPixels(area: PositionArea): Promise\<void>
X
xiaok 已提交
141 142 143 144 145 146 147

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
148 149 150
| 参数名 | 类型                           | 必填 | 说明                     |
| ------ | ------------------------------ | ---- | ------------------------ |
| area   | [PositionArea](#positionarea7) | 是   | 区域大小,根据区域读取。 |
X
xiaok 已提交
151 152 153

**返回值:**

Z
zengyawen 已提交
154 155 156
| 类型           | 说明                                                |
| :------------- | :-------------------------------------------------- |
| Promise\<void> | Promise实例,用于获取读取结果,失败时返回错误信息。 |
X
xiaok 已提交
157 158 159 160

**示例:**

```js
X
xu-rui-w 已提交
161 162 163 164 165
pixelmap.readPixels(Area).then((data) => {
    console.log('readPixels succeeded.'); //符合条件则进入
}).catch(error => {
    console.log('readPixels failed.'); //不符合条件则进入
})
X
xiaok 已提交
166 167
```

Z
zengyawen 已提交
168
### readPixels<sup>7+</sup>
X
xiaok 已提交
169

Z
zengyawen 已提交
170
readPixels(area: PositionArea, callback: AsyncCallback\<void>): void
X
xiaok 已提交
171

Z
zengyawen 已提交
172
读取区域内的图片数据,使用callback形式返回读取结果。
X
xiaok 已提交
173 174 175 176 177

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
178 179 180 181
| 参数名   | 类型                           | 必填 | 说明                           |
| -------- | ------------------------------ | ---- | ------------------------------ |
| area     | [PositionArea](#positionarea7) | 是   | 区域大小,根据区域读取。       |
| callback | AsyncCallback\<void>           | 是   | 获取回调,失败时返回错误信息。 |
X
xiaok 已提交
182 183 184 185

**示例:**

```js
X
xu-rui-w 已提交
186 187
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
188 189
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err, pixelmap) => {
X
xu-rui-w 已提交
190 191 192 193 194 195 196 197 198 199 200
    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');
        })
    }
201
})
X
xiaok 已提交
202 203
```

Z
zengyawen 已提交
204
### writePixels<sup>7+</sup>
X
xiaok 已提交
205

Z
zengyawen 已提交
206
writePixels(area: PositionArea): Promise\<void>
X
xiaok 已提交
207

208
将PixelMap写入指定区域内,使用Promise形式返回写入结果。
X
xiaok 已提交
209 210 211 212 213

**系统能力:** SystemCapability.Multimedia.Image

**参数:** 

Z
zengyawen 已提交
214 215
| 参数名 | 类型                           | 必填 | 说明                 |
| ------ | ------------------------------ | ---- | -------------------- |
Z
zengyawen 已提交
216
| area   | [PositionArea](#positionarea7) | 是   | 区域,根据区域写入。 |
X
xiaok 已提交
217 218 219

**返回值:**

Z
zengyawen 已提交
220 221 222
| 类型           | 说明                                                |
| :------------- | :-------------------------------------------------- |
| Promise\<void> | Promise实例,用于获取写入结果,失败时返回错误信息。 |
X
xiaok 已提交
223 224 225 226

**示例:**

```js
227
const color = new ArrayBuffer(96);
X
xu-rui-w 已提交
228
let bufferArr = new Unit8Array(color);
229 230 231 232
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts)
    .then( pixelmap => {
        if (pixelmap == undefined) {
X
xu-rui-w 已提交
233
            console.info('createPixelMap failed.');
234 235 236 237 238 239
        }
        const area = { pixels: new ArrayBuffer(8),
            offset: 0,
            stride: 8,
            region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
        }
X
xu-rui-w 已提交
240
        let bufferArr = new Uint8Array(area.pixels);
241 242 243 244 245 246 247 248 249 250 251 252
        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 }
            }        
        })
X
xu-rui-w 已提交
253
    }).catch(error => {
254 255
        console.log('error: ' + error);
    })
X
xiaok 已提交
256 257
```

Z
zengyawen 已提交
258
### writePixels<sup>7+</sup>
X
xiaok 已提交
259

Z
zengyawen 已提交
260
writePixels(area: PositionArea, callback: AsyncCallback\<void>): void
X
xiaok 已提交
261

262
将PixelMap写入指定区域内,使用callback形式返回写入结果。
X
xiaok 已提交
263 264 265 266 267

**系统能力:** SystemCapability.Multimedia.Image

**参数:** 

Z
zengyawen 已提交
268 269
| 参数名    | 类型                           | 必填 | 说明                           |
| --------- | ------------------------------ | ---- | ------------------------------ |
Z
zengyawen 已提交
270
| area      | [PositionArea](#positionarea7) | 是   | 区域,根据区域写入。           |
X
xu-rui-w 已提交
271
| callback: | AsyncCallback\<void>           | 是   | 获取回调,失败时返回错误信息。 |
X
xiaok 已提交
272 273 274 275

**示例:**

```js
X
xu-rui-w 已提交
276 277 278 279 280 281 282 283 284 285 286
pixelmap.writePixels(Area, (error) => {
    if (error!=undefined) {
		console.info('writePixels failed.');
	} else {
	    const readArea = {
            pixels: new ArrayBuffer(20),
            offset: 0,
            stride: 8,
            region: { size: { height: 1, width: 2 }, x: 0, y: 0 },
        }
	}
X
xu-rui-w 已提交
287
})
X
xiaok 已提交
288 289
```

Z
zengyawen 已提交
290
### writeBufferToPixels<sup>7+</sup>
X
xiaok 已提交
291

Z
zengyawen 已提交
292
writeBufferToPixels(src: ArrayBuffer): Promise\<void>
X
xiaok 已提交
293

294
读取缓冲区中的图片数据,结果写入PixelMap中,使用Promise形式返回。
X
xiaok 已提交
295 296 297 298 299

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
300 301 302
| 参数名 | 类型        | 必填 | 说明           |
| ------ | ----------- | ---- | -------------- |
| src    | ArrayBuffer | 是   | 图像像素数据。 |
X
xiaok 已提交
303 304 305

**返回值:**

Z
zengyawen 已提交
306 307 308
| 类型           | 说明                                            |
| -------------- | ----------------------------------------------- |
| Promise\<void> | Promise实例,用于获取结果,失败时返回错误信息。 |
X
xiaok 已提交
309 310 311 312

**示例:**

```js
X
xu-rui-w 已提交
313 314
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
X
xu-rui-w 已提交
315
PixelMap.writeBufferToPixels(color).then(() => {
X
xiaok 已提交
316 317 318
    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.");
X
xu-rui-w 已提交
319
})
X
xiaok 已提交
320 321
```

Z
zengyawen 已提交
322
### writeBufferToPixels<sup>7+</sup>
X
xiaok 已提交
323

Z
zengyawen 已提交
324
writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void
X
xiaok 已提交
325

326
读取缓冲区中的图片数据,结果写入PixelMap中,使用callback形式返回。
X
xiaok 已提交
327 328 329 330 331

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
332 333 334 335
| 参数名   | 类型                 | 必填 | 说明                           |
| -------- | -------------------- | ---- | ------------------------------ |
| src      | ArrayBuffer          | 是   | 图像像素数据。                 |
| callback | AsyncCallback\<void> | 是   | 获取回调,失败时返回错误信息。 |
X
xiaok 已提交
336 337 338 339

**示例:**

```js
X
xu-rui-w 已提交
340 341
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
X
xu-rui-w 已提交
342
PixelMap.writeBufferToPixels(color, function(err) {
X
xiaok 已提交
343 344 345
    if (err) {
        console.error("Failed to write data from a buffer to a PixelMap.");
        return;
X
xu-rui-w 已提交
346 347 348
    } else {
		console.log("Succeeded in writing data from a buffer to a PixelMap.");
	}
X
xiaok 已提交
349 350 351
});
```

Z
zengyawen 已提交
352
### getImageInfo<sup>7+</sup>
X
xiaok 已提交
353

Z
zengyawen 已提交
354
getImageInfo(): Promise\<ImageInfo>
X
xiaok 已提交
355 356 357 358 359 360 361

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

**系统能力:** SystemCapability.Multimedia.Image

**返回值:**

Z
zengyawen 已提交
362 363 364
| 类型                              | 说明                                                        |
| --------------------------------- | ----------------------------------------------------------- |
| Promise\<[ImageInfo](#imageinfo)> | Promise实例,用于异步获取图像像素信息,失败时返回错误信息。 |
X
xiaok 已提交
365 366 367 368

**示例:**

```js
X
xu-rui-w 已提交
369
PixelMap.getImageInfo().then(function(info) {
X
xiaok 已提交
370 371 372 373 374 375
    console.log("Succeeded in obtaining the image pixel map information.");
}).catch((err) => {
    console.error("Failed to obtain the image pixel map information.");
});
```

Z
zengyawen 已提交
376
### getImageInfo<sup>7+</sup>
X
xiaok 已提交
377

Z
zengyawen 已提交
378
getImageInfo(callback: AsyncCallback\<ImageInfo>): void
X
xiaok 已提交
379 380 381 382 383 384 385

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
386 387 388
| 参数名   | 类型                                    | 必填 | 说明                                                         |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<[ImageInfo](#imageinfo)> | 是   | 获取图像像素信息回调,异步返回图像像素信息,失败时返回错误信息。 |
X
xiaok 已提交
389 390 391 392

**示例:**

```js
X
xu-rui-w 已提交
393 394 395 396 397
pixelmap.getImageInfo((imageInfo) => { 
    console.log("getImageInfo succeeded.");
}).catch((err) => {
    console.error("getImageInfo failed.");
})
X
xiaok 已提交
398 399
```

Z
zengyawen 已提交
400
### getBytesNumberPerRow<sup>7+</sup>
X
xiaok 已提交
401

Z
zengyawen 已提交
402
getBytesNumberPerRow(): number
X
xiaok 已提交
403 404 405 406 407 408 409

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

**系统能力:** SystemCapability.Multimedia.Image

**返回值:**

Z
zengyawen 已提交
410 411 412
| 类型   | 说明                 |
| ------ | -------------------- |
| number | 图像像素的行字节数。 |
X
xiaok 已提交
413 414 415 416

**示例:**

```js
X
xu-rui-w 已提交
417 418 419
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
X
xu-rui-w 已提交
420 421 422
image.createPixelMap(clolr, opts, (err,pixelmap) => {
    let rowCount = pixelmap.getBytesNumberPerRow();
})
X
xiaok 已提交
423 424
```

Z
zengyawen 已提交
425
### getPixelBytesNumber<sup>7+</sup>
X
xiaok 已提交
426

Z
zengyawen 已提交
427
getPixelBytesNumber(): number
X
xiaok 已提交
428 429 430 431 432 433 434

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

**系统能力:** SystemCapability.Multimedia.Image

**返回值:**

Z
zengyawen 已提交
435 436 437
| 类型   | 说明                 |
| ------ | -------------------- |
| number | 图像像素的总字节数。 |
X
xiaok 已提交
438 439 440 441

**示例:**

```js
X
xu-rui-w 已提交
442
let pixelBytesNumber = pixelmap.getPixelBytesNumber();
X
xiaok 已提交
443 444
```

Z
zengyawen 已提交
445
### release<sup>7+</sup>
X
xiaok 已提交
446

Z
zengyawen 已提交
447
release():Promise\<void>
X
xiaok 已提交
448

449
释放PixelMap对象,使用Promise形式返回释放结果。
X
xiaok 已提交
450 451 452

**系统能力:** SystemCapability.Multimedia.Image

Z
zengyawen 已提交
453
**返回值:**
X
xiaok 已提交
454

Z
zengyawen 已提交
455 456 457
| 类型           | 说明               |
| -------------- | ------------------ |
| Promise\<void> | 异步返回释放结果。 |
X
xiaok 已提交
458 459 460 461

**示例:**

```js
X
xu-rui-w 已提交
462 463 464
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
X
xu-rui-w 已提交
465 466 467 468 469 470 471
image.createPixelMap(color, opts, (pixelmap) => {
    pixelmap.release().then(() => {
	    console.log('release succeeded.');
    }).catch(error => {
	    console.log('release failed.');
    })
})
X
xiaok 已提交
472 473
```

Z
zengyawen 已提交
474
### release<sup>7+</sup>
X
xiaok 已提交
475

Z
zengyawen 已提交
476
release(callback: AsyncCallback\<void>): void
X
xiaok 已提交
477

478
释放PixelMap对象,使用callback形式返回释放结果。
X
xiaok 已提交
479 480 481 482 483

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
484 485 486
| 名称     | 类型                 | 必填 | 说明               |
| -------- | -------------------- | ---- | ------------------ |
| callback | AsyncCallback\<void> | 是   | 异步返回释放结果。 |
X
xiaok 已提交
487 488 489 490

**示例:**

```js
X
xu-rui-w 已提交
491 492 493
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
X
xu-rui-w 已提交
494 495 496 497 498 499 500
image.createPixelMap(color, opts, (pixelmap) => {
    pixelmap.release().then(() => {
	    console.log('release succeeded.');
    }).catch(error => {
	    console.log('release failed.');
    })
})
X
xiaok 已提交
501 502
```

Z
zengyawen 已提交
503
## image.createImageSource
X
xiaok 已提交
504

Z
zengyawen 已提交
505
createImageSource(uri: string): ImageSource
X
xiaok 已提交
506

Z
zengyawen 已提交
507
通过传入的uri创建图片源实例。
X
xiaok 已提交
508 509 510 511 512

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
513 514
| 参数名 | 类型   | 必填 | 说明                               |
| ------ | ------ | ---- | ---------------------------------- |
Z
zhang-xiaobo1997 已提交
515
| uri    | string | 是   | 图片路径,当前仅支持应用沙箱路径。 |
X
xiaok 已提交
516 517 518

**返回值:**

519 520 521
| 类型                        | 说明                                         |
| --------------------------- | -------------------------------------------- |
| [ImageSource](#imagesource) | 返回ImageSource类实例,失败时返回undefined。 |
X
xiaok 已提交
522 523 524 525

**示例:**

```js
Z
zhang-xiaobo1997 已提交
526 527
let path = this.context.getApplicationContext().fileDirs + "test.jpg";
const imageSourceApi = image.createImageSource(path);
X
xiaok 已提交
528 529
```

Z
zengyawen 已提交
530
## image.createImageSource<sup>7+</sup>
X
xiaok 已提交
531

Z
zengyawen 已提交
532
createImageSource(fd: number): ImageSource
X
xiaok 已提交
533

Z
zengyawen 已提交
534
通过传入文件描述符来创建图片源实例。
X
xiaok 已提交
535 536 537 538 539

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
540 541 542
| 参数名 | 类型   | 必填 | 说明           |
| ------ | ------ | ---- | -------------- |
| fd     | number | 是   | 文件描述符fd。 |
X
xiaok 已提交
543 544 545

**返回值:**

546 547 548
| 类型                        | 说明                                         |
| --------------------------- | -------------------------------------------- |
| [ImageSource](#imagesource) | 返回ImageSource类实例,失败时返回undefined。 |
X
xiaok 已提交
549 550 551 552

**示例:**

```js
X
xu-rui-w 已提交
553
const imageSourceApi = image.createImageSource(0);
X
xiaok 已提交
554 555
```

Z
zengyawen 已提交
556
## ImageSource
X
xiaok 已提交
557

Z
zengyawen 已提交
558 559 560 561
图片源类,用于获取图片相关信息。在调用ImageSource的方法前,需要先通过createImageSource构建一个ImageSource实例。

### 属性

Z
zengyawen 已提交
562
**系统能力:** SystemCapability.Multimedia.Image
Z
zhang-xiaobo1997 已提交
563

Z
zengyawen 已提交
564 565
| 名称             | 类型           | 可读 | 可写 | 说明                                                         |
| ---------------- | -------------- | ---- | ---- | ------------------------------------------------------------ |
Z
zhang-xiaobo1997 已提交
566
| supportedFormats | Array\<string> | 是   | 否   | 支持的图片格式,包括:png,jpeg,wbmp,bmp,gif,webp,heif等。 |
Z
zengyawen 已提交
567 568 569 570

### getImageInfo

getImageInfo(index: number, callback: AsyncCallback\<ImageInfo>): void
X
xiaok 已提交
571 572 573 574 575 576 577

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
578 579 580 581
| 参数名   | 类型                                   | 必填 | 说明                                     |
| -------- | -------------------------------------- | ---- | ---------------------------------------- |
| index    | number                                 | 是   | 创建图片源时的序号。                     |
| callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是   | 获取图片信息回调,异步返回图片信息对象。 |
X
xiaok 已提交
582 583 584 585

**示例:**

```js
X
xu-rui-w 已提交
586 587 588 589 590 591 592
imageSourceApi.getImageInfo(0,(error, imageInfo) => { 
    if(error) {
        console.log('getImageInfo failed.');
    } else {
        console.log('getImageInfo succeeded.');
    }
})
X
xiaok 已提交
593 594
```

Z
zengyawen 已提交
595
### getImageInfo
X
xiaok 已提交
596

Z
zengyawen 已提交
597
getImageInfo(callback: AsyncCallback\<ImageInfo>): void
X
xiaok 已提交
598

Z
zengyawen 已提交
599
获取图片信息,使用callback形式返回图片信息。
X
xiaok 已提交
600 601 602 603 604 605 606

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

| 名称     | 类型                                   | 必填 | 说明                                     |
| -------- | -------------------------------------- | ---- | ---------------------------------------- |
Z
zengyawen 已提交
607
| callback | AsyncCallback<[ImageInfo](#imageinfo)> | 是   | 获取图片信息回调,异步返回图片信息对象。 |
X
xiaok 已提交
608 609 610 611

**示例:**

```js
X
xu-rui-w 已提交
612 613 614 615 616
imageSourceApi.getImageInfo(imageInfo => { 
    console.log('getImageInfo succeeded.');
}).catch(error => {
	console.log('getImageInfo failed.');
})
X
xiaok 已提交
617 618
```

Z
zengyawen 已提交
619
### getImageInfo
X
xiaok 已提交
620

Z
zengyawen 已提交
621
getImageInfo(index?: number): Promise\<ImageInfo>
X
xiaok 已提交
622 623 624 625 626 627 628

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
629 630 631
| 名称  | 类型   | 必填 | 说明                                  |
| ----- | ------ | ---- | ------------------------------------- |
| index | number | 否   | 创建图片源时的序号,不选择时默认为0。 |
X
xiaok 已提交
632 633 634

**返回值:**

Z
zengyawen 已提交
635 636 637
| 类型                             | 说明                   |
| -------------------------------- | ---------------------- |
| Promise<[ImageInfo](#imageinfo)> | 返回获取到的图片信息。 |
X
xiaok 已提交
638 639 640 641 642

**示例:**

```js
imageSourceApi.getImageInfo(0)
X
xu-rui-w 已提交
643 644
    .then(imageInfo => {
		console.log('getImageInfo succeeded.');
X
xu-rui-w 已提交
645
	}).catch(error => {
X
xu-rui-w 已提交
646 647
		console.log('getImageInfo failed.');
	})
X
xiaok 已提交
648 649
```

Z
zengyawen 已提交
650
### getImageProperty<sup>7+</sup>
X
xiaok 已提交
651

Z
zengyawen 已提交
652
getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\<string>
X
xiaok 已提交
653

Z
zengyawen 已提交
654
获取图片中给定索引处图像的指定属性键的值,用Promise形式返回结果。
X
xiaok 已提交
655 656 657 658 659

**系统能力:** SystemCapability.Multimedia.Image

 **参数:**

Z
zengyawen 已提交
660 661 662 663
| 名称    | 类型                                                 | 必填 | 说明                                 |
| ------- | ---------------------------------------------------- | ---- | ------------------------------------ |
| key     | string                                               | 是   | 图片属性名。                         |
| options | [GetImagePropertyOptions](#getimagepropertyoptions7) | 否   | 图片属性,包括图片序号与默认属性值。 |
X
xiaok 已提交
664 665 666

**返回值:**

Z
zengyawen 已提交
667 668 669
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise\<string> | Promise实例,用于异步获取图片属性值,如获取失败则返回属性默认值。 |
X
xiaok 已提交
670 671 672 673

**示例:**

```js
674
imageSourceApi.getImageProperty("BitsPerSample")
X
xu-rui-w 已提交
675 676
    .then(data => {
		console.log('getImageProperty succeeded.');
X
xu-rui-w 已提交
677
	}).catch(error => {
X
xu-rui-w 已提交
678 679
		console.log('getImageProperty failed.');
	})
X
xiaok 已提交
680 681
```

Z
zengyawen 已提交
682
### getImageProperty<sup>7+</sup>
X
xiaok 已提交
683

Z
zengyawen 已提交
684
getImageProperty(key:string, callback: AsyncCallback\<string>): void
X
xiaok 已提交
685

Z
zengyawen 已提交
686
获取图片中给定索引处图像的指定属性键的值,用callback形式返回结果。
X
xiaok 已提交
687 688 689 690 691

**系统能力:** SystemCapability.Multimedia.Image

 **参数:**

Z
zengyawen 已提交
692 693 694 695
| 参数名   | 类型                   | 必填 | 说明                                                         |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| key      | string                 | 是   | 图片属性名。                                                 |
| callback | AsyncCallback\<string> | 是   | 获取图片属性回调,返回图片属性值,如获取失败则返回属性默认值。 |
X
xiaok 已提交
696 697 698 699

**示例:**

```js
X
xu-rui-w 已提交
700 701 702 703 704 705 706
imageSourceApi.getImageProperty("BitsPerSample",(error,data) => { 
    if(error) {
        console.log('getImageProperty failed.');
    } else {
        console.log('getImageProperty succeeded.');
    }
})
X
xiaok 已提交
707 708
```

Z
zengyawen 已提交
709
### getImageProperty<sup>7+</sup>
X
xiaok 已提交
710

Z
zengyawen 已提交
711
getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCallback\<string>): void
X
xiaok 已提交
712 713 714 715 716 717 718

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
719 720 721 722 723
| 参数名   | 类型                                                 | 必填 | 说明                                                         |
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| key      | string                                               | 是   | 图片属性名。                                                 |
| options  | [GetImagePropertyOptions](#getimagepropertyoptions7) | 是   | 图片属性,包括图片序号与默认属性值。                         |
| callback | AsyncCallback\<string>                               | 是   | 获取图片属性回调,返回图片属性值,如获取失败则返回属性默认值。 |
X
xiaok 已提交
724 725 726 727

**示例:**

```js
X
xu-rui-w 已提交
728 729 730 731 732 733 734
imageSourceApi.getImageProperty("BitsPerSample",Property,(error,data) => { 
    if(error) {
        console.log('getImageProperty failed.');
    } else {
        console.log('getImageProperty succeeded.');
    }
})
X
xiaok 已提交
735 736
```

Z
zengyawen 已提交
737
### createPixelMap<sup>7+</sup>
X
xiaok 已提交
738

Z
zengyawen 已提交
739
createPixelMap(options?: DecodingOptions): Promise\<PixelMap>
X
xiaok 已提交
740

741
通过图片解码参数创建PixelMap对象。
X
xiaok 已提交
742 743 744 745 746

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
747 748 749 750 751 752 753 754 755
| 名称    | 类型                                 | 必填 | 说明       |
| ------- | ------------------------------------ | ---- | ---------- |
| options | [DecodingOptions](#decodingoptions7) | 否   | 解码参数。 |

**返回值:**

| 类型                             | 说明                  |
| -------------------------------- | --------------------- |
| Promise\<[PixelMap](#pixelmap7)> | 异步返回Promise对象。 |
X
xiaok 已提交
756 757 758 759

**示例:**

```js
X
xu-rui-w 已提交
760 761 762 763 764
imageSourceApi.createPixelMap().then(pixelmap => {
    console.log('createPixelMap succeeded.');
}).catch(error => {
    console.log('createPixelMap failed.');
})
X
xiaok 已提交
765 766
```

Z
zengyawen 已提交
767
### createPixelMap<sup>7+</sup>
X
xiaok 已提交
768

Z
zengyawen 已提交
769
createPixelMap(callback: AsyncCallback\<PixelMap>): void
X
xiaok 已提交
770

771
通过默认参数创建PixelMap对象,使用callback形式返回结果。
X
xiaok 已提交
772 773 774 775 776

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
777 778 779
| 名称     | 类型                                  | 必填 | 说明                       |
| -------- | ------------------------------------- | ---- | -------------------------- |
| callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是   | 通过回调返回PixelMap对象。 |
X
xiaok 已提交
780 781 782 783

**示例:**

```js
X
xu-rui-w 已提交
784 785 786 787 788
imageSourceApi.createPixelMap(pixelmap => { 
    console.log('createPixelMap succeeded.');
}).catch(error => {
    console.log('createPixelMap failed.');
})
X
xiaok 已提交
789 790
```

Z
zengyawen 已提交
791
### createPixelMap<sup>7+</sup>
X
xiaok 已提交
792

Z
zengyawen 已提交
793
createPixelMap(options: DecodingOptions, callback: AsyncCallback\<PixelMap>): void
X
xiaok 已提交
794

Z
zengyawen 已提交
795
通过图片解码参数创建PixelMap对象。
X
xiaok 已提交
796 797 798 799 800

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
801 802
| 名称     | 类型                                  | 必填 | 说明                       |
| -------- | ------------------------------------- | ---- | -------------------------- |
803
| options  | [DecodingOptions](#decodingoptions7)  | 是   | 解码参数。                 |
Z
zengyawen 已提交
804
| callback | AsyncCallback<[PixelMap](#pixelmap7)> | 是   | 通过回调返回PixelMap对象。 |
X
xiaok 已提交
805 806 807 808

**示例:**

```js
X
xu-rui-w 已提交
809 810 811 812 813
imageSourceApi.createPixelMap(decodingOptions, pixelmap => { 
    console.log('createPixelMap succeeded.');
}).catch(error => {
    console.log('createPixelMap failed.');
}) 
X
xiaok 已提交
814 815
```

Z
zengyawen 已提交
816
### release
X
xiaok 已提交
817

Z
zengyawen 已提交
818
release(callback: AsyncCallback\<void>): void
X
xiaok 已提交
819

Z
zengyawen 已提交
820
释放图片源实例,使用callback形式返回结果。
X
xiaok 已提交
821 822 823 824 825

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
826 827 828
| 名称     | 类型                 | 必填 | 说明                               |
| -------- | -------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<void> | 是   | 资源释放回调,失败时返回错误信息。 |
X
xiaok 已提交
829 830 831 832

**示例:**

```js
X
xu-rui-w 已提交
833 834 835 836 837
imageSourceApi.release(() => { 
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})
X
xiaok 已提交
838 839
```

Z
zengyawen 已提交
840
### release
X
xiaok 已提交
841

Z
zengyawen 已提交
842
release(): Promise\<void>
X
xiaok 已提交
843

Z
zengyawen 已提交
844
释放图片源实例,使用Promise形式返回结果。
X
xiaok 已提交
845 846 847

**系统能力:** SystemCapability.Multimedia.Image

Z
zengyawen 已提交
848 849 850 851 852 853
**返回值:**

| 类型           | 说明                        |
| -------------- | --------------------------- |
| Promise\<void> | Promise实例,异步返回结果。 |

X
xiaok 已提交
854 855 856
**示例:**

```js
X
xu-rui-w 已提交
857 858 859 860 861
imageSourceApi.release().then(()=>{
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})
X
xiaok 已提交
862 863
```

Z
zengyawen 已提交
864
## image.createImagePacker
X
xiaok 已提交
865 866 867

createImagePacker(): ImagePacker

Z
zengyawen 已提交
868
创建ImagePacker实例。
X
xiaok 已提交
869 870 871 872 873

**系统能力:** SystemCapability.Multimedia.Image

**返回值:**

Z
zengyawen 已提交
874 875 876
| 类型                        | 说明                  |
| --------------------------- | --------------------- |
| [ImagePacker](#imagepacker) | 返回ImagePacker实例。 |
X
xiaok 已提交
877 878 879 880 881 882 883

**示例:**

```js
const imagePackerApi = image.createImagePacker();
```

Z
zengyawen 已提交
884 885 886
## ImagePacker

图片打包器类,用于图片压缩和打包。在调用ImagePacker的方法前,需要先通过createImagePacker构建一个ImagePacker实例。
X
xiaok 已提交
887

Z
zengyawen 已提交
888 889
### 属性

Z
zengyawen 已提交
890
**系统能力:** SystemCapability.Multimedia.Image
Z
zhang-xiaobo1997 已提交
891 892 893 894

| 名称             | 类型           | 可读 | 可写 | 说明                       |
| ---------------- | -------------- | ---- | ---- | -------------------------- |
| supportedFormats | Array\<string> | 是   | 否   | 图片打包支持的格式,jpeg。 |
Z
zengyawen 已提交
895 896 897

### packing

898
packing(source: ImageSource, option: PackingOption, callback: AsyncCallback\<ArrayBuffer>): void
X
xiaok 已提交
899 900 901 902 903 904 905

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
906 907 908 909
| 参数名   | 类型                               | 必填 | 说明                               |
| -------- | ---------------------------------- | ---- | ---------------------------------- |
| source   | [ImageSource](#imagesource)        | 是   | 打包的图片源。                     |
| option   | [PackingOption](#packingoption)    | 是   | 设置打包参数。                     |
910
| callback | AsyncCallback\<ArrayBuffer>        | 是   | 获取图片打包回调,返回打包后数据。 |
X
xiaok 已提交
911 912 913 914

**示例:**

```js
X
xu-rui-w 已提交
915
let packOpts = { format:"image/jpeg", quality:98 };
X
xu-rui-w 已提交
916
imagePackerApi.packing(ImageSourceApi, packOpts, data => {})
X
xiaok 已提交
917 918
```

Z
zengyawen 已提交
919
### packing
X
xiaok 已提交
920

921
packing(source: ImageSource, option: PackingOption): Promise\<ArrayBuffer>
X
xiaok 已提交
922

Z
zengyawen 已提交
923
图片压缩或重新打包,使用Promise形式返回结果。
X
xiaok 已提交
924 925 926 927 928 929 930

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

| 参数名 | 类型                            | 必填 | 说明           |
| ------ | ------------------------------- | ---- | -------------- |
Z
zengyawen 已提交
931 932
| source | [ImageSource](#imagesource)     | 是   | 打包的图片源。 |
| option | [PackingOption](#packingoption) | 是   | 设置打包参数。 |
X
xiaok 已提交
933 934 935

**返回值:**

Z
zengyawen 已提交
936 937
| 类型                         | 说明                                          |
| :--------------------------- | :-------------------------------------------- |
938
| Promise\<ArrayBuffer> | Promise实例,用于异步获取压缩或打包后的数据。 |
X
xiaok 已提交
939 940 941 942

**示例:**

```js
X
xu-rui-w 已提交
943
let packOpts = { format:"image/jpeg", quality:98 }
X
xu-rui-w 已提交
944 945 946 947 948 949
imagePackerApi.packing(ImageSourceApi, packOpts)
    .then( data => {
        console.log('packing succeeded.');
	}).catch(error => {
	    console.log('packing failed.');
	})
950 951
```

952
### packing<sup>8+</sup>
953

Z
zengyawen 已提交
954
packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayBuffer>): void
955 956 957 958 959 960 961 962 963 964 965

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

| 参数名   | 类型                            | 必填 | 说明                               |
| -------- | ------------------------------- | ---- | ---------------------------------- |
| source   | [PixelMap](#pixelmap)           | 是   | 打包的PixelMap资源。               |
| option   | [PackingOption](#packingoption) | 是   | 设置打包参数。                     |
Z
zengyawen 已提交
966
| callback | AsyncCallback\<ArrayBuffer>     | 是   | 获取图片打包回调,返回打包后数据。 |
967 968 969 970

**示例:**

```js
X
xu-rui-w 已提交
971
let packOpts = { format:"image/jpeg", quality:98 }
X
xu-rui-w 已提交
972 973 974 975 976
imagePackerApi.packing(PixelMapApi, packOpts, data => { 
    console.log('packing succeeded.');
}).catch(error => {
	console.log('packing failed.');
})
977 978
```

979
### packing<sup>8+</sup>
980

981
packing(source: PixelMap, option: PackingOption): Promise\<ArrayBuffer>
982 983 984 985 986 987 988

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

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zhang-xiaobo1997 已提交
989 990
| 参数名 | 类型                            | 必填 | 说明               |
| ------ | ------------------------------- | ---- | ------------------ |
991
| source | [PixelMap](#pixelmap)           | 是   | 打包的PixelMap源。 |
Z
zhang-xiaobo1997 已提交
992
| option | [PackingOption](#packingoption) | 是   | 设置打包参数。     |
993 994 995

**返回值:**

Z
zengyawen 已提交
996 997
| 类型                         | 说明                                          |
| :--------------------------- | :-------------------------------------------- |
998
| Promise\<ArrayBuffer> | Promise实例,用于异步获取压缩或打包后的数据。 |
999 1000 1001 1002

**示例:**

```js
X
xu-rui-w 已提交
1003
let packOpts = { format:"image/jpeg", quality:98 }
X
xu-rui-w 已提交
1004 1005 1006 1007 1008 1009
imagePackerApi.packing(PixelMapApi, packOpts)
    .then( data => {
	    console.log('packing succeeded.');
	}).catch(error => {
	    console.log('packing failed.');
	})
X
xiaok 已提交
1010 1011
```

Z
zengyawen 已提交
1012
### release
X
xiaok 已提交
1013

Z
zengyawen 已提交
1014
release(callback: AsyncCallback\<void>): void
X
xiaok 已提交
1015

Z
zengyawen 已提交
1016
释放图片打包实例,使用callback形式返回结果。
X
xiaok 已提交
1017 1018 1019 1020 1021

**系统能力:** SystemCapability.Multimedia.Image

**参数:**

Z
zengyawen 已提交
1022 1023 1024
| 参数名   | 类型                 | 必填 | 说明                           |
| -------- | -------------------- | ---- | ------------------------------ |
| callback | AsyncCallback\<void> | 是   | 释放回调,失败时返回错误信息。 |
X
xiaok 已提交
1025 1026 1027 1028

**示例:**

```js
X
xu-rui-w 已提交
1029 1030 1031 1032 1033
imagePackerApi.release(()=>{ 
    console.log('release succeeded.');
}).catch(error => {
	console.log('release failed.');
})
X
xiaok 已提交
1034 1035
```

Z
zengyawen 已提交
1036
### release
X
xiaok 已提交
1037

Z
zengyawen 已提交
1038
release(): Promise\<void>
X
xiaok 已提交
1039

Z
zengyawen 已提交
1040
释放图片打包实例,使用Promise形式返回释放结果。
X
xiaok 已提交
1041 1042 1043

**系统能力:** SystemCapability.Multimedia.Image

Z
zengyawen 已提交
1044 1045
**返回值:**

Z
zengyawen 已提交
1046 1047 1048
| 类型           | 说明                                                    |
| :------------- | :------------------------------------------------------ |
| Promise\<void> | Promise实例,用于异步获取释放结果,失败时返回错误信息。 |
Z
zengyawen 已提交
1049

X
xiaok 已提交
1050 1051 1052
**示例:**

```js
X
xu-rui-w 已提交
1053 1054 1055 1056 1057
imagePackerApi.release().then(()=>{
    console.log('release succeeded.');
}).catch((error)=>{ 
    console.log('release failed.'); 
}) 
X
xiaok 已提交
1058 1059
```

Z
zhang-xiaobo1997 已提交
1060 1061
## image.createImageReceiver<sup>9+</sup>

Z
zengyawen 已提交
1062
createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver
Z
zhang-xiaobo1997 已提交
1063

Z
zengyawen 已提交
1064
通过宽、高、图片格式、容量创建ImageReceiver实例。
Z
zhang-xiaobo1997 已提交
1065

Z
zengyawen 已提交
1066
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1067 1068 1069

**参数:**

Z
zengyawen 已提交
1070 1071 1072 1073 1074 1075
| 名称     | 类型   | 必填 | 说明                   |
| -------- | ------ | ---- | ---------------------- |
| width    | number | 是   | 图像的默认宽度。       |
| height   | number | 是   | 图像的默认高度。       |
| format   | number | 是   | 图像格式。             |
| capacity | number | 是   | 同时访问的最大图像数。 |
Z
zhang-xiaobo1997 已提交
1076 1077 1078

**返回值:**

Z
zengyawen 已提交
1079 1080 1081
| 类型                             | 说明                                    |
| -------------------------------- | --------------------------------------- |
| [ImageReceiver](#imagereceiver9) | 如果操作成功,则返回ImageReceiver实例。 |
Z
zhang-xiaobo1997 已提交
1082 1083 1084 1085

**示例:**

```js
X
xu-rui-w 已提交
1086
var receiver = image.createImageReceiver(8192, 8, 4, 8);
Z
zhang-xiaobo1997 已提交
1087
```
Z
zhang-xiaobo1997 已提交
1088

Z
zhang-xiaobo1997 已提交
1089 1090
## ImageReceiver<sup>9+</sup>

Z
zengyawen 已提交
1091 1092 1093
图像接收类,用于获取组件surface id,接收最新的图片和读取下一张图片,以及释放ImageReceiver实例。

在调用以下方法前需要先创建ImageReceiver实例。
Z
zhang-xiaobo1997 已提交
1094 1095 1096

### 属性

1097
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1098

Z
zengyawen 已提交
1099 1100 1101 1102 1103
| 名称                  | 类型                         | 可读 | 可写 | 说明               |
| --------------------- | ---------------------------- | ---- | ---- | ------------------ |
| size<sup>9+</sup>     | [Size](#size)                | 是   | 否   | 图片大小。         |
| capacity<sup>9+</sup> | number                       | 是   | 否   | 同时访问的图像数。 |
| format<sup>9+</sup>   | [ImageFormat](#imageformat9) | 是   | 否   | 图像格式。         |
Z
zhang-xiaobo1997 已提交
1104

Z
zhang-xiaobo1997 已提交
1105
### getReceivingSurfaceId<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1106

Z
zhang-xiaobo1997 已提交
1107
getReceivingSurfaceId(callback: AsyncCallback\<string>): void
Z
zhang-xiaobo1997 已提交
1108

Z
zengyawen 已提交
1109
用于获取一个surface id供Camera或其他组件使用。使用callback返回结果。
Z
zhang-xiaobo1997 已提交
1110

Z
zengyawen 已提交
1111
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1112 1113 1114

**参数:**

Z
zengyawen 已提交
1115 1116 1117
| 名称     | 类型                   | 必填 | 说明                       |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback\<string> | 是   | 回调函数,返回surface id。 |
Z
zhang-xiaobo1997 已提交
1118 1119 1120 1121

**示例:**

```js
X
xu-rui-w 已提交
1122
receiver.getReceivingSurfaceId((err, id) => { 
X
xu-rui-w 已提交
1123 1124 1125 1126 1127 1128
    if(err) {
        console.log('getReceivingSurfaceId failed.');
    } else {
        console.log('getReceivingSurfaceId succeeded.');
    }
});
Z
zhang-xiaobo1997 已提交
1129 1130
```

Z
zhang-xiaobo1997 已提交
1131
### getReceivingSurfaceId<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1132

Z
zhang-xiaobo1997 已提交
1133
getReceivingSurfaceId(): Promise\<string>
Z
zhang-xiaobo1997 已提交
1134

Z
zengyawen 已提交
1135
用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。
Z
zhang-xiaobo1997 已提交
1136

Z
zengyawen 已提交
1137
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1138 1139 1140

**返回值:**

Z
zhang-xiaobo1997 已提交
1141 1142 1143
| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<string> | 异步返回surface id。 |
Z
zhang-xiaobo1997 已提交
1144 1145 1146 1147 1148

**示例:**

```js
receiver.getReceivingSurfaceId().then( id => { 
X
xu-rui-w 已提交
1149 1150 1151 1152
    console.log('getReceivingSurfaceId succeeded.');
}).catch(error => {
    console.log('getReceivingSurfaceId failed.');
})
Z
zhang-xiaobo1997 已提交
1153 1154
```

Z
zhang-xiaobo1997 已提交
1155
### readLatestImage<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1156

Z
zhang-xiaobo1997 已提交
1157
readLatestImage(callback: AsyncCallback\<Image>): void
Z
zhang-xiaobo1997 已提交
1158

Z
zengyawen 已提交
1159
从ImageReceiver读取最新的图片,并使用callback返回结果。
Z
zhang-xiaobo1997 已提交
1160

Z
zengyawen 已提交
1161
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1162 1163 1164

**参数:**

Z
zengyawen 已提交
1165 1166 1167
| 名称     | 类型                            | 必填 | 说明                     |
| -------- | ------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback<[Image](#image9)> | 是   | 回调函数,返回最新图像。 |
Z
zhang-xiaobo1997 已提交
1168 1169 1170 1171

**示例:**

```js
X
xu-rui-w 已提交
1172 1173 1174 1175 1176 1177 1178
receiver.readLatestImage((err, img) => { 
    if(err) {
        console.log('readLatestImage failed.');
    } else {
        console.log('readLatestImage succeeded.');
    }
});
Z
zhang-xiaobo1997 已提交
1179 1180
```

Z
zhang-xiaobo1997 已提交
1181
### readLatestImage<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1182

Z
zhang-xiaobo1997 已提交
1183
readLatestImage(): Promise\<Image>
Z
zhang-xiaobo1997 已提交
1184

Z
zengyawen 已提交
1185
从ImageReceiver读取最新的图片,并使用promise返回结果。
Z
zhang-xiaobo1997 已提交
1186

Z
zengyawen 已提交
1187
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1188 1189 1190 1191 1192

**返回值:**

| 类型                      | 说明               |
| ------------------------- | ------------------ |
Z
zhang-xiaobo1997 已提交
1193
| Promise<[Image](#image8)> | 异步返回最新图片。 |
Z
zhang-xiaobo1997 已提交
1194 1195 1196 1197

**示例:**

```js
X
xu-rui-w 已提交
1198 1199 1200 1201 1202
receiver.readLatestImage().then(img => {
    console.log('readLatestImage succeeded.');
}).catch(error => {
    console.log('readLatestImage failed.');
})
Z
zhang-xiaobo1997 已提交
1203 1204
```

Z
zhang-xiaobo1997 已提交
1205
### readNextImage<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1206

Z
zhang-xiaobo1997 已提交
1207
readNextImage(callback: AsyncCallback\<Image>): void
Z
zhang-xiaobo1997 已提交
1208

Z
zengyawen 已提交
1209
从ImageReceiver读取下一张图片,并使用callback返回结果。
Z
zhang-xiaobo1997 已提交
1210

Z
zengyawen 已提交
1211
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1212 1213 1214

**参数:**

Z
zengyawen 已提交
1215 1216 1217
| 名称     | 类型                            | 必填 | 说明                       |
| -------- | ------------------------------- | ---- | -------------------------- |
| callback | AsyncCallback<[Image](#image9)> | 是   | 回调函数,返回下一张图片。 |
Z
zhang-xiaobo1997 已提交
1218 1219 1220 1221

**示例:**

```js
X
xu-rui-w 已提交
1222 1223 1224 1225 1226 1227 1228
receiver.readNextImage((err, img) => { 
    if(err) {
        console.log('readNextImage failed.');
    } else {
        console.log('readNextImage succeeded.');
    }
});
Z
zhang-xiaobo1997 已提交
1229 1230
```

Z
zhang-xiaobo1997 已提交
1231
### readNextImage<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1232

Z
zhang-xiaobo1997 已提交
1233
readNextImage(): Promise\<Image>
Z
zhang-xiaobo1997 已提交
1234

Z
zengyawen 已提交
1235
从ImageReceiver读取下一张图片,并使用promise返回结果。
Z
zhang-xiaobo1997 已提交
1236

Z
zengyawen 已提交
1237
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1238 1239 1240 1241 1242

**返回值:**

| 类型                      | 说明                 |
| ------------------------- | -------------------- |
Z
zengyawen 已提交
1243
| Promise<[Image](#image9)> | 异步返回下一张图片。 |
Z
zhang-xiaobo1997 已提交
1244 1245 1246 1247

**示例:**

```js
X
xu-rui-w 已提交
1248 1249 1250 1251 1252
receiver.readNextImage().then(img => {
    console.log('readNextImage succeeded.');
}).catch(error => {
    console.log('readNextImage failed.');
})
Z
zhang-xiaobo1997 已提交
1253 1254
```

Z
zengyawen 已提交
1255
### on('imageArrival')<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1256

Z
zhang-xiaobo1997 已提交
1257
on(type: 'imageArrival', callback: AsyncCallback\<void>): void
Z
zhang-xiaobo1997 已提交
1258 1259 1260

接收图片时注册回调。

Z
zengyawen 已提交
1261
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1262 1263 1264

**参数:**

Z
zhang-xiaobo1997 已提交
1265 1266
| 名称     | 类型                 | 必填 | 说明                                                   |
| -------- | -------------------- | ---- | ------------------------------------------------------ |
Z
zengyawen 已提交
1267
| type     | string               | 是   | 注册事件的类型,固定为'imageArrival',接收图片时触发。 |
Z
zhang-xiaobo1997 已提交
1268
| callback | AsyncCallback\<void> | 是   | 注册的事件回调。                                       |
Z
zhang-xiaobo1997 已提交
1269 1270 1271 1272

**示例:**

```js
X
xu-rui-w 已提交
1273
receiver.on('imageArrival', () => {})
Z
zhang-xiaobo1997 已提交
1274 1275
```

Z
zhang-xiaobo1997 已提交
1276
### release<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1277

Z
zengyawen 已提交
1278
release(callback: AsyncCallback\<void>): void
Z
zhang-xiaobo1997 已提交
1279 1280 1281

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

Z
zengyawen 已提交
1282
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1283 1284 1285

**参数:**

Z
zengyawen 已提交
1286 1287 1288
| 名称     | 类型                 | 必填 | 说明                     |
| -------- | -------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<void> | 是   | 回调函数,返回操作结果。 |
Z
zhang-xiaobo1997 已提交
1289 1290 1291 1292

**示例:**

```js
X
xu-rui-w 已提交
1293
receiver.release(() => {})
Z
zhang-xiaobo1997 已提交
1294 1295
```

Z
zhang-xiaobo1997 已提交
1296
### release<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1297

Z
zhang-xiaobo1997 已提交
1298
release(): Promise\<void>
Z
zhang-xiaobo1997 已提交
1299 1300 1301

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

Z
zengyawen 已提交
1302
**系统能力:** SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1303 1304 1305

**返回值:**

Z
zengyawen 已提交
1306 1307 1308
| 类型           | 说明               |
| -------------- | ------------------ |
| Promise\<void> | 异步返回操作结果。 |
Z
zhang-xiaobo1997 已提交
1309 1310 1311 1312

**示例:**

```js
X
xu-rui-w 已提交
1313 1314 1315 1316 1317
receiver.release().then(() => {
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})
Z
zhang-xiaobo1997 已提交
1318 1319
```

Z
zhang-xiaobo1997 已提交
1320
## Image<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1321

Z
zengyawen 已提交
1322
提供基本的图像操作,包括获取图像信息、读写图像数据。调用[readNextImage](#readnextimage9)[readLatestImage](#readlatestimage9)接口时会返回image。
Z
zhang-xiaobo1997 已提交
1323 1324 1325

### 属性

Z
zengyawen 已提交
1326
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1327

Z
zengyawen 已提交
1328 1329
| 名称                  | 类型               | 可读 | 可写 | 说明                                               |
| --------------------- | ------------------ | ---- | ---- | -------------------------------------------------- |
1330
| clipRect<sup>9+</sup> | [Region](#region7) | 是   | 是   | 要裁剪的图像区域。                                 |
Z
zengyawen 已提交
1331 1332
| size<sup>9+</sup>     | [Size](#size)      | 是   | 否   | 图像大小。                                         |
| format<sup>9+</sup>   | number             | 是   | 否   | 图像格式,参考[PixelMapFormat](#pixelmapformat7)。 |
Z
zhang-xiaobo1997 已提交
1333

Z
zhang-xiaobo1997 已提交
1334
### getComponent<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1335

Z
zhang-xiaobo1997 已提交
1336
getComponent(componentType: ComponentType, callback: AsyncCallback\<Component>): void
Z
zhang-xiaobo1997 已提交
1337

Z
zhang-xiaobo1997 已提交
1338
根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。
Z
zhang-xiaobo1997 已提交
1339

Z
zengyawen 已提交
1340
**系统能力:** SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1341 1342 1343 1344 1345

**参数:**

| 名称          | 类型                                    | 必填 | 说明                 |
| ------------- | --------------------------------------- | ---- | -------------------- |
Z
zengyawen 已提交
1346 1347
| componentType | [ComponentType](#componenttype9)        | 是   | 图像的组件类型。     |
| callback      | AsyncCallback<[Component](#component9)> | 是   | 用于返回组件缓冲区。 |
Z
zhang-xiaobo1997 已提交
1348 1349 1350 1351

**示例:**

```js
X
xu-rui-w 已提交
1352 1353 1354 1355 1356 1357 1358
img.getComponent(4, (err, component) => {
    if(err) {
        console.log('getComponent failed.');
    } else {
        console.log('getComponent succeeded.');
    }
})
Z
zhang-xiaobo1997 已提交
1359 1360
```

Z
zhang-xiaobo1997 已提交
1361
### getComponent<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1362

Z
zhang-xiaobo1997 已提交
1363
getComponent(componentType: ComponentType): Promise\<Component>
Z
zhang-xiaobo1997 已提交
1364

Z
zengyawen 已提交
1365
根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。
Z
zhang-xiaobo1997 已提交
1366

Z
zengyawen 已提交
1367
**系统能力:** SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1368 1369 1370 1371 1372

**参数:**

| 名称          | 类型                             | 必填 | 说明             |
| ------------- | -------------------------------- | ---- | ---------------- |
Z
zengyawen 已提交
1373
| componentType | [ComponentType](#componenttype9) | 是   | 图像的组件类型。 |
Z
zhang-xiaobo1997 已提交
1374 1375 1376 1377 1378

**返回值:**

| 类型                              | 说明                              |
| --------------------------------- | --------------------------------- |
Z
zengyawen 已提交
1379
| Promise<[Component](#component9)> | 用于返回组件缓冲区的promise实例。 |
Z
zhang-xiaobo1997 已提交
1380 1381 1382 1383 1384 1385 1386

**示例:**

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

Z
zhang-xiaobo1997 已提交
1387
### release<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1388

Z
zhang-xiaobo1997 已提交
1389
release(callback: AsyncCallback\<void>): void
Z
zhang-xiaobo1997 已提交
1390

Z
zengyawen 已提交
1391 1392 1393
释放当前图像并使用callback返回结果。

在接收另一个图像前必须先释放对应资源。
Z
zhang-xiaobo1997 已提交
1394

Z
zengyawen 已提交
1395
**系统能力:** SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1396 1397 1398

**参数:**

Z
zhang-xiaobo1997 已提交
1399 1400 1401
| 名称     | 类型                 | 必填 | 说明           |
| -------- | -------------------- | ---- | -------------- |
| callback | AsyncCallback\<void> | 是   | 返回操作结果。 |
Z
zhang-xiaobo1997 已提交
1402 1403 1404 1405

**示例:**

```js
X
xu-rui-w 已提交
1406 1407 1408 1409 1410
img.release(() =>{ 
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
}) 
Z
zhang-xiaobo1997 已提交
1411 1412
```

Z
zhang-xiaobo1997 已提交
1413
### release<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1414

Z
zhang-xiaobo1997 已提交
1415
release(): Promise\<void>
Z
zhang-xiaobo1997 已提交
1416

Z
zengyawen 已提交
1417 1418 1419
释放当前图像并使用Promise方式返回结果。

在接收另一个图像前必须先释放对应资源。
Z
zhang-xiaobo1997 已提交
1420

Z
zengyawen 已提交
1421
**系统能力:** SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1422 1423 1424

**返回值:**

Z
zhang-xiaobo1997 已提交
1425 1426 1427
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise\<void> | promise返回操作结果。 |
Z
zhang-xiaobo1997 已提交
1428 1429 1430 1431 1432

**示例:**

```js
img.release().then(() =>{
X
xu-rui-w 已提交
1433 1434 1435 1436
    console.log('release succeeded.');
}).catch(error => {
    console.log('release failed.');
})
Z
zhang-xiaobo1997 已提交
1437 1438
```

Z
zengyawen 已提交
1439 1440 1441 1442
## PositionArea<sup>7+</sup>

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

Z
zengyawen 已提交
1443
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1444

1445 1446 1447 1448
| 名称   | 类型               | 可读 | 可写 | 说明                                                         |
| ------ | ------------------ | ---- | ---- | ------------------------------------------------------------ |
| pixels | ArrayBuffer        | 是   | 否   | 像素。                                                       |
| offset | number             | 是   | 否   | 偏移量。                                                     |
Z
zhang-xiaobo1997 已提交
1449
| stride | number             | 是   | 否   | 像素间距,stride >= region.size.width*4。                    |
1450
| region | [Region](#region7) | 是   | 否   | 区域,按照区域读写。写入的区域宽度加X坐标不能大于原图的宽度,写入的区域高度加Y坐标不能大于原图的高度 |
X
xiaok 已提交
1451

Z
zengyawen 已提交
1452
## ImageInfo
X
xiaok 已提交
1453

Z
zengyawen 已提交
1454
表示图片信息。
X
xiaok 已提交
1455

Z
zengyawen 已提交
1456
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
X
xiaok 已提交
1457

Z
zengyawen 已提交
1458 1459 1460
| 名称 | 类型          | 可读 | 可写 | 说明       |
| ---- | ------------- | ---- | ---- | ---------- |
| size | [Size](#size) | 是   | 是   | 图片大小。 |
X
xiaok 已提交
1461

Z
zengyawen 已提交
1462
## Size
X
xiaok 已提交
1463

Z
zengyawen 已提交
1464 1465
表示图片尺寸。

Z
zengyawen 已提交
1466
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1467 1468 1469 1470 1471 1472 1473

| 名称   | 类型   | 可读 | 可写 | 说明           |
| ------ | ------ | ---- | ---- | -------------- |
| height | number | 是   | 是   | 输出图片的高。 |
| width  | number | 是   | 是   | 输出图片的宽。 |

## PixelMapFormat<sup>7+</sup>
X
xiaok 已提交
1474

Z
zengyawen 已提交
1475
枚举,图片像素格式。
X
xiaok 已提交
1476

Z
zengyawen 已提交
1477
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1478 1479 1480 1481 1482 1483 1484

| 名称      | 默认值 | 描述              |
| --------- | ------ | ----------------- |
| UNKNOWN   | 0      | 未知格式。        |
| RGBA_8888 | 3      | 格式为RGBA_8888。 |
| RGB_565   | 2      | 格式为RGB_565。   |

1485
## AlphaType<sup>9+</sup>
X
xiaok 已提交
1486

Z
zengyawen 已提交
1487
枚举,图像的透明度类型。
X
xiaok 已提交
1488

Z
zengyawen 已提交
1489
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1490 1491 1492 1493 1494 1495 1496

| 名称     | 默认值 | 描述                    |
| -------- | ------ | ----------------------- |
| UNKNOWN  | 0      | 未知透明度。            |
| OPAQUE   | 1      | 没有alpha或图片全透明。 |
| PREMUL   | 2      | RGB前乘alpha。          |
| UNPREMUL | 3      | RGB不前乘alpha。        |
X
xiaok 已提交
1497

1498
## ScaleMode<sup>9+</sup>
X
xiaok 已提交
1499

Z
zengyawen 已提交
1500
枚举,图像的缩放模式。
X
xiaok 已提交
1501

Z
zengyawen 已提交
1502
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
X
xiaok 已提交
1503

Z
zengyawen 已提交
1504 1505 1506 1507
| 名称            | 默认值 | 描述                                               |
| --------------- | ------ | -------------------------------------------------- |
| CENTER_CROP     | 1      | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 |
| FIT_TARGET_SIZE | 2      | 图像适合目标尺寸的效果。                           |
X
xiaok 已提交
1508

Z
zengyawen 已提交
1509
## InitializationOptions<sup>8+</sup>
X
xiaok 已提交
1510

Z
zengyawen 已提交
1511 1512 1513
PixelMap的初始化选项。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1514

Z
zhang-xiaobo1997 已提交
1515 1516 1517 1518 1519 1520 1521
| 名称                   | 类型                               | 可读 | 可写 | 说明           |
| ---------------------- | ---------------------------------- | ---- | ---- | -------------- |
| alphaType<sup>9+</sup> | [AlphaType](#alphatype9)           | 是   | 是   | 透明度。       |
| editable               | boolean                            | 是   | 是   | 是否可编辑。   |
| pixelFormat            | [PixelMapFormat](#pixelmapformat7) | 是   | 是   | 像素格式。     |
| scaleMode<sup>9+</sup> | [ScaleMode](#scalemode9)           | 是   | 是   | 缩略值。       |
| size                   | [Size](#size)                      | 是   | 是   | 创建图片大小。 |
Z
zengyawen 已提交
1522 1523

## DecodingOptions<sup>7+</sup>
X
xiaok 已提交
1524

Z
zengyawen 已提交
1525
图像解码设置选项。
X
xiaok 已提交
1526

Z
zengyawen 已提交
1527
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1528 1529 1530 1531

| 名称               | 类型                               | 可读 | 可写 | 说明             |
| ------------------ | ---------------------------------- | ---- | ---- | ---------------- |
| sampleSize         | number                             | 是   | 是   | 缩略图采样大小。 |
Z
zengyawen 已提交
1532
| rotate             | number                             | 是   | 是   | 旋转角度。       |
Z
zengyawen 已提交
1533 1534
| editable           | boolean                            | 是   | 是   | 是否可编辑。     |
| desiredSize        | [Size](#size)                      | 是   | 是   | 期望输出大小。   |
1535
| desiredRegion      | [Region](#region7)                 | 是   | 是   | 解码区域。       |
Z
zengyawen 已提交
1536
| desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是   | 是   | 解码的像素格式。 |
X
xu-rui-w 已提交
1537
| index              | number                             | 是   | 是   | 解码图片序号。   |
Z
zengyawen 已提交
1538

1539
## Region<sup>7+</sup>
Z
zengyawen 已提交
1540 1541 1542

表示区域信息。

Z
zengyawen 已提交
1543
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1544

1545 1546 1547 1548 1549
| 名称 | 类型          | 可读 | 可写 | 说明         |
| ---- | ------------- | ---- | ---- | ------------ |
| size | [Size](#size) | 是   | 是   | 区域大小。   |
| x    | number        | 是   | 是   | 区域横坐标。 |
| y    | number        | 是   | 是   | 区域纵坐标。 |
Z
zengyawen 已提交
1550 1551 1552 1553 1554

## PackingOption

表示图片打包选项。

Z
zengyawen 已提交
1555
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1556 1557 1558 1559

| 名称    | 类型   | 可读 | 可写 | 说明           |
| ------- | ------ | ---- | ---- | -------------- |
| format  | string | 是   | 是   | 目标格式。     |
X
xu-rui-w 已提交
1560
| quality | number | 是   | 是   | JPEG编码中设定输出图片质量的参数,取值范围为1-100。 |
Z
zengyawen 已提交
1561 1562 1563 1564 1565

## GetImagePropertyOptions<sup>7+</sup>

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

Z
zengyawen 已提交
1566
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
Z
zengyawen 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576

| 名称         | 类型   | 可读 | 可写 | 说明         |
| ------------ | ------ | ---- | ---- | ------------ |
| index        | number | 是   | 是   | 图片序号。   |
| defaultValue | string | 是   | 是   | 默认属性值。 |

## PropertyKey<sup>7+</sup>

枚举,Exif(Exchangeable image file format)图片信息。

Z
zengyawen 已提交
1577
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image
1578

Z
zengyawen 已提交
1579 1580
| 名称              | 默认值            | 说明                 |
| ----------------- | ----------------- | -------------------- |
1581
| BITS_PER_SAMPLE   | "BitsPerSample"   | 每个像素比特数。     |
Z
zengyawen 已提交
1582 1583 1584 1585 1586 1587
| ORIENTATION       | "Orientation"     | 图片方向。           |
| IMAGE_LENGTH      | "ImageLength"     | 图片长度。           |
| IMAGE_WIDTH       | "ImageWidth"      | 图片宽度。           |
| GPS_LATITUDE      | "GPSLatitude"     | 图片纬度。           |
| GPS_LONGITUDE     | "GPSLongitude"    | 图片经度。           |
| GPS_LATITUDE_REF  | "GPSLatitudeRef"  | 纬度引用,例如N或S。 |
1588 1589
| GPS_LONGITUDE_REF | "GPSLongitudeRef" | 经度引用,例如W或E。 |

Z
zhang-xiaobo1997 已提交
1590
## ImageFormat<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1591 1592 1593

枚举,图片格式。

Z
zengyawen 已提交
1594
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1595

Z
zengyawen 已提交
1596 1597 1598 1599
| 名称         | 默认值 | 描述                 |
| ------------ | ------ | -------------------- |
| YCBCR_422_SP | 1000   | YCBCR422半平面格式。 |
| JPEG         | 2000   | JPEG编码格式。       |
Z
zhang-xiaobo1997 已提交
1600

Z
zengyawen 已提交
1601
## ComponentType<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1602 1603 1604

枚举,图像的组件类型。

Z
zengyawen 已提交
1605
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver
Z
zhang-xiaobo1997 已提交
1606 1607 1608 1609 1610 1611 1612 1613

| 名称  | 默认值 | 描述        |
| ----- | ------ | ----------- |
| YUV_Y | 1      | 亮度信息。  |
| YUV_U | 2      | 色度信息。  |
| YUV_V | 3      | 色度信息。  |
| JPEG  | 4      | Jpeg 类型。 |

Z
zengyawen 已提交
1614
## Component<sup>9+</sup>
Z
zhang-xiaobo1997 已提交
1615 1616 1617

描述图像颜色分量。

Z
zengyawen 已提交
1618
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core
Z
zhang-xiaobo1997 已提交
1619 1620 1621

| 名称          | 类型                             | 可读 | 可写 | 说明         |
| ------------- | -------------------------------- | ---- | ---- | ------------ |
Z
zengyawen 已提交
1622
| componentType | [ComponentType](#componenttype9) | 是   | 否   | 组件类型。   |
Z
zhang-xiaobo1997 已提交
1623 1624 1625 1626
| rowStride     | number                           | 是   | 否   | 行距。       |
| pixelStride   | number                           | 是   | 否   | 像素间距。   |
| byteBuffer    | ArrayBuffer                      | 是   | 否   | 组件缓冲区。 |