js-apis-camera.md 84.2 KB
Newer Older
N
nikhilraut 已提交
1 2
# Camera<a name="EN-US_TOPIC_0000001149807881"></a>

W
wusongqing 已提交
3
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
4
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
W
wusongqing 已提交
5

N
nikhilraut 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18
## Modules to Import

```
import camera from '@ohos.multimedia.camera';
```

## Required Permissions

```
ohos.permission.CAMERA
```
## getCameraManager(context: Context, callback: AsyncCallback<CameraManager\>): void;

N
nikhilraut 已提交
19 20 21 22 23 24
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Gets a **CameraManager** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                          | Mandatory | Description                                         |
|----------|-------------------------------|-----------|-----------------------------------------------------|
| context  | Context                       | Yes       | Application context                                 |
| callback | AsyncCallback<CameraManager\> | Yes       | Callback used to return the CameraManager instance  |

**Example**

```
camera.getCameraManager(context, (err, cameraManager) => {
    if (err) {
        console.error('Failed to get the CameraManager instance ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraManager instance');
});
```

## getCameraManager(context: Context): Promise<CameraManager\>;

N
nikhilraut 已提交
48 49 50 51 52 53
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
Gets a **CameraManager** instance. This method uses a promise to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                |
|----------|----------------------|-----------|----------------------------|
| context  | Context              | Yes       | Application context        |

**Return values**

| Type                    | Description                                            |
|-------------------------|--------------------------------------------------------|
| Promise<CameraManager\> | Promise used to return the **CameraManager** instance  |

**Example**

```
camera.getCameraManager(context).then((cameraManger) => {
    console.log('Promise returned with the CameraManager instance.');
})
```

## CameraStatus<a name="section_camera_status"></a>

Enumerates camera status types.

80 81 82 83
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
84 85
| Name                      | Default Value | Description        |
|---------------------------|---------------|--------------------|
86 87 88 89
| CAMERA_STATUS_APPEAR      | 0             | Camera appear      |
| CAMERA_STATUS_DISAPPEAR   | 1             | Camera disappear   |
| CAMERA_STATUS_AVAILABLE   | 2             | Camera available   |
| CAMERA_STATUS_UNAVAILABLE | 3             | Camera unavailable |
N
nikhilraut 已提交
90 91 92 93 94 95


## CameraPosition<a name="section_camera_position"></a>

Enumerates the camera positions.

96 97 98 99
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
100 101
| Name                        | Default value | Description           |
|-----------------------------|---------------|-----------------------|
102 103 104
| CAMERA_POSITION_UNSPECIFIED | 0             | Unspecified position  |
| CAMERA_POSITION_BACK        | 1             | Rear camera           |
| CAMERA_POSITION_FRONT       | 2             | Front camera          |
N
nikhilraut 已提交
105 106 107 108 109

## CameraType<a name="section_camera_type"></a>

Enumerates the camera types.

110 111 112 113
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
114 115
| Name                    | Default value | Description             |
|-------------------------|---------------|-------------------------|
116 117 118 119 120
| CAMERA_TYPE_UNSPECIFIED | 0             | Unspecified camera type |
| CAMERA_TYPE_WIDE_ANGLE  | 1             | Wide camera             |
| CAMERA_TYPE_ULTRA_WIDE  | 2             | Ultra wide camera       |
| CAMERA_TYPE_TELEPHOTO   | 3             | Telephoto camera        |
| CAMERA_TYPE_TRUE_DEPTH  | 4             | True depth camera       |
N
nikhilraut 已提交
121 122 123 124 125 126


## ConnectionType<a name="section_ConnectionType"></a>

Enumerates camera connection types.

127
**System Capabilities:**
N
nikhilraut 已提交
128

129
SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
130

131 132 133 134 135
| Name                         | Default value | Description                |
|------------------------------|---------------|----------------------------|
| CAMERA_CONNECTION_BUILT_IN   | 0             | Built-in camera            |
| CAMERA_CONNECTION_USB_PLUGIN | 1             | Camera connected using USB  |
| CAMERA_CONNECTION_REMOTE     | 2             | Remote camera               |
N
nikhilraut 已提交
136 137 138 139 140 141 142

## CameraManager<a name="section_CameraManager"></a>

Implements camera management, including getting supported cameras and creating **CameraInput** instances.

### getCameras(callback: AsyncCallback<Array<Camera\>\>): void;

N
nikhilraut 已提交
143 144 145 146 147 148
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
Gets all cameras supported by the device. This method uses an asynchronous callback to return the array of supported cameras.

**Parameters**

| Name     | Type                           | Mandatory | Description                                             |
|----------|--------------------------------|-----------|---------------------------------------------------------|
| callback | AsyncCallback<Array<Camera\>\> | Yes       | Callback used to return the array of supported cameras. |

**Example**

```
cameraManager.getCameras((err, cameras) => {
    if (err) {
        console.error('Failed to get the cameras. ${err.message}');
        return;
    }
    console.log('Callback returned with an array of supported cameras: ' + cameras.length);
})
```

### getCameras(): Promise<Array<Camera\>\>;

N
nikhilraut 已提交
171 172 173 174 175 176
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
Gets all cameras supported by the device. This method uses a promise to return the array of supported cameras.

**Return values**

| Type                   | Description                                            |
|------------------------|--------------------------------------------------------|
| Promise<Array<Camera\>\> | Promise used to return an array of supported cameras |


**Example**

```
cameraManager.getCameras().then((cameraArray) => {
    console.log('Promise returned with an array of supported cameras: ' + cameraArray.length);
})
```

### createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput\>): void;

N
nikhilraut 已提交
196 197 198 199 200 201
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
Creates a **CameraInput** instance with the specified camera ID. This method uses an asynchronous callback to return the instance.

**Parameters**

| Name     | Default value                | Mandatory | Description                                      |
|----------|------------------------------|-----------|--------------------------------------------------|
| cameraId | string                       | Yes       | Camera ID used to create the instance            |
| callback | AsyncCallback<CameraInput\>  | Yes       | Callback used to return the CameraInput instance |

**Example**

```
cameraManager.createCameraInput(cameraId, (err, cameraInput) => {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance.');
})
```

### createCameraInput(cameraId: string): Promise<CameraInput\>;

N
nikhilraut 已提交
225 226 227 228 229 230
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
Creates a **CameraInput** instance with the specified camera ID. This method uses a promise to return the instance.

**Parameters**

| Name     | Default value               | Mandatory | Description                              |
|----------|-----------------------------|-----------|------------------------------------------|
| cameraId | string                      | Yes       | Camera ID used to create the instance    |

**Return values**

| Type                    | Description                                     |
|-------------------------|-------------------------------------------------|
| Promise<CameraInput\>   | Promise used to return the CameraInput instance |

**Example**

```
cameraManager.createCameraInput(cameraId).then((cameraInput) => {
    console.log('Promise returned with the CameraInput instance');
})
```

### createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCallback<CameraInput\>): void;

N
nikhilraut 已提交
255 256 257 258 259 260
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
261 262 263 264
Creates a **CameraInput** instance with the specified camera position and camera type. This method uses an asynchronous callback to return the instance.

**Parameters**

J
jiangminyang 已提交
265 266 267 268 269
| Name     | Type                        | Mandatory | Description                                       |
|----------|-----------------------------|-----------|---------------------------------------------------|
| position | CameraPosition              | Yes       | Camera position                                   |
| type     | CameraType                  | Yes       | Camera type                                       |
| callback | AsyncCallback<CameraInput\> | Yes       | Callback used to return the CameraInput instance |
N
nikhilraut 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

**Example**

```
cameraManager.createCameraInput(cameraPosition, cameraType, (err, cameraInput) => {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance');
})
```

### createCameraInput(position: CameraPosition, type: CameraType): Promise<CameraInput\>;

N
nikhilraut 已提交
285 286 287 288 289 290
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
291 292 293 294
Creates a **CameraInput** instance with the specified camera position and camera type. This method uses a promise to return the instance.

**Parameters**

