程序包 ohos.sensor.agent

类 CategoryLightAgent

java.lang.Object

ohos.sensor.agent.SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

ohos.sensor.agent.CategoryLightAgent

public class CategoryLightAgent
extends SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

Inherits from SensorAgent and manages light sensors on hardware devices.

This class is used to obtain all light sensors, a type of sensors in the light sensor category, and the first sensor of a specific type, and set or release the sensor data callback.

When you need to obtain information such as the proximity, ambient light, and color temperature, you can call this class to obtain a specific sensor and set the sensor data callback. You can also release the sensor data callback when the sensor data is unneeded.

从以下版本开始:

1

另请参阅:

SensorBase, SensorAgent, CategoryLight, CategoryLightData, ICategoryLightDataCallback

SystemCapability

SystemCapability.Sensors#SENSOR

字段概要

从类继承的字段 ohos.sensor.agent.SensorAgent

SENSOR_CATEGORY_BODY, SENSOR_CATEGORY_DEVICEMOTION, SENSOR_CATEGORY_ENVIRONMENT, SENSOR_CATEGORY_LIGHT, SENSOR_CATEGORY_ORIENTATION, SENSOR_CATEGORY_OTHER, SENSOR_SAMPLING_RATE_FASTEST, SENSOR_SAMPLING_RATE_GAME, SENSOR_SAMPLING_RATE_NORMAL, SENSOR_SAMPLING_RATE_UI, STRING_SENSOR_CATEGORY_BODY, STRING_SENSOR_CATEGORY_DEVICEMOTION, STRING_SENSOR_CATEGORY_ENVIRONMENT, STRING_SENSOR_CATEGORY_LIGHT, STRING_SENSOR_CATEGORY_ORIENTATION, STRING_SENSOR_CATEGORY_OTHER

构造器概要

构造器

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

方法概要

限定符和类型	方法	说明
List<CategoryLight>	getAllSensors()	Obtains all light sensors.
List<CategoryLight>	getAllSensors(int sensorType)	Obtains a specified type of sensors in the light category.
CategoryLight	getSingleSensor(int sensorType)	Obtains the default sensor of a specified type in the light category.
boolean	releaseSensorDataCallback(ICategoryLightDataCallback callback)	Releases the callback for all light sensors.
boolean	releaseSensorDataCallback(ICategoryLightDataCallback callback, CategoryLight sensor)	Releases the callback for a light sensor.
boolean	setSensorDataCallback(ICategoryLightDataCallback callback, CategoryLight sensor, int mode)	Sets a callback for a light sensor to receive sensor data in a specified sampling mode.
boolean	setSensorDataCallback(ICategoryLightDataCallback callback, CategoryLight sensor, int mode, long maxDelay)	Sets a callback for a light sensor to receive sensor data in a specified sampling mode based on the maximum event reporting latency.
boolean	setSensorDataCallback(ICategoryLightDataCallback callback, CategoryLight sensor, long interval)	Sets a callback for a light sensor to receive the sensor data at a specified sampling interval.
boolean	setSensorDataCallback(ICategoryLightDataCallback callback, CategoryLight sensor, long interval, long maxDelay)	Sets a callback for a light sensor to receive the sensor data at a specified sampling interval based on the maximum event reporting latency.

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

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

从类继承的方法 ohos.sensor.agent.SensorAgent

getSensorMinSampleInterval, runCommand, subscribeParamsCheck

构造器详细资料

CategoryLightAgent

public CategoryLightAgent()

Default constructor used to create a CategoryLightAgent instance.

从以下版本开始:

1

方法详细资料

getAllSensors

public List<CategoryLight> getAllSensors()

Obtains all light sensors.

Light sensors include proximity sensors, Time of Flight (ToF) sensors, ambient light sensors, color temperature sensors, and color sensors.

指定者:

getAllSensors 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

返回:

Returns a list of light sensors.

从以下版本开始:

1

另请参阅:

getAllSensors(int), getSingleSensor(int), CategoryLight

getAllSensors

public List<CategoryLight> getAllSensors(int sensorType)

Obtains a specified type of sensors in the light category.

指定者:

getAllSensors 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

sensorType - Indicates a sensor type in the light category. CategoryLight defines the sensor types using integer constants. For example, you can set CategoryLight.SENSOR_TYPE_PROXIMITY for this parameter to obtain proximity sensors.

返回:

Returns a list of sensors of the specified type; returns an empty list if the specified sensor type does not exist.

从以下版本开始:

1

另请参阅:

getAllSensors(), getSingleSensor(int), CategoryLight

getSingleSensor

public CategoryLight getSingleSensor(int sensorType)

Obtains the default sensor of a specified type in the light category.

The default sensor is the first sensor of a specified type in the light category.

指定者:

getSingleSensor 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

sensorType - Indicates a sensor type in the light category. CategoryLight defines the sensor types using integer constants. For example, you can set CategoryLight.SENSOR_TYPE_PROXIMITY for this parameter to obtain proximity sensors.

返回:

Returns the first sensor of the specified type in the light category if multiple sensors of this type are available; returns null if the specified sensor type does not exist.

从以下版本开始:

1

另请参阅:

getAllSensors(), getAllSensors(int), CategoryLight

setSensorDataCallback

public boolean setSensorDataCallback(ICategoryLightDataCallback callback,
                                     CategoryLight sensor,
                                     long interval)

Sets a callback for a light sensor to receive the sensor data at a specified sampling interval.

参数:

callback - Indicates the callback ICategoryLightDataCallback to set for receiving light sensor data. If this parameter is null, setting the callback fails.

