1# ILightInterface 2 3 4## 概述 5 6提供灯模块基本操作接口。 7 8操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 9 10**起始版本：** 3.1 11 12**相关模块：**[Light](_light.md) 13 14 15## 汇总 16 17 18### Public 成员函数 19 20| 名称 | 描述 | 21| -------- | -------- | 22| [GetLightInfo](#getlightinfo) ([out] struct [HdfLightInfo](_hdf_light_info_v10.md)[] info) | 获取当前系统中所有类型的灯信息。 | 23| [TurnOnLight](#turnonlight) ([in] int lightId, [in] struct [HdfLightEffect](_hdf_light_effect_v10.md) effect) | 根据指定的灯类型ID打开列表中的可用灯。 | 24| [TurnOnMultiLights](#turnonmultilights) ([in] int lightId, [in] struct [HdfLightColor](_hdf_light_color_v10.md)[] colors) | 根据指定的灯类型ID打开相应灯中包含的多个子灯。 | 25| [TurnOffLight](#turnofflight) ([in] int lightId) | 根据指定的灯类型ID关闭列表中的可用灯。 | 26 27 28## 成员函数说明 29 30 31### GetLightInfo() 32 33``` 34ILightInterface::GetLightInfo ([out] struct HdfLightInfo[] info) 35``` 36**描述** 37获取当前系统中所有类型的灯信息。 38 39**起始版本：** 3.1 40 41**参数:** 42 43| 名称 | 描述 | 44| -------- | -------- | 45| info | 表示指向灯信息的二级指针。 | 46 47**返回：** 48 49如果操作成功，则返回0。 50 51如果操作失败，则返回负值。 52 53 54### TurnOffLight() 55 56``` 57ILightInterface::TurnOffLight ([in] int lightId) 58``` 59**描述** 60根据指定的灯类型ID关闭列表中的可用灯。 61 62**起始版本：** 3.1 63 64**参数:** 65 66| 名称 | 描述 | 67| -------- | -------- | 68| lightId | 表示灯类型ID，详见[HdfLightId](_light.md#hdflightid)。 | 69 70**返回：** 71 72如果操作成功，则返回0。 73 74如果操作失败，则返回负值。 75 76 77### TurnOnLight() 78 79``` 80ILightInterface::TurnOnLight ([in] int lightId, [in] struct HdfLightEffect effect ) 81``` 82**描述** 83根据指定的灯类型ID打开列表中的可用灯。 84 85**起始版本：** 3.1 86 87**参数:** 88 89| 名称 | 描述 | 90| -------- | -------- | 91| lightId | 表示灯类型ID。详见[HdfLightId](_light.md#hdflightid)。 | 92| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置。详见[HdfLightEffect](_hdf_light_effect_v10.md)。 | 93 94**返回：** 95 96如果操作成功，则返回0。 97 98如果不支持灯类型ID，则返回-1。 99 100如果不支持闪烁设置，则返回-2。 101 102如果不支持亮度设置，则返回-3。 103 104 105### TurnOnMultiLights() 106 107``` 108ILightInterface::TurnOnMultiLights ([in] int lightId, [in] struct HdfLightColor[] colors ) 109``` 110**描述** 111根据指定的灯类型ID打开相应灯中包含的多个子灯。 112 113**起始版本：** 3.2 114 115**参数:** 116 117| 名称 | 描述 | 118| -------- | -------- | 119| lightId | 表示灯类型ID，详见[HdfLightId](_light.md#hdflightid)。 | 120| colors | 多个子灯对应的颜色和亮度, 详见[HdfLightColor](_hdf_light_color_v10.md)。 | 121 122**返回：** 123 124如果操作成功，则返回0。 125 126如果操作失败，则返回负值。 127