开源鸿蒙 LightInterface

LightInterface

所属模块:

Public 属性	描述
( GetLightInfo )([out] struct LightInfo *lightInfo, [out] uint32_t count)	获取当前系统中所有类型的灯信息。 更多…
( TurnOnLight )([in] uint32_t lightId, [in] struct LightEffect *effect)	根据指定的灯ID打开列表中的可用灯。 更多…
( TurnOffLight )([in] uint32_t lightId)	根据指定的灯ID关闭列表中的可用灯。 更多…

定义可以在灯上执行的基本操作。

操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。

int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out] uint32_t *count)

描述：

获取当前系统中所有类型的灯信息。

参数：

名称	描述
lightInfo	表示指向灯信息的二级指针，详见LightInfo。
count	表示指向灯数量的指针。

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId)

描述：

根据指定的灯ID关闭列表中的可用灯。

参数：

名称	描述
lightId	表示灯ID，详见LightId。

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightEffect *effect)

描述：

根据指定的灯ID打开列表中的可用灯。

参数：

名称	描述
lightId	表示灯ID，详见LightId。
effect	表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见LightEffect。