J
jiangminyang 已提交
295 296 297 298
| Name     | Type                       | Mandatory | Description                            |
|----------|----------------------------|-----------|----------------------------------------|
| position | CameraPosition             | Yes       | Camera position                        |
| type     | CameraType                 | Yes       | Camera type                            |
N
nikhilraut 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

**Return values**

| Type                    | Description                                     |
|-------------------------|-------------------------------------------------|
| Promise<CameraInput\>   | Promise used to return the CameraInput instance |

**Example**

```
cameraManager.createCameraInput(cameraPosition, cameraType).then((cameraInput) => {
    console.log('Promise returned with the CameraInput instance.');
})
```

N
nikhilraut 已提交
314 315 316 317 318 319 320 321 322 323 324 325 326 327
### on(type: 'cameraStatus', callback: Callback<CameraStatusInfo\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for camera status changes. This method uses a callback to get camera status changes.

**Parameters**

| Name     | Type                   | Mandatory | Description                                          |
| :------- | :--------------------- | :-------- | :--------------------------------------------------- |
J
jiangminyang 已提交
328 329
| type     | string                 | Yes       | Camera status event.                                 |
| callback | Callback<CameraStatusInfo\> | Yes  | Callback used to get the camera status change.       |
N
nikhilraut 已提交
330 331 332 333 334 335 336 337 338 339

**Example**

```
cameraManager.on('cameraStatus', (cameraStatusInfo) => {
    console.log('camera : ' + cameraStatusInfo.camera.cameraId);
    console.log('status: ' + cameraStatusInfo.status);
})
```

N
nikhilraut 已提交
340 341
## Camera<a name="section_Camera"></a>

342 343 344 345 346
when we call *cameraManager.getCameras()* API, then it will return the **Camera** class which will have all camera-related metadata such as *cameraId, cameraPosition, cameraType & connectionType*.

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
347 348 349 350 351

**Fields**

| Name           | Type           | Access   | Description            |
|----------------|----------------|----------|------------------------|
352 353 354 355
| cameraId       | string         | readonly | Camera ID              |
| cameraPosition | cameraPosition | readonly | Camera position        |
| cameraType     | cameraType     | readonly | Camera type            |
| connectionType | connectionType | readonly | Camera connection type |
N
nikhilraut 已提交
356 357

```
358 359 360 361 362 363 364 365 366
async function getCameraInfo() {
    var cameraManager = await camera.getCameraManager();
    var cameras = await cameraManager.getCameras();
    var cameraObj = cameras[0];
    var cameraId = cameraObj.cameraId;
    var cameraPosition = cameraObj.cameraPosition;
    var cameraType = cameraObj.cameraType;
    var cameraId = cameraObj.connectionType;
}
N
nikhilraut 已提交
367 368 369

```

N
nikhilraut 已提交
370 371
## CameraStatusInfo<a name="section_Camera"></a>

372 373 374 375 376
This interface is a CameraManager callback API return. **CameraStatusInfo** will have *Camera* class & *CameraStatus* predefine constants.From *Camera* class, we can have all camera-related metadata & from *CameraStatus* constants, we will have information such as *APPEAR, DISAPPEAR, AVAILABLE & UNAVAILABLE*.

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
377 378 379 380 381

**Fields**

| Name           | Type           | Description      |
|----------------|----------------|------------------|
382 383
| camera         | Camera         | Camera object    |
| status         | CameraStatus   | Camera status    |
N
nikhilraut 已提交
384 385


N
nikhilraut 已提交
386 387 388 389 390 391
## CameraInput<a name="section_CameraInput"></a>

Implements a **CameraInput** instance.

### getCameraId(callback: AsyncCallback<string\>\): void;

N
nikhilraut 已提交
392 393 394 395 396 397
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
Gets the camera ID based on which this **CameraInput** instance is created. This method uses an asynchronous callback to return the camera ID.

**Parameters**

| Name     | Type                   | Mandatory | Description                           |
|----------|------------------------|-----------|---------------------------------------|
| callback | AsyncCallback<string\> | Yes       | Callback used to return the camera ID |

```
cameraInput.getCameraId((err, cameraId) => {
    if (err) {
        console.error('Failed to get the camera ID. ${err.message}');
        return;
    }
    console.log('Callback returned with the camera ID: ' + cameraId);
})
```

### getCameraId(): Promise<string\>;

N
nikhilraut 已提交
418 419 420 421 422 423
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
Gets the camera ID based on which this **CameraInput** instance is created. This method uses a promise to return the camera ID.

**Return values**

| Type                   | Description                          |
|------------------------|--------------------------------------|
| Promise<string\>       | Promise used to return the camera ID |

**Example**

```
cameraInput.getCameraId().then((cameraId) => {
    console.log('Promise returned with the camera ID:' + cameraId);
})
```

### hasFlash(callback: AsyncCallback<boolean\>): void; <a name="sec_hasFlash"></a>

N
nikhilraut 已提交
442 443 444 445 446 447
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
Checks whether the device has flash light. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                    | Mandatory | Description                                        |
|----------|-------------------------|-----------|----------------------------------------------------|
| callback | AsyncCallback<boolean\> | Yes       | Callback used to return the flash light support status |

**Example**

```
cameraInput.hasFlash((err, status) => {
    if (err) {
        console.error('Failed to check whether the device has flash light. ${err.message}');
        return;
    }
    console.log('Callback returned with flash light support status: ' + status);
})
```

### hasFlash(): Promise<boolean\>;

N
nikhilraut 已提交
470 471 472 473 474 475
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
Checks whether the device has flash light. This method uses a promise to return the result.

**Return values**

| Type                  | Description                                            |
|-----------------------|--------------------------------------------------------|
| Promise<boolean\>     | Promise used to return the flash light support status  |

**Example**

```
cameraInput.hasFlash().then((status) => {
    console.log('Promise returned with the flash light support status:' + status);
})
```

### isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean\>): void; <a name="sec_isFlashModeSupported"></a>

N
nikhilraut 已提交
494 495 496 497 498 499
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
Checks whether a specified flash mode is supported. This method uses an asynchronous callback to return the result.

**Parameters**

| Name      | Type                   | Mandatory | Description                                        |
|-----------|------------------------|-----------|----------------------------------------------------|
| flashMode | <a href="#sec_FlashMode">FlashMode</a>             | Yes       | Flash mode                                         |
| callback  | AsyncCallback<boolean\> | Yes       | Callback used to return the device flash support status |

**Example**

```
cameraInput.isFlashModeSupported(flashMode, (err, status) => {
    if (err) {
        console.error('Failed to check whether the flash mode is supported. ${err.message}');
        return;
    }
    console.log('Callback returned with the flash mode support status: ' + status);
})
```

### isFlashModeSupported(flashMode: FlashMode): Promise<boolean\>;

N
nikhilraut 已提交
523 524 525 526 527 528
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
Checks whether a specified flash mode is supported. This method uses a promise to return the result.

**Parameters**

| Name      | Type                   | Mandatory | Description                                        |
|-----------|------------------------|-----------|----------------------------------------------------|
| flashMode | <a href="#sec_FlashMode">FlashMode</a>             | Yes       | Flash mode                    |

**Return values**

| Type                  | Description                                       |
|-----------------------|---------------------------------------------------|
| Promise<boolean\>     | Promise used to return flash mode support status. |

**Example**

```
cameraInput.isFlashModeSupported(flashMode).then((status) => {
    console.log('Promise returned with flash mode support status.' + status);
})
```

### setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
553 554 555 556 557 558
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
Sets flash mode. This method uses an asynchronous callback to return the result.

Note: Before setting the flash mode, check the support for the flash light (<a href="#sec_hasFlash">hasFlash</a> method) and flash mode support (<a href="#sec_isFlashModeSupported">isFlashModeSupported</a> method);

**Parameters**

| Name      | Type                   | Mandatory | Description                                        |
|-----------|------------------------|-----------|----------------------------------------------------|
| flashMode | <a href="#sec_FlashMode">FlashMode</a>             | Yes       | Flash mode             |
| callback  | AsyncCallback<void\> | Yes       | Callback used to return the result         |

**Example**

```
cameraInput.setFlashMode(flashMode, (err) => {
    if (err) {
        console.error('Failed to set the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setFlashMode.');
})
```

