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