sensor - Indicates the sensor for which the callback is to be set. If this parameter is null, setting the callback fails.

interval - Indicates the sampling interval, in nanoseconds. The sampling interval may vary depending on the sensor type. You can use the SensorBase.getMinInterval() and SensorBase.getMaxInterval() methods to obtain the minimum sampling interval and maximum sampling interval of the sensor, respectively, and then set the value of this parameter in between. If the configured parameter value is smaller than the minimum sampling interval of the sensor, the minimum sampling interval is used. If the configured parameter value is larger than the maximum sampling interval of the sensor, the maximum sampling interval is used.

返回:

Returns true if the callback is set successfully; returns false otherwise.

从以下版本开始:

1

另请参阅:

setSensorDataCallback(ICategoryLightDataCallback, CategoryLight, long, long), ICategoryLightDataCallback, CategoryLight

setSensorDataCallback

public boolean setSensorDataCallback(ICategoryLightDataCallback callback,
                                     CategoryLight sensor,
                                     long interval,
                                     long maxDelay)

Sets a callback for a light sensor to receive the sensor data at a specified sampling interval based on the maximum event reporting latency.

指定者:

setSensorDataCallback 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

callback - Indicates the callback ICategoryLightDataCallback to set for receiving light sensor data. If this parameter is null, setting the callback fails.

sensor - Indicates the sensor for which the callback is to be set. If this parameter is null, setting the callback fails.

interval - Indicates the sampling interval, in nanoseconds. The sampling interval may vary depending on the sensor type. You can use the SensorBase.getMinInterval() and SensorBase.getMaxInterval() methods to obtain the minimum sampling interval and maximum sampling interval of the sensor, respectively, and then set the value of this parameter in between. If the configured parameter value is smaller than the minimum sampling interval of the sensor, the minimum sampling interval is used. If the configured parameter value is larger than the maximum sampling interval of the sensor, the maximum sampling interval is used.

maxDelay - Indicates the maximum latency for the sensor to report events to the application in nanoseconds, based on the first in first out (FIFO) policy of the hardware. The maximum latency may vary depending on the sensor.

返回:

Returns true if the callback is set successfully; returns false otherwise.

从以下版本开始:

1

另请参阅:

ICategoryLightDataCallback, CategoryLight

setSensorDataCallback

public boolean setSensorDataCallback(ICategoryLightDataCallback callback,
                                     CategoryLight sensor,
                                     int mode)

Sets a callback for a light sensor to receive sensor data in a specified sampling mode.

指定者:

setSensorDataCallback 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

callback - Indicates the callback ICategoryLightDataCallback to set for receiving light sensor data. If this parameter is null, setting the callback fails.

sensor - Indicates the sensor for which the callback is to be set. If this parameter is null, setting the callback fails.

mode - Indicates the sampling mode. Each sampling mode represents a sampling rate, including the fastest sampling rate, sampling rate in gaming scenarios, sampling rate on UIs, and default sampling rate. For example, you can set the fastest sampling rate of the sensor via SensorAgent#SENSOR_SAMPLING_RATE_FASTEST.

返回:

Returns true if the callback is set successfully; returns false otherwise.

从以下版本开始:

4

setSensorDataCallback

public boolean setSensorDataCallback(ICategoryLightDataCallback callback,
                                     CategoryLight sensor,
                                     int mode,
                                     long maxDelay)

Sets a callback for a light sensor to receive sensor data in a specified sampling mode based on the maximum event reporting latency.

指定者:

setSensorDataCallback 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

callback - Indicates the callback ICategoryLightDataCallback to set for receiving light sensor data. If this parameter is null, setting the callback fails.

sensor - Indicates the sensor for which the callback is to be set. If this parameter is null, setting the callback fails.

mode - Indicates the sampling mode. Each sampling mode represents a sampling rate, including the fastest sampling rate, sampling rate in gaming scenarios, sampling rate on UIs, and default sampling rate. For example, you can set the fastest sampling rate of the sensor via SensorAgent#SENSOR_SAMPLING_RATE_FASTEST.

maxDelay - Indicates the maximum latency (in nanoseconds) for the sensor to report events to the application, based on the first in first out (FIFO) policy of the hardware. The maximum latency may vary depending on the sensor.

返回:

Returns true if the callback is set successfully; returns false otherwise.

从以下版本开始:

4

releaseSensorDataCallback

public boolean releaseSensorDataCallback(ICategoryLightDataCallback callback,
                                         CategoryLight sensor)

Releases the callback for a light sensor.

指定者:

releaseSensorDataCallback 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

callback - Indicates the callback ICategoryLightDataCallback set for receiving light sensor data. If this parameter is null, releasing the callback fails.

sensor - Indicates the sensor for which the callback is to be released. If this parameter is null, the callback of all light sensors will be released.

返回:

Returns true if the callback is released successfully; returns false otherwise.

从以下版本开始:

1

另请参阅:

ICategoryLightDataCallback, CategoryLight

releaseSensorDataCallback

public boolean releaseSensorDataCallback(ICategoryLightDataCallback callback)

Releases the callback for all light sensors.

指定者:

releaseSensorDataCallback 在类中 SensorAgent<CategoryLight,CategoryLightData,ICategoryLightDataCallback>

参数:

callback - Indicates the callback ICategoryLightDataCallback set for receiving light sensor data. If this parameter is null, releasing the callback fails.

返回:

Returns true if the callback is released successfully; returns false otherwise.

从以下版本开始:

1

另请参阅:

ICategoryLightDataCallback