### setFlashMode(flashMode: FlashMode): Promise<void\>;

N
nikhilraut 已提交
584 585 586 587 588 589
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
Sets flash mode. This method uses a promise to return the result.

Note: Before setting the flash mode, check the support for the flash light (<a href="#sec_hasFlash">hasFlash</a> method) and flash mode support (<a href="#sec_isFlashModeSupported">isFlashModeSupported</a> method);

**Parameters**

| Name      | Type                   | Mandatory | Description                                        |
|-----------|------------------------|-----------|----------------------------------------------------|
| flashMode | <a href="#sec_FlashMode">FlashMode</a>             | Yes       | Flash mode                    |

**Return values**

| Type                  | Description                             |
|-----------------------|-----------------------------------------|
| Promise<void\>        | Promise used to return the result       |

**Example**

```
609
cameraInput.setFlashMode(flashMode).then(() => {
N
nikhilraut 已提交
610 611 612 613 614 615
    console.log('Promise returned with the successful execution of setFlashMode.');
})
```

### getFlashMode(callback: AsyncCallback<FlashMode\>): void;

N
nikhilraut 已提交
616 617 618 619 620 621
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
Gets current flash mode. This method uses an asynchronous callback to return the result.

**Parameters**

| Name      | Type                      | Mandatory | Description                                    |
|-----------|---------------------------|-----------|------------------------------------------------|
| callback  | AsyncCallback<FlashMode\> | Yes       | Callback used to return the current flash mode |

**Example**

```
cameraInput.getFlashMode((err, flashMode) => {
    if (err) {
        console.error('Failed to get the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with current flash mode: ' + flashMode);
})
```

### getFlashMode(): Promise<FlashMode\>;

N
nikhilraut 已提交
644 645 646 647 648 649
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
650 651 652 653 654 655 656 657 658 659 660
Gets current flash mode. This method uses a promise to return the result.

**Return values**

| Type                  | Description                                       |
|-----------------------|---------------------------------------------------|
| Promise<FlashMode\>   | Promise used to return the flash mode             |

**Example**

```
661
cameraInput.getFlashMode().then((flashMode) => {
N
nikhilraut 已提交
662 663 664 665
    console.log('Promise returned with current flash mode : ' + flashMode);
})
```

N
nikhilraut 已提交
666
### isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean\>): void; <a name="sec_isFocusModeSupported"></a>
N
nikhilraut 已提交
667

N
nikhilraut 已提交
668
**System Capabilities:**
N
nikhilraut 已提交
669

N
nikhilraut 已提交
670
SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
671

N
nikhilraut 已提交
672
**Description**
N
nikhilraut 已提交
673

N
nikhilraut 已提交
674
Checks whether a specified focus mode is supported. This method uses an asynchronous callback to return the result.
N
nikhilraut 已提交
675 676 677

**Parameters**

N
nikhilraut 已提交
678 679 680 681
| Name      | Type                   | Mandatory | Description                                        |
|-----------|------------------------|-----------|----------------------------------------------------|
| afMode    | <a href="#sec_FocusMode">FocusMode</a>  | Yes       | Focus mode                        |
| callback  | AsyncCallback<boolean\> | Yes       | Callback used to return the device focus support status |
N
nikhilraut 已提交
682 683 684 685

**Example**

```
N
nikhilraut 已提交
686
cameraInput.isFocusModeSupported(afMode, (err, status) => {
N
nikhilraut 已提交
687
    if (err) {
N
nikhilraut 已提交
688
        console.error('Failed to check whether the focus mode is supported. ${err.message}');
N
nikhilraut 已提交
689 690
        return;
    }
N
nikhilraut 已提交
691 692
    console.log('Callback returned with the focus mode support status: ' + status);
})
N
nikhilraut 已提交
693 694
```

N
nikhilraut 已提交
695
### isFocusModeSupported(afMode: FocusMode): Promise<boolean\>;
N
nikhilraut 已提交
696

N
nikhilraut 已提交
697 698 699 700 701 702 703
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Checks whether a specified focus mode is supported. This method uses a promise to return the result.
N
nikhilraut 已提交
704 705 706

**Parameters**

N
nikhilraut 已提交
707 708 709
| Name      | Type                                   | Mandatory | Description |
|-----------|----------------------------------------|-----------|-------------|
| afMode    | <a href="#sec_FocusMode">FocusMode</a> | Yes       | Focus mode  |
N
nikhilraut 已提交
710 711 712

**Return values**

N
nikhilraut 已提交
713 714 715
| Type                  | Description                                       |
|-----------------------|---------------------------------------------------|
| Promise<boolean\>     | Promise used to return the focus mode support status. |
N
nikhilraut 已提交
716 717 718 719

**Example**

```
N
nikhilraut 已提交
720 721
cameraInput.isFocusModeSupported(afMode).then((status) => {
    console.log('Promise returned with focus mode support status.' + status);
N
nikhilraut 已提交
722 723 724
})
```

N
nikhilraut 已提交
725
### setFocusMode(afMode: FocusMode, callback: AsyncCallback<void\>): void;
N
nikhilraut 已提交
726

N
nikhilraut 已提交
727
**System Capabilities:**
N
nikhilraut 已提交
728

N
nikhilraut 已提交
729
SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
730

N
nikhilraut 已提交
731
**Description**
N
nikhilraut 已提交
732

N
nikhilraut 已提交
733
Sets focus mode. This method uses an asynchronous callback to return the result.
N
nikhilraut 已提交
734

N
nikhilraut 已提交
735
Note: Before setting the focus mode, check focus mode support (<a href="#sec_isFocusModeSupported">isFocusModeSupported</a> method);
N
nikhilraut 已提交
736

N
nikhilraut 已提交
737 738 739 740 741 742
**Parameters**

| Name      | Type                   | Mandatory | Description                        |
|-----------|------------------------|-----------|------------------------------------|
| afMode    | <a href="#sec_FocusMode">FocusMode</a> | Yes       | Focus mode         |
| callback  | AsyncCallback<void\>   | Yes       | Callback used to return the result |
N
nikhilraut 已提交
743 744 745 746

**Example**

```
N
nikhilraut 已提交
747
cameraInput.setFocusMode(afMode, (err) => {
N
nikhilraut 已提交
748
    if (err) {
N
nikhilraut 已提交
749
        console.error('Failed to set the focus mode  ${err.message}');
N
nikhilraut 已提交
750 751
        return;
    }
N
nikhilraut 已提交
752 753
    console.log('Callback returned with the successful execution of setFocusMode.');
})
N
nikhilraut 已提交
754 755
```

N
nikhilraut 已提交
756
### setFocusMode(afMode: FocusMode): Promise<void\>;
N
nikhilraut 已提交
757

N
nikhilraut 已提交
758 759 760 761 762 763 764 765 766
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Sets focus mode. This method uses a promise to return the result.

Note: Before setting the focus mode, check focus mode support (<a href="#sec_isFocusModeSupported">isFocusModeSupported</a> method);
N
nikhilraut 已提交
767 768 769

**Parameters**

N
nikhilraut 已提交
770 771 772
| Name      | Type                                    | Mandatory | Description |
|-----------|-----------------------------------------|-----------|-------------|
| afMode    | <a href="#sec_FocusMode">FocusMode</a>  | Yes       | Focus mode  |
N
nikhilraut 已提交
773 774 775

**Return values**

N
nikhilraut 已提交
776 777 778
| Type                  | Description                             |
|-----------------------|-----------------------------------------|
| Promise<void\>        | Promise used to return the result       |
N
nikhilraut 已提交
779 780 781 782

**Example**

```
783
cameraInput.setFocusMode(afMode).then(() => {
N
nikhilraut 已提交
784
    console.log('Promise returned with the successful execution of setFocusMode.');
N
nikhilraut 已提交
785 786 787
})
```

N
nikhilraut 已提交
788
### getFocusMode(callback: AsyncCallback<FocusMode\>): void;
N
nikhilraut 已提交
789

N
nikhilraut 已提交
790 791 792 793 794 795 796
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Gets the current focus mode. This method uses an asynchronous callback to return the result.
N
nikhilraut 已提交
797 798 799

**Parameters**

