程序包 ohos.light.agent

类 LightAgent

java.lang.Object

ohos.light.agent.LightAgent

public class LightAgent
extends Object

Manages lights on hardware devices.

This class allows you to query a light based on its ID, check whether the light supports a specific blinking effect, enable the light to blink with a certain effect, and turn on or off the light.

从以下版本开始:

1

另请参阅:

LightEffect

SystemCapability

SystemCapability.Sensors#MISC_DEVICE

构造器概要

构造器

构造器	说明
LightAgent()	Default constructor used to create a LightAgent instance.

方法概要

限定符和类型	方法	说明
List<Integer>	getLightIdList()	Obtains the IDs of all lights on the device.
boolean	isEffectSupport(int lightId, String effectId)	Checks whether a specified light supports a preset blinking effect.
boolean	isSupport(int lightId)	Checks whether a specified light exists on the hardware device.
boolean	turnOff()	Turns off this light.
boolean	turnOff(int lightId)	Turns off a specified light.
boolean	turnOn(int lightId, String effectId)	Turns on a specified light to perform a one-shot blink with a preset blinking effect.
boolean	turnOn(int lightId, LightEffect lightEffect)	Turns on a specified light to perform a one-shot blink with a custom effect.
boolean	turnOn(String effectId)	Turns on this light to perform a one-shot blink with a preset blinking effect.
boolean	turnOn(LightEffect lightEffect)	Turns on this light to perform a one-shot blink with a custom blinking effect.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

LightAgent

public LightAgent()

Default constructor used to create a LightAgent instance.

从以下版本开始:

1

方法详细资料

getLightIdList

public List<Integer> getLightIdList()

Obtains the IDs of all lights on the device.

This method can be used when you want to query the IDs of all lights on the device.

返回:

Returns the IDs of all lights on the device.

从以下版本开始:

1

isSupport

public boolean isSupport(int lightId)

Checks whether a specified light exists on the hardware device.

This method can be used when you do not know whether a light exists on the device.

参数:

lightId - Indicates the ID of the light. You can use the getLightIdList() method to obtain the light ID list.

返回:

Returns true if the light exists; returns false otherwise.

从以下版本开始:

1

isEffectSupport

public boolean isEffectSupport(int lightId,
                               String effectId)

Checks whether a specified light supports a preset blinking effect.

Call this method to check whether the light supports a specific blinking effect before enabling the light to blink with this effect.

参数:

lightId - Indicates the ID of the light. You can use the getLightIdList() method to obtain the light ID list.

effectId - Indicates the preset blinking effect, which is described in LightEffect.

返回:

Returns true if the light supports the specified blinking effect; returns false otherwise.

从以下版本开始:

1

turnOn

public boolean turnOn(int lightId,
                      String effectId)

Turns on a specified light to perform a one-shot blink with a preset blinking effect.

参数:

lightId - Indicates the ID of the light. You can use the getLightIdList() method to obtain the light ID list.

effectId - Indicates the preset blinking effect, which is described in LightEffect.

返回:

Returns true if the light blinks as expected; returns false otherwise, for example, the preset blinking effect is not supported.

从以下版本开始:

1

turnOn

public boolean turnOn(int lightId,
                      LightEffect lightEffect)

Turns on a specified light to perform a one-shot blink with a custom effect.

You can customize a blinking effect in LightEffect.

参数:

lightId - Indicates the ID of the light. You can use the getLightIdList() method to obtain the light ID list.

lightEffect - Indicates a custom blinking effect. The custom blinking effects can be obtained using LightEffect(LightBrightness, int, int).

返回:

Returns true if the light blinks as expected; returns false otherwise, for example, the custom blinking effect is not supported.

从以下版本开始:

1

另请参阅:

LightEffect

turnOn

public boolean turnOn(String effectId)

Turns on this light to perform a one-shot blink with a preset blinking effect.

参数:

effectId - Indicates the preset blinking effect, which is described in LightEffect.

返回:

Returns true if the light blinks as expected; returns false otherwise, for example, the preset blinking effect is not supported.

从以下版本开始:

1

turnOn

public boolean turnOn(LightEffect lightEffect)

Turns on this light to perform a one-shot blink with a custom blinking effect.

You can customize a blinking effect in LightEffect.

参数:

lightEffect - Indicates a custom blinking effect. The custom blinking effects can be obtained using LightEffect(LightBrightness, int, int).

返回:

Returns true if the light blinks as expected; returns false otherwise, for example, the custom blinking effect is not supported.

从以下版本开始:

1

另请参阅:

LightEffect

turnOff

public boolean turnOff(int lightId)

Turns off a specified light.

This method can be used to turn off the light when you no longer need it.

参数:

lightId - Indicates the ID of the light. You can use the getLightIdList() method to obtain the light ID list.

返回:

Returns true if the light is turned off; returns false otherwise.

从以下版本开始:

1

turnOff

public boolean turnOff()

Turns off this light.

This method can be used to turn off the light when you no longer need it.

返回:

Returns true if the light is turned off; returns false otherwise.

从以下版本开始:

1