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