N
nikhilraut 已提交
800 801 802
| Name      | Type                      | Mandatory | Description                                    |
|-----------|---------------------------|-----------|------------------------------------------------|
| callback  | AsyncCallback<FocusMode\> | Yes       | Callback used to return the current focus mode |
N
nikhilraut 已提交
803 804 805 806

**Example**

```
N
nikhilraut 已提交
807
cameraInput.getFocusMode((err, afMode) => {
N
nikhilraut 已提交
808
    if (err) {
N
nikhilraut 已提交
809
        console.error('Failed to get the focus mode  ${err.message}');
N
nikhilraut 已提交
810 811
        return;
    }
N
nikhilraut 已提交
812 813
    console.log('Callback returned with current focus mode: ' + afMode);
})
N
nikhilraut 已提交
814 815
```

N
nikhilraut 已提交
816
### getFocusMode(): Promise<FocusMode\>;
N
nikhilraut 已提交
817

N
nikhilraut 已提交
818
**System Capabilities:**
N
nikhilraut 已提交
819

N
nikhilraut 已提交
820 821 822 823 824
SystemCapability.Multimedia.Camera.Core

**Description**

Gets the current focus mode. This method uses a promise to return the result.
N
nikhilraut 已提交
825 826 827

**Return values**

N
nikhilraut 已提交
828 829 830
| Type                  | Description                                       |
|-----------------------|---------------------------------------------------|
| Promise<FocusMode\>   | Promise used to return the focus mode             |
N
nikhilraut 已提交
831 832 833 834

**Example**

```
835
cameraInput.getFocusMode().then((afMode) => {
N
nikhilraut 已提交
836
    console.log('Promise returned with current focus mode : ' + afMode);
N
nikhilraut 已提交
837 838 839
})
```

N
nikhilraut 已提交
840
### getZoomRatioRange\(callback: AsyncCallback<Array<number\>\>\): void;
N
nikhilraut 已提交
841

N
nikhilraut 已提交
842 843 844 845 846 847 848
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Gets the zoom ratios of all zoom values. This method uses an asynchronous callback to return the result.
N
nikhilraut 已提交
849 850 851

**Parameters**

N
nikhilraut 已提交
852 853 854
| Name     | Type                           | Mandatory | Description                                     |
|----------|--------------------------------|-----------|-------------------------------------------------|
| callback | AsyncCallback<Array<number\>\> | Yes       | Callback used to return the zoom ratio range |
N
nikhilraut 已提交
855 856 857 858

**Example**

```
859
cameraInput.getZoomRatioRange((err, zoomRatioRange) => {
N
nikhilraut 已提交
860
    if (err) {
N
nikhilraut 已提交
861
        console.error('Failed to get the zoom ratio range. ${err.message}');
N
nikhilraut 已提交
862 863
        return;
    }
N
nikhilraut 已提交
864 865
    console.log('Callback returned with zoom ratio range: ' + zoomRatioRange.length);
})
N
nikhilraut 已提交
866 867
```

N
nikhilraut 已提交
868
### getZoomRatioRange\(\): Promise<Array<number\>\>;
N
nikhilraut 已提交
869

N
nikhilraut 已提交
870 871 872 873 874 875 876
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Gets the zoom ratios of all zoom values. This method uses a promise to return the result.
N
nikhilraut 已提交
877 878 879

**Return values**

N
nikhilraut 已提交
880 881 882
| Type                   | Description                                 |
|------------------------|---------------------------------------------|
| Promise<Array<number\>\> | Promise used to return the zoom ratio range |
N
nikhilraut 已提交
883 884 885 886

**Example**

```
N
nikhilraut 已提交
887 888
cameraInput.getZoomRatioRange().then((zoomRatioRange) => {
    console.log('Promise returned with zoom ratio range: ' + zoomRatioRange.length);
N
nikhilraut 已提交
889 890 891
})
```

N
nikhilraut 已提交
892
### setZoomRatio(zoomRatio: number, callback: AsyncCallback<void\>): void;
N
nikhilraut 已提交
893

N
nikhilraut 已提交
894
**System Capabilities:**
N
nikhilraut 已提交
895

N
nikhilraut 已提交
896
SystemCapability.Multimedia.Camera.Core
N
nikhilraut 已提交
897

N
nikhilraut 已提交
898
**Description**
N
nikhilraut 已提交
899

N
nikhilraut 已提交
900 901 902 903 904 905 906 907
Sets a zoom ratio. This method uses an asynchronous callback to return the result.

**Parameters**

| Name      | Type                   | Mandatory | Description                        |
|-----------|------------------------|-----------|------------------------------------|
| zoomRatio | number                 | Yes       | Zoom ratio                         |
| callback  | AsyncCallback<void\>   | Yes       | Callback used to return the result |
N
nikhilraut 已提交
908 909 910 911

**Example**

```
N
nikhilraut 已提交
912
cameraInput.setZoomRatio(zoomRatio, (err) => {
N
nikhilraut 已提交
913
    if (err) {
N
nikhilraut 已提交
914
        console.error('Failed to set the zoom ratio value ${err.message}');
N
nikhilraut 已提交
915 916
        return;
    }
N
nikhilraut 已提交
917 918
    console.log('Callback returned with the successful execution of setZoomRatio.');
})
N
nikhilraut 已提交
919 920
```

N
nikhilraut 已提交
921
### setZoomRatio(zoomRatio: number): Promise<void\>;
N
nikhilraut 已提交
922

N
nikhilraut 已提交
923 924 925 926 927 928 929
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Sets a zoom ratio. This method uses a promise to return the result.
N
nikhilraut 已提交
930 931 932

**Parameters**

N
nikhilraut 已提交
933 934 935
| Name      | Type     | Mandatory | Description |
|-----------|----------|-----------|-------------|
| zoomRatio | number   | Yes       | zoom ratio  |
N
nikhilraut 已提交
936 937 938

**Return values**

N
nikhilraut 已提交
939 940 941
| Type                  | Description                             |
|-----------------------|-----------------------------------------|
| Promise<void\>        | Promise used to return the result       |
N
nikhilraut 已提交
942 943 944 945

**Example**

```
946
cameraInput.setZoomRatio(zoomRatio).then(() => {
N
nikhilraut 已提交
947
    console.log('Promise returned with the successful execution of setZoomRatio.');
N
nikhilraut 已提交
948 949 950
})
```

N
nikhilraut 已提交
951
### getZoomRatio(callback: AsyncCallback<number\>): void;
N
nikhilraut 已提交
952

N
nikhilraut 已提交
953 954 955 956 957 958 959
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Gets current zoom ratio value. This method uses an asynchronous callback to return the result.
N
nikhilraut 已提交
960 961 962

**Parameters**

N
nikhilraut 已提交
963 964 965
| Name      | Type                      | Mandatory | Description                                          |
|-----------|---------------------------|-----------|------------------------------------------------------|
| callback  | AsyncCallback<number\>    | Yes       | Callback used to return the current zoom ratio value |
N
nikhilraut 已提交
966 967 968 969

**Example**

```
N
nikhilraut 已提交
970
cameraInput.getZoomRatio((err, zoomRatio) => {
N
nikhilraut 已提交
971
    if (err) {
N
nikhilraut 已提交
972
        console.error('Failed to get the zoom ratio ${err.message}');
N
nikhilraut 已提交
973 974
        return;
    }
N
nikhilraut 已提交
975 976
    console.log('Callback returned with current zoom ratio: ' + zoomRatio);
})
N
nikhilraut 已提交
977 978
```

N
nikhilraut 已提交
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
### getZoomRatio(): Promise<number\>;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Gets current zoom ratio value. This method uses a promise to return the result.

**Return values**

| Type                  | Description                                       |
|-----------------------|---------------------------------------------------|
| Promise<number\>      | Promise used to return the zoom ratio vaule       |

**Example**

```
998
cameraInput.getZoomRatio().then((zoomRatio) => {
N
nikhilraut 已提交
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    console.log('Promise returned with current zoom ratio : ' + zoomRatio);
})
```

