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
40**起始版本：** 3.1
41
42**参数:**
43
44| 名称 | 描述 |
45| -------- | -------- |
46| info | 表示指向灯信息的二级指针。 |
47
48**返回：**
49
50如果操作成功，则返回0。
51
52如果操作失败，则返回负值。
53
54
55### TurnOffLight()
56
57```
58ILightInterface::TurnOffLight ([in] int lightId)
59```
60**描述**
61
62根据指定的灯类型ID关闭列表中的可用灯。
63
64**起始版本：** 3.1
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```
82ILightInterface::TurnOnLight ([in] int lightId, [in] struct HdfLightEffect effect )
83```
84**描述**
85
86根据指定的灯类型ID打开列表中的可用灯。
87
88**起始版本：** 3.1
89
90**参数:**
91
92| 名称 | 描述 |
93| -------- | -------- |
94| lightId | 表示灯类型ID。详见[HdfLightId](_light.md#hdflightid)。  |
95| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置。详见[HdfLightEffect](_hdf_light_effect_v10.md)。 |
96
97**返回：**
98
99如果操作成功，则返回0。
100
101如果不支持灯类型ID，则返回-1。
102
103如果不支持闪烁设置，则返回-2。
104
105如果不支持亮度设置，则返回-3。
106
107
108### TurnOnMultiLights()
109
110```
111ILightInterface::TurnOnMultiLights ([in] int lightId, [in] struct HdfLightColor[] colors )
112```
113**描述**
114
115根据指定的灯类型ID打开相应灯中包含的多个子灯。
116
117**起始版本：** 3.2
118
119**参数:**
120
121| 名称 | 描述 |
122| -------- | -------- |
123| lightId | 表示灯类型ID，详见[HdfLightId](_light.md#hdflightid)。  |
124| colors | 多个子灯对应的颜色和亮度, 详见[HdfLightColor](_hdf_light_color_v10.md)。 |
125
126**返回：**
127
128如果操作成功，则返回0。
129
130如果操作失败，则返回负值。
131