1# Light
2
3
4## 概述
5
6灯驱动对灯服务提供通用的接口能力。
7
8灯模块为灯服务提供通用的接口去访问灯驱动，服务获取灯驱动对象或代理后，可以通过调用的APIs接口获取相关的灯信息。 例如打开或关闭灯、根据灯类型ID设置灯闪烁模式。
9
10**起始版本：** 3.1
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [ILightInterface.idl](_i_light_interface_8idl.md) | 定义灯模块的通用接口能力，包括获取灯类型ID、打开或关闭灯光、设置灯的亮度和闪烁模式。 |
21| [LightTypes.idl](_light_types_8idl.md) | 定义灯的数据结构，包括灯类型ID、灯的基本信息、灯的模式、灯的闪烁参数、灯的颜色模式和灯的效果参数。 |
22
23
24### 类
25
26| 名称 | 描述 |
27| -------- | -------- |
28| interface  [ILightInterface](interface_i_light_interface_v10.md) | 提供灯模块基本操作接口。 |
29| struct  [HdfLightInfo](_hdf_light_info_v10.md) | 定义灯的基本信息。 |
30| struct  [HdfLightFlashEffect](_hdf_light_flash_effect_v10.md) | 定义灯的闪烁参数。 |
31| struct  [RGBColor](_r_g_b_color_v10.md) | 定义灯的RGB模式。 |
32| struct  [WRGBColor](_w_r_g_b_color_v10.md) | 定义灯的WRGB模式。 |
33| union  [ColorValue](union_color_value_v10.md) | 定义灯的颜色模式。 |
34| struct  [HdfLightColor](_hdf_light_color_v10.md) | 定义亮灯参数。 |
35| struct  [HdfLightEffect](_hdf_light_effect_v10.md) | 定义灯的效果参数。 |
36
37
38### 枚举
39
40| 名称 | 描述 |
41| -------- | -------- |
42| [HdfLightId](#hdflightid) { HDF_LIGHT_ID_BATTERY = 1, HDF_LIGHT_ID_NOTIFICATIONS = 2, HDF_LIGHT_ID_ATTENTION = 3, HDF_LIGHT_ID_BUTT = 4 } | 枚举灯类型。 |
43| [HdfLightFlashMode](#hdflightflashmode) { HDF_LIGHT_FLASH_NONE = 0, HDF_LIGHT_FLASH_TIMED = 1, HDF_LIGHT_FLASH_GRADIENT = 2, HDF_LIGHT_FLASH_BUTT = 3 } | 枚举灯的模式。 |
44
45
46## 枚举类型说明
47
48
49### HdfLightFlashMode
50
51```
52enum HdfLightFlashMode
53```
54
55**描述**
56
57
58枚举灯的模式。
59
60**起始版本：** 3.1
61
62| 枚举值 | 描述 |
63| -------- | -------- |
64| HDF_LIGHT_FLASH_NONE | 常亮模式。 |
65| HDF_LIGHT_FLASH_BLINK | 闪烁模式。 |
66| HDF_LIGHT_FLASH_GRADIENT | 渐变。 |
67| HDF_LIGHT_FLASH_BUTT | 无效模式。 |
68
69
70### HdfLightId
71
72```
73enum HdfLightId
74```
75
76**描述**
77
78
79枚举灯类型。
80
81**起始版本：** 3.1
82
83| 枚举值 | 描述 |
84| -------- | -------- |
85| HDF_LIGHT_ID_BATTERY | 电源指示灯。 |
86| HDF_LIGHT_ID_NOTIFICATIONS | 通知灯。 |
87| HDF_LIGHT_ID_ATTENTION | 报警灯。 |
88| HDF_LIGHT_ID_BUTT | 无效ID。 |
89