### release\(callback: AsyncCallback<void\>\): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Releases this **CameraInput** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                        |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
cameraInput.release((err) => {
    if (err) {
        console.error('Failed to release the CameraInput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is released successfully.');
});
```

### release(): Promise<void\>;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Releases this **CameraInput** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
cameraInput.release().then(() => {
    console.log('Promise returned to indicate that the CameraInput instance is released successfully.');
})
```

### on(type: 'focusStateChange', callback: Callback<FocusState\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for focus state changes. This method uses a callback to get focus state changes.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type     | string                 | Yes       | Name of the event to listen for.                    |
| callback | Callback<FocusState\>  | Yes       | Callback used to get the focus state change.    |

**Example**

```
cameraInput.on('focusStateChange', (focusState) => {
    console.log('Focus state  : ' + focusState);
})
```

### on(type: 'error', callback: Callback<CameraInputError\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for **CameraInput** errors. This method uses a callback to get errors.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
J
jiangminyang 已提交
1094
| type     | string                 | Yes       | Camera input error event.                       |
N
nikhilraut 已提交
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
| callback | Callback<CameraInputError\> | Yes  | Callback used to get the camera input errors.   |

**Example**

```
cameraInput.on('error', (cameraInputError) => {
    console.log('Camera input error code: ' + cameraInputError.code);
})
```

## FlashMode <a name="sec_FlashMode"></a>

Enumerates the flash modes.

1109 1110 1111 1112
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
1113 1114
| Name                   | Default value | Description            |
|------------------------|---------------|------------------------|
1115 1116 1117 1118
| FLASH_MODE_CLOSE       | 0             | Flash mode close       |
| FLASH_MODE_OPEN        | 1             | Flash mode open        |
| FLASH_MODE_AUTO        | 2             | Flash mode auto        |
| FLASH_MODE_ALWAYS_OPEN | 3             | Flash mode always open |
N
nikhilraut 已提交
1119 1120 1121 1122 1123

## FocusMode <a name="sec_FocusMode"></a>

Enumerates the focus modes.

1124 1125 1126 1127
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
1128 1129
| Name                       | Default value | Description                |
|----------------------------|---------------|----------------------------|
1130 1131 1132 1133
| FOCUS_MODE_MANUAL          | 0             | Focus mode manual          |
| FOCUS_MODE_CONTINUOUS_AUTO | 1             | Focus mode continuous auto |
| FOCUS_MODE_AUTO            | 2             | Focus mode auto            |
| FOCUS_MODE_LOCKED          | 3             | Focus mode locked          |
N
nikhilraut 已提交
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154

## createCaptureSession\(context: Context, callback: AsyncCallback<CaptureSession\>\): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Creates a **CaptureSession** instance. This method uses an asynchronous callback to return the instance.

**Parameters**

| Name     | Type                           | Mandatory | Description                                         |
|----------|--------------------------------|-----------|-----------------------------------------------------|
| context  | Context                        | Yes       | Application context                                 |
| callback | AsyncCallback<CaptureSession\> | Yes       | Callback used to return the CaptureSession instance |

**Example**

```
1155
captureSession.createCaptureSession((context), (err, captureSession) => {
N
nikhilraut 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
    if (err) {
        console.error('Failed to create the CaptureSession instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CaptureSession instance.' + captureSession);
});
```

## createCaptureSession(context: Context\): Promise<CaptureSession\>;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Creates a **CaptureSession** instance. This method uses a promise to return the instance.

**Parameters**

| Name     | Type                          | Mandatory | Description                                         |
|----------|-------------------------------|-----------|-----------------------------------------------------|
| context  | Context                       | Yes       | Application context                                 |

**Return values**

| Type                      | Description                                       |
|---------------------------|---------------------------------------------------|
| Promise<CaptureSession\>  | Promise used to return the CaptureSession instance.   |

**Example**

```
captureSession.createCaptureSession(context).then((captureSession) => {
    console.log('Promise returned with the CaptureSession instance');
})
```

## CaptureSession<a name="sec_CaptureSession"></a>

Implements session capture.

### beginConfig\(callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Starts configuration for this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
captureSession.beginConfig((err) => {
    if (err) {
        console.error('Failed to start the configuration. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the begin config success.');
});
```

### beginConfig\(\): Promise<void\>;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Starts configuration for this CaptureSession instance. This method uses a promise to return the result.

**Return values**

| Type          | Description                                 |
|---------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
captureSession.beginConfig().then(() => {
    console.log('Promise returned to indicate the begin config success.');
})
```

### commitConfig\(callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Commits the configuration for this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                | Mandatory | Description                                  |
|----------|---------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
captureSession.commitConfig((err) => {
    if (err) {
        console.error('Failed to commit the configuration. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the commit config success.');
});
```

### commitConfig\(\): Promise<void\>;<a name="section189141826104616"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Commits the configuration for this CaptureSession instance. This method uses a promise to return the result.

**Return values**

| Type          | Description                                 |
|---------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
captureSession.commitConfig().then(() => {
    console.log('Promise returned to indicate the commit config success.');
})
```

### addInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Add a CameraInput instance to this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name        | Type                 | Mandatory | Description                                 |
|-------------|----------------------|-----------|---------------------------------------------|
| cameraInput | CameraInput          | Yes       | CameraInput instance to add                 |
| callback    | AsyncCallback<void\> | Yes       | Callback used to return the result          |

**Example**

```
captureSession.addInput(cameraInput, (err) => {
    if (err) {
        console.error('Failed to add the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is added.');
});
```

### addInput\(cameraInput: CameraInput\): Promise<void\>;<a name="section189141826104616"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Add a CameraInput instance to this CaptureSession instance. This method uses a promise to return the result.

**Parameters**

| Name        | Type                | Mandatory | Description                   |
|-------------|---------------------|-----------|-------------------------------|
| cameraInput | CameraInput         | Yes       | CameraInput instance to add   |

**Return values**

| Type           | Description                        |
|----------------|------------------------------------|
| Promise<void\> | Promise used to return the result  |

**Example**

```
captureSession.addInput(cameraInput).then(() => {
    console.log('Promise used to indicate that the CameraInput instance is added.');
})
```

### addOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Add a PreviewOutput instance to this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                 | Mandatory | Description                         |
|---------------|----------------------|-----------|-------------------------------------|
| previewOutput | PreviewOutput        | Yes       | PreviewOutput instance to add       |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result  |

**Example**

```
captureSession.addOutput(previewOutput, (err) => {
    if (err) {
        console.error('Failed to add the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is added.');
});
```

### addOutput\(previewOutput: PreviewOutput\): Promise<void\>;<a name="section189141826104616"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Add a PreviewOutput instance to this CaptureSession instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                    |
|---------------|---------------------|-----------|--------------------------------|
| previewOutput | PreviewOutput       | Yes       | PreviewOutput instance to add  |

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
captureSession.addOutput(previewOutput).then(() => {
    console.log('Promise used to indicate that the PreviewOutput instance is added.');
})
```

### addOutput\(photoOutput: PhotoOutput, callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Add a PhotoOutput instance to this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                         |
|---------------|---------------------|-----------|-------------------------------------|
| photoOutput   | PhotoOutput         | Yes       | PhotoOutput instance to add         |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
captureSession.addOutput(photoOutput, (err) => {
    if (err) {
        console.error('Failed to add the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is added.');
});
```

### addOutput\(photoOutput: PhotoOutput\): Promise<void\>;<a name="section189141826104616"></a>

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**
N
nikhilraut 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474

Add a PhotoOutput instance to this CaptureSession instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                    |
|---------------|---------------------|-----------|--------------------------------|
| photoOutput   | PhotoOutput         | Yes       | PhotoOutput instance to add    |

**Return values**

| Type          | Description                       |
|---------------|-----------------------------------|
| Promise<void> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1475
captureSession.addOutput(photoOutput).then(() => {
N
nikhilraut 已提交
1476 1477 1478 1479 1480 1481
    console.log('Promise used to indicate that the PhotoOutput instance is added.');
})
```

### addOutput\(videoOutput: VideoOutput, callback: AsyncCallback<void\>\): void;

N
nikhilraut 已提交
1482 1483 1484 1485 1486 1487
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
Add a VideoOutput instance to this CaptureSession instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                         |
|---------------|---------------------|-----------|-------------------------------------|
| videoOutput   | VideoOutput         | Yes       | VideoOutput instance to add         |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1500
captureSession.addOutput(videoOutput, (err) => {
N
nikhilraut 已提交
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
    if (err) {
        console.error('Failed to add the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is added.');
});
```

### addOutput\(videoOutput: VideoOutput\): Promise<void\>;

N
nikhilraut 已提交
1511 1512 1513 1514 1515 1516
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
Add a VideoOutput instance to this CaptureSession instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                    |
|---------------|---------------------|-----------|--------------------------------|
| videoOutput   | VideoOutput         | Yes       | VideoOutput instance to add    |

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1534
captureSession.addOutput(videoOutput).then(() => {
N
nikhilraut 已提交
1535 1536 1537 1538 1539 1540
    console.log('Promise used to indicate that the VideoOutput instance is added.');
})
```

### removeInput\(cameraInput: CameraInput, callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

N
nikhilraut 已提交
1541 1542 1543 1544 1545 1546
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
Removes a **CameraInput** instance from this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name        | Type                 | Mandatory | Description                        |
|-------------|----------------------|-----------|------------------------------------|
| cameraInput | CameraInput          | Yes       | CameraInput instance to remove     |
| callback    | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1559
captureSession.removeInput(cameraInput, (err) => {
N
nikhilraut 已提交
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
    if (err) {
        console.error('Failed to remove the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the cameraInput instance is removed.');
});
```

### removeInput\(cameraInput: CameraInput\): Promise<void\>;<a name="section189141826104616"></a>

N
nikhilraut 已提交
1570 1571 1572 1573 1574 1575
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
Removes a **CameraInput** instance from this **CaptureSession** instance. This method uses a promise to return the result.

**Parameters**

| Name        | Type                | Mandatory | Description                     |
|-------------|---------------------|-----------|---------------------------------|
| cameraInput | CameraInput         | Yes       | CameraInput instance to remove  |

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1593
captureSession.removeInput(cameraInput).then(() => {
N
nikhilraut 已提交
1594 1595 1596 1597 1598 1599
    console.log('Promise returned to indicate that the cameraInput instance is removed.');
})
```

### removeOutput\(previewOutput: PreviewOutput, callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

N
nikhilraut 已提交
1600 1601 1602 1603 1604 1605
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
Removes a **PreviewOutput** instance from this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                 | Mandatory | Description                        |
|---------------|----------------------|-----------|------------------------------------|
| previewOutput | PreviewOutput        | Yes       | PreviewOutput instance to remove   |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1618
captureSession.removeOutput(previewOutput, (err) => {
N
nikhilraut 已提交
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
    if (err) {
        console.error('Failed to remove the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is removed.');
});
```

### removeOutput(previewOutput: PreviewOutput): Promise<void\>;

N
nikhilraut 已提交
1629 1630 1631 1632 1633 1634
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653
Removes a **PreviewOutput** instance from this **CaptureSession** instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                       |
|---------------|---------------------|-----------|-----------------------------------|
| previewOutput | PreviewOutput       | Yes       | PreviewOutput instance to remove  |


**Return values**

| Type          | Description                                 |
|---------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
N
nikhilraut 已提交
1654
captureSession.removeOutput(previewOutput).then(() => {
N
nikhilraut 已提交
1655 1656 1657 1658 1659 1660
    console.log('Promise returned to indicate that the PreviewOutput instance is removed.');
})
```

### removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
1661 1662 1663 1664 1665 1666
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
Removes a **PhotoOutput** instance from this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                 | Mandatory | Description                        |
|---------------|----------------------|-----------|------------------------------------|
| photoOutput   | PhotoOutput          | Yes       | PhotoOutput instance to remove     |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1679
captureSession.removeOutput(photoOutput, (err) => {
N
nikhilraut 已提交
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
    if (err) {
        console.error('Failed to remove the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is removed.');
});
```

### removeOutput(photoOutput: PhotoOutput): Promise<void\>;

N
nikhilraut 已提交
1690 1691 1692 1693 1694 1695
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
Removes a **PhotoOutput** instance from this **CaptureSession** instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                     |
|---------------|---------------------|-----------|---------------------------------|
| photoOutput   | PhotoOutput         | Yes       | PhotoOutput instance to remove  |


**Return values**

| Type          | Description                        |
|---------------|------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
N
nikhilraut 已提交
1715
captureSession.removeOutput(photoOutput).then(() => {
N
nikhilraut 已提交
1716 1717 1718 1719 1720 1721
    console.log('Promise returned to indicate that the PhotoOutput instance is removed.');
})
```

### removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
1722 1723 1724 1725 1726 1727
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
Removes a **VideoOutput** instance from this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name          | Type                 | Mandatory | Description                        |
|---------------|----------------------|-----------|------------------------------------|
| videoOutput   | VideoOutput          | Yes       | VideoOutput instance to remove     |
| callback      | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1740
captureSession.removeOutput(videoOutput, (err) => {
N
nikhilraut 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
    if (err) {
        console.error('Failed to remove the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is removed.');
});
```

### removeOutput(videoOutput: VideoOutput): Promise<void\>;

N
nikhilraut 已提交
1751 1752 1753 1754 1755 1756
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
Removes a **VideoOutput** instance from this **CaptureSession** instance. This method uses a promise to return the result.

**Parameters**

| Name          | Type                | Mandatory | Description                     |
|---------------|---------------------|-----------|---------------------------------|
| videoOutput   | VideoOutput         | Yes       | VideoOutput instance to remove  |


**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
N
nikhilraut 已提交
1776
captureSession.removeOutput(videoOutput).then(() => {
N
nikhilraut 已提交
1777 1778 1779 1780 1781 1782
    console.log('Promise returned to indicate that the VideoOutput instance is removed.');
})
```

### start\(callback: AsyncCallback<void\>\): void;

N
nikhilraut 已提交
1783 1784 1785 1786 1787 1788
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
Starts this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1800
captureSession.start((err) => {
N
nikhilraut 已提交
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
    if (err) {
        console.error('Failed to start the session ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the session start success.');
});
```

### start\(\): Promise<void\>;<a name="section189141826104616"></a>

N
nikhilraut 已提交
1811 1812 1813 1814 1815 1816
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
Starts this **CaptureSession** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1828
captureSession.start().then(() => {
N
nikhilraut 已提交
1829 1830 1831 1832 1833 1834
    console.log('Promise returned to indicate the session start success.');
})
```

### stop\(callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

N
nikhilraut 已提交
1835 1836 1837 1838 1839 1840
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
Stops this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**


| Name     | Type                 | Mandatory | Description                        |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1853
captureSession.stop((err) => {
N
nikhilraut 已提交
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
    if (err) {
        console.error('Failed to stop the session ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the session stop success.');
});
```

### stop(): Promise<void\>;

N
nikhilraut 已提交
1864 1865 1866 1867 1868 1869
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
Stops this **CaptureSession** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1881
captureSession.stop().then(() => {
N
nikhilraut 已提交
1882 1883 1884 1885 1886 1887
    console.log('Promise returned to indicate the session stop success.');
})
```

### release\(callback: AsyncCallback<void\>\): void;<a name="section84581011418"></a>

N
nikhilraut 已提交
1888 1889 1890 1891 1892 1893
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
Releases this **CaptureSession** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                        |
|----------|----------------------|-----------|------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
N
nikhilraut 已提交
1905
captureSession.release((err) => {
N
nikhilraut 已提交
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915
    if (err) {
        console.error('Failed to release the CaptureSession instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CaptureSession instance is released successfully.');
});
```

### release(): Promise<void\>;

N
nikhilraut 已提交
1916 1917 1918 1919 1920 1921
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
Releases this **CaptureSession** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
N
nikhilraut 已提交
1933
captureSession.release().then(() => {
N
nikhilraut 已提交
1934 1935 1936 1937
    console.log('Promise returned to indicate that the CaptureSession instance is released successfully.');
})
```

N
nikhilraut 已提交
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
### on(type: 'error', callback: Callback<CaptureSessionError\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for **CaptureSession** errors. This method uses a callback to get errors.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
J
jiangminyang 已提交
1952
| type     | string                 | Yes       | Capture session error event.                    |
N
nikhilraut 已提交
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
| callback | Callback<CaptureSessionError\> | Yes  | Callback used to get the capture session errors. |

**Example**

```
captureSession.on('error', (captureSessionError) => {
    console.log('Capture session error code: ' + captureSessionError.code);
})
```

N
nikhilraut 已提交
1963 1964
## createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput\>): void;

N
nikhilraut 已提交
1965 1966 1967 1968 1969 1970
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
Creates a **PreviewOutput** instance. This method uses an asynchronous callback to return the instance.

**Parameters**

| Name       | Type                          | Mandatory | Description                                        |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId  | string                        | Yes       | Surface ID received from XComponent view           |
| callback   | AsyncCallback<PreviewOutput\> | Yes       | Callback used to return the PreviewOutput instance |

**Example**

```
1983
camera.createPreviewOutput((surfaceId), (err, previewOutput) => {
N
nikhilraut 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
    if (err) {
        console.error('Failed to create the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with previewOutput instance');
});
``` 

## createPreviewOutput(surfaceId: string): Promise<PreviewOutput>;

N
nikhilraut 已提交
1994 1995 1996 1997 1998 1999
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
Creates a **PreviewOutput** instance. This method uses a promise to return the instance.

**Parameters**

| Name       | Type            | Mandatory | Description                                        |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId  | string          | Yes       | Surface ID received from XComponent view           |

**Return values**

| Type                    | Description                                       |
|-------------------------|---------------------------------------------------|
| Promise<PreviewOutput\> | Promise used to return the PreviewOutput instance |

**Example**

```
camera.createPreviewOutput(surfaceId).then((previewOutput) => {
    console.log('Promise returned with the PreviewOutput instance');
})
```

## PreviewOutput

Implements preview output.

### release(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2028 2029 2030 2031 2032 2033
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
Releases this **PreviewOutput** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
previewOutput.release((err) => {
    if (err) {
        console.error('Failed to release the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
});
```

### release(): Promise<void\>;

N
nikhilraut 已提交
2056 2057 2058 2059 2060 2061
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
Releases this **PreviewOutput** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                       |
|----------------|-----------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
previewOutput.release().then(() => {
    console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
})
```

N
nikhilraut 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142
### on(type: 'frameStart', callback: Callback<number\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for preview frame start events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type              | Mandatory | Description                        |
| :------- | :---------------- | :-------- | :----------------------------------|
| type     | string            | Yes       | Name of the event to listen for.   |
| callback | Callback<void\>   | Yes       | Callback used to return the result |

**Example**

```
previewOutput.on('frameStart', () => {
    console.log('Preview frame started');
})
```

### on(type: 'frameEnd', callback: Callback<number\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for preview frame end event. This method uses a callback to get the event information.

**Parameters**

| Name     | Type              | Mandatory | Description                        |
| :------- | :---------------- | :-------- | :----------------------------------|
| type     | string            | Yes       | Name of the event to listen for.   |
| callback | Callback<void\>   | Yes       | Callback used to return the result |

**Example**

```
previewOutput.on('frameEnd', () => {
    console.log('Preview frame ended');
})
```

### on(type: 'error', callback: Callback<PreviewOutputError\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for **PreviewOutput** errors. This method uses a callback to get errors.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
J
jiangminyang 已提交
2143
| type     | string                 | Yes       | Preview output error event.                     |
N
nikhilraut 已提交
2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
| callback | Callback<PreviewOutputError\> | Yes  | Callback used to get the preview output errors. |

**Example**

```
previewOutput.on('error', (previewOutputError) => {
    console.log('Preview output error code: ' + previewOutputError.code);
})
```

N
nikhilraut 已提交
2154 2155
## createPhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput\>): void;

N
nikhilraut 已提交
2156 2157 2158 2159 2160 2161
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
Creates a **PhotoOutput** instance. This method uses an asynchronous callback to return the instance.

**Parameters**

| Name       | Type                          | Mandatory | Description                                        |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId  | string                        | Yes       | Surface ID received from ImageReceiver             |
| callback   | AsyncCallback<PhotoOutput\>   | Yes       | Callback used to return the PhotoOutput instance   |

**Example**

```
2174
camera.createPhotoOutput((surfaceId), (err, photoOutput) => {
N
nikhilraut 已提交
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
    if (err) {
        console.error('Failed to create the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the PhotoOutput instance.');
});
``` 

## createPhotoOutput(surfaceId: string): Promise<PhotoOutput\>;

N
nikhilraut 已提交
2185 2186 2187 2188 2189 2190
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215
Creates a **PhotoOutput** instance. This method uses a promise to return the PhotoOutput instance.

**Parameters**

| Name       | Type            | Mandatory | Description                                        |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId  | string          | Yes       | Surface ID received from ImageReceiver             |

**Return values**

| Type                    | Description                                      |
|-------------------------|--------------------------------------------------|
| Promise<PhotoOutput\>   | Promise used to return the PhotoOutput instance  |

**Example**

```
camera.createPhotoOutput(surfaceId).then((photoOutput) => {
    console.log('Promise returned with PhotoOutput instance');
})
```
## ImageRotation

Enumerates the image rotation angles.

2216 2217 2218 2219
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
2220 2221
| Name         | Default Value | Description                            |
|--------------|---------------|----------------------------------------|
2222 2223 2224 2225
| ROTATION_0   | 0             | The capture image rotates 0 degrees    |
| ROTATION_90  | 90            | The capture image rotates 90 degrees   |
| ROTATION_180 | 180           | The capture image rotates 180 degrees  |
| ROTATION_270 | 270           | The capture image rotates 270 degrees  |
N
nikhilraut 已提交
2226 2227 2228 2229 2230 2231


## Location

Defines the location of a captured image.

2232 2233 2234 2235
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
2236 2237
| Name      | Type   | Access       | Description |
|-----------|--------|--------------|-------------|
2238 2239
| latitude  | number | read / write | Latitude    |
| longitude | number | read / write | Longitude   |
N
nikhilraut 已提交
2240 2241 2242 2243 2244

## QualityLevel

Enumerates the image quality levels.

2245 2246 2247 2248
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
2249 2250
| Name                 | Default value | Description          |
|----------------------|---------------|----------------------|
2251 2252 2253
| QUALITY_LEVEL_HIGH   | 0             | High image quality   |
| QUALITY_LEVEL_MEDIUM | 1             | Medium image quality |
| QUALITY_LEVEL_LOW    | 2             | Low image quality    |
N
nikhilraut 已提交
2254 2255 2256 2257 2258 2259


## PhotoCaptureSetting

Defines the settings for image capture.

2260 2261 2262 2263
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

N
nikhilraut 已提交
2264 2265
| Name     | Type          | Mandatory | Description         |
|----------|---------------|-----------|---------------------|
2266 2267
| quality  | QualityLevel  | Optional  | Photo image quality |
| rotation | ImageRotation | Optional  | Photo rotation      |
N
nikhilraut 已提交
2268 2269 2270 2271 2272 2273 2274 2275


## PhotoOutput

Implements photo output.

### capture(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2276 2277 2278 2279 2280 2281
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
Captures a photo. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                | Mandatory | Description                                  |
|----------|---------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
photoOutput.capture((err) => {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});
```

### capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2304 2305 2306 2307 2308 2309
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332
Captures a photo with the specified capture settings. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| setting  | PhotoCaptureSetting  | Yes       | Photo capture settings                       |
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
photoOutput.capture(settings, (err) => {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});
```

### capture(setting?: PhotoCaptureSetting): Promise<void\>;

N
nikhilraut 已提交
2333 2334 2335 2336 2337 2338
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
Captures a photo with the specified capture settings. This method uses a promise to return the result.

**Parameters**

| Name     | Type                | Mandatory | Description                                  |
|----------|---------------------|-----------|----------------------------------------------|
| setting  | PhotoCaptureSetting | No        | Photo capture settings                       |

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
photoOutput.capture().then(() => {
    console.log('Promise returned to indicate that photo capture request success.');
})
```

### release(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2364 2365 2366 2367 2368 2369
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
Releases this **PhotoOutput** instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
photoOutput.release((err) => {
    if (err) {
        console.error('Failed to release the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is released successfully.');
});
```

### release(): Promise<void\>;

N
nikhilraut 已提交
2392 2393 2394 2395 2396 2397
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414
Releases this **PhotoOutput** instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
photoOutput.release().then(() => {
    console.log('Promise returned to indicate that the PhotoOutput instance is released successfully.');
})
```

N
nikhilraut 已提交
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505
### on(type: 'captureStart', callback: Callback<number\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for photo capture start events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type     | string                 | Yes       | Name of the event to listen for.                |
| callback | Callback<number\>      | Yes       | Callback used to get the capture ID.            |

**Example**

```
photoOutput.on('captureStart', (captureId) => {
    console.log('photo capture stated, captureId : ' + captureId);
})
```

### on(type: 'frameShutter', callback: Callback<FrameShutterInfo\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for frame shutter events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
| type     | string                 | Yes       | Name of the event to listen for.                |
| callback | Callback<FrameShutterInfo\> | Yes   | Callback used to get the frame shutter information.|

**Example**

```
photoOutput.on('frameShutter', (frameShutterInfo) => {
    console.log('photo capture end, captureId : ' + frameShutterInfo.captureId);
    console.log('Timestamp for frame : ' + frameShutterInfo.timestamp);
})
```

### on(type: 'captureEnd', callback: Callback<CaptureEndInfo\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for photo capture end events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type                   | Mandatory | Description                                      |
| :------- | :--------------------- | :-------- | :------------------------------------------------|
| type     | string                 | Yes       | Name of the event to listen for.                 |
| callback | Callback<CaptureEndInfo\> | Yes    | Callback used to get the capture end information |

**Example**

```
photoOutput.on('captureEnd', (captureEndInfo) => {
    console.log('photo capture end, captureId : ' + captureEndInfo.captureId);
    console.log('frameCount : ' + captureEndInfo.frameCount);
})
```

### on(type: 'error', callback: Callback<PhotoOutputError\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for **PhotoOutput** errors. This method uses a callback to get errors.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
J
jiangminyang 已提交
2506
| type     | string                 | Yes       | Photo output error event.                       |
N
nikhilraut 已提交
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
| callback | Callback<PhotoOutputError\> | Yes  | Callback used to get the photo output errors.   |

**Example**

```
photoOutput.on('error', (photoOutputError) => {
    console.log('Photo output error code: ' + photoOutputError.code);
})
```

N
nikhilraut 已提交
2517 2518
## createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput\>): void;

N
nikhilraut 已提交
2519 2520 2521 2522 2523 2524
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
Creates a **VideoOutput** instance. This method uses an asynchronous callback to return the instance.

**Parameters**

| Name       | Type                          | Mandatory | Description                                        |
|------------|-------------------------------|-----------|----------------------------------------------------|
| surfaceId  | string                        | Yes       | Surface ID received from VideoRecorder             |
| callback   | AsyncCallback<VideoOutput\>   | Yes       | Callback used to return the VideoOutput instance   |

**Example**

```
2537
camera.createVideoOutput((surfaceId), (err, videoOutput) => {
N
nikhilraut 已提交
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547
    if (err) {
        console.error('Failed to create the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the VideoOutput instance');
});
``` 

## createVideoOutput(surfaceId: string): Promise<VideoOutput\>;

N
nikhilraut 已提交
2548 2549 2550 2551 2552 2553
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
Creates a **VideoOutput** instance. This method uses a promise to return the VideoOutput instance.

**Parameters**

| Name       | Type            | Mandatory | Description                                        |
|------------|-----------------|-----------|----------------------------------------------------|
| surfaceId  | string          | Yes       | Surface ID received from VideoRecorder             |

**Return values**

J
jiangminyang 已提交
2564 2565 2566
| Type                                  | Description                                     |
|---------------------------------------|-------------------------------------------------|
| Promise<[VideoOutput](#videooutput)\> | Promise used to return the VideoOutput instance |
N
nikhilraut 已提交
2567 2568 2569 2570 2571 2572 2573 2574

**Example**

```
camera.createVideoOutput(surfaceId).then((videoOutput) => {
    console.log('Promise returned with the VideoOutput instance');
})
```
N
nikhilraut 已提交
2575 2576 2577
## VideoOutput

Implements video output.
N
nikhilraut 已提交
2578 2579 2580

### start(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2581 2582 2583 2584 2585 2586
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
Starts the video output. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
videoOutput.start((err) => {
    if (err) {
        console.error('Failed to start the video output ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the video output start success.');
});
```

### start(): Promise<void\>;

N
nikhilraut 已提交
2609 2610 2611 2612 2613 2614
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
Starts the video output. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |


**Example**

```
videoOutput.start().then(() => {
    console.log('Promise returned to indicate that start method execution success.');
})
```

### stop(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2634 2635 2636 2637 2638 2639
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
Stops the video output. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
videoOutput.stop((err) => {
    if (err) {
        console.error('Failed to stop the video output ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the video output stop success.');
});
```

### stop(): Promise<void\>;

N
nikhilraut 已提交
2662 2663 2664 2665 2666 2667
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685
Stops the video output. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result |

**Example**

```
videoOutput.start().then(() => {
    console.log('Promise returned to indicate that stop method execution success.');
})
```

### release(callback: AsyncCallback<void\>): void;

N
nikhilraut 已提交
2686 2687 2688 2689 2690 2691
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
Releases this VideoOutput instance. This method uses an asynchronous callback to return the result.

**Parameters**

| Name     | Type                 | Mandatory | Description                                  |
|----------|----------------------|-----------|----------------------------------------------|
| callback | AsyncCallback<void\> | Yes       | Callback used to return the result |

**Example**

```
videoOutput.release((err) => {
    if (err) {
        console.error('Failed to release the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is released successfully.');
});
```

### release(): Promise<void\>;

N
nikhilraut 已提交
2714 2715 2716 2717 2718 2719
**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

N
nikhilraut 已提交
2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
Releases this VideoOutput instance. This method uses a promise to return the result.

**Return values**

| Type           | Description                                 |
|----------------|---------------------------------------------|
| Promise<void\> | Promise used to return the result           |


**Example**

```
videoOutput.release().then(() => {
    console.log('Promise returned to indicate that the VideoOutput instance is released successfully.');
})
N
nikhilraut 已提交
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788
```

### on(type: 'frameStart', callback: Callback<number\>): void;

**System Capabilities:**

SystemCapability.Multimedia.Camera.Core

**Description**

Listens for video frame start events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type              | Mandatory | Description                        |
| :------- | :---------------- | :-------- | :----------------------------------|
| type     | string            | Yes       | Name of the event to listen for.       |
| callback | Callback<void\>   | Yes       | Callback used to return the result |

**Example**

```
videoOutput.on('frameStart', () => {
    console.log('Video frame started');
})
```

### on(type: 'frameEnd', callback: Callback<number\>): void;

Listens for video frame end events. This method uses a callback to get the event information.

**Parameters**

| Name     | Type              | Mandatory | Description                        |
| :------- | :---------------- | :-------- | :----------------------------------|
| type     | string            | Yes       | Name of the event to listen for.   |
| callback | Callback<void\>   | Yes       | Callback used to return the result |

**Example**

```
videoOutput.on('frameEnd', () => {
    console.log('Video frame ended');
})
```

### on(type: 'error', callback: Callback<VideoOutputError\>): void;

Listens for **VideoOutput** errors. This method uses a callback to get errors.

**Parameters**

| Name     | Type                   | Mandatory | Description                                     |
| :------- | :--------------------- | :-------- | :-----------------------------------------------|
J
jiangminyang 已提交
2789
| type     | string                 | Yes       | Video output error event.                       |
N
nikhilraut 已提交
2790 2791 2792 2793 2794 2795 2796 2797
| callback | Callback<VideoOutputError\> | Yes  | Callback used to get the video output errors.   |

**Example**

```
videoOutput.on('error', (VideoOutputError) => {
    console.log('Video output error code: ' + VideoOutputError.code);
})
N
nikhilraut 已提交
2798
```