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