• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Interface (Flash)
2<!--Kit: Camera Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @qano-->
5<!--Designer: @leo_ysl-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9> **说明：**
10>
11> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
12> - 本Interface首批接口从API version 11开始支持。
13
14Flash 继承自 [FlashQuery](arkts-apis-camera-FlashQuery.md)。
15
16闪光灯类，对设备闪光灯操作。
17
18## 导入模块
19
20```ts
21import { camera } from '@kit.CameraKit';
22```
23
24## setFlashMode<sup>11+</sup>
25
26setFlashMode(flashMode: FlashMode): void
27
28设置闪光灯模式。
29
30进行设置之前，需要先检查：
31
321. 设备是否支持闪光灯，可使用方法[hasFlash](arkts-apis-camera-FlashQuery.md#hasflash11)。
332. 设备是否支持指定的闪光灯模式，可使用方法[isFlashModeSupported](arkts-apis-camera-FlashQuery.md#isflashmodesupported11)。
34
35**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。
36
37**系统能力：** SystemCapability.Multimedia.Camera.Core
38
39**参数：**
40
41| 参数名       | 类型                     | 必填 | 说明                  |
42| --------- | ----------------------- | ---- | --------------------- |
43| flashMode | [FlashMode](arkts-apis-camera-e.md#flashmode) | 是   | 指定闪光灯模式。传参为null或者undefined，作为0处理，闪光灯关闭。       |
44
45**错误码：**
46
47以下错误码的详细介绍请参见[Camera错误码](errorcode-camera.md)。
48
49| 错误码ID         | 错误信息        |
50| --------------- | --------------- |
51| 7400103                |  Session not config.                                   |
52
53**示例：**
54
55```ts
56import { BusinessError } from '@kit.BasicServicesKit';
57
58function setFlashMode(photoSession: camera.PhotoSession): void {
59  try {
60    photoSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
61  } catch (error) {
62    // 失败返回错误码error.code并处理。
63    let err = error as BusinessError;
64    console.error(`The setFlashMode call failed. error code: ${err.code}`);
65  }
66}
67```
68
69## getFlashMode<sup>11+</sup>
70
71getFlashMode(): FlashMode
72
73获取当前设备的闪光灯模式。
74
75**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。
76
77**系统能力：** SystemCapability.Multimedia.Camera.Core
78
79**返回值：**
80
81| 类型        | 说明                          |
82| ---------- | ----------------------------- |
83| [FlashMode](arkts-apis-camera-e.md#flashmode)    | 获取当前设备的闪光灯模式。接口调用失败会返回相应错误码，错误码类型[CameraErrorCode](arkts-apis-camera-e.md#cameraerrorcode)。 |
84
85**错误码：**
86
87以下错误码的详细介绍请参见[Camera错误码](errorcode-camera.md)。
88
89| 错误码ID         | 错误信息        |
90| --------------- | --------------- |
91| 7400103                |  Session not config.                                   |
92
93**示例：**
94
95```ts
96import { BusinessError } from '@kit.BasicServicesKit';
97
98function getFlashMode(photoSession: camera.PhotoSession): camera.FlashMode | undefined {
99  let flashMode: camera.FlashMode | undefined = undefined;
100  try {
101    flashMode = photoSession.getFlashMode();
102  } catch (error) {
103    // 失败返回错误码error.code并处理。
104    let err = error as BusinessError;
105    console.error(`The getFlashMode call failed.error code: ${err.code}`);
106  }
107  return flashMode;
108}
109```
110