SensorAgent

java.lang.Object
- ohos.sensor.agent.SensorAgent<S,D,L>

类型参数:

S - Indicates a sensor.

D - Indicates sensor data.

L - Indicates the callback for receiving sensor data.

直接已知子类:

CategoryBodyAgent, CategoryEnvironmentAgent, CategoryLightAgent, CategoryMotionAgent, CategoryOrientationAgent, CategoryOtherAgent
```
public abstract class SensorAgent<S extends SensorBase,D extends SensorData<S>,L extends ISensorDataCallback<D,S>>
extends Object
```
An abstract base class that manages sensors on hardware devices.
This class abstracts sensors on hardware devices and provides abstract methods.

从以下版本开始:

1

SystemCapability

SystemCapability.Sensors#SENSOR

字段概要

字段
限定符和类型	字段	说明
`static int`	`SENSOR_CATEGORY_BODY`	Describes body sensors.
`static int`	`SENSOR_CATEGORY_DEVICEMOTION`	Describes motion sensors of devices.
`static int`	`SENSOR_CATEGORY_ENVIRONMENT`	Describes environment sensors.
`static int`	`SENSOR_CATEGORY_LIGHT`	Describes light sensors.
`static int`	`SENSOR_CATEGORY_ORIENTATION`	Describes orientation sensors.
`static int`	`SENSOR_CATEGORY_OTHER`	Describes other sensors.
`static int`	`SENSOR_SAMPLING_RATE_FASTEST`	Indicates the fastest sampling rate for obtaining sensor data.
`static int`	`SENSOR_SAMPLING_RATE_GAME`	Indicates the sampling rate for obtaining sensor data in gaming scenarios.
`static int`	`SENSOR_SAMPLING_RATE_NORMAL`	Indicates the default sampling rate for obtaining sensor data, for example, in screen rotation scenarios.
`static int`	`SENSOR_SAMPLING_RATE_UI`	Indicates the sampling rate for obtaining sensor data on UIs.
`static String`	`STRING_SENSOR_CATEGORY_BODY`	Describes body sensors using a string of characters.
`static String`	`STRING_SENSOR_CATEGORY_DEVICEMOTION`	Describes motion sensors using a string of characters.
`static String`	`STRING_SENSOR_CATEGORY_ENVIRONMENT`	Describes environment sensors using a string of characters.
`static String`	`STRING_SENSOR_CATEGORY_LIGHT`	Describes light sensors using a string of characters.
`static String`	`STRING_SENSOR_CATEGORY_ORIENTATION`	Describes orientation sensors using a string of characters.
`static String`	`STRING_SENSOR_CATEGORY_OTHER`	Describes sensors in the other category (a category other than motion, environment, orientation, light, and body) using a string of characters.

构造器概要

构造器
构造器说明

SensorAgent()
Default constructor used to create a SensorAgent instance.

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

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`abstract List<S>`	`getAllSensors()`	Obtains a specified category of sensors.
`abstract List<S>`	`getAllSensors(int sensorType)`	Obtains a specified type of sensors in a sensor category.
`long`	`getSensorMinSampleInterval(int sensorId)`	Queries the minimum sampling interval of a sensor.
`abstract S`	`getSingleSensor(int sensorType)`	Obtains the default sensor of a specified type in a sensor category.
`abstract boolean`	`releaseSensorDataCallback(L callback)`	Releases the callback for all sensors.
`abstract boolean`	`releaseSensorDataCallback(L callback, S sensor)`	Releases the callback for a sensor.
`int`	`runCommand(int sensorId, int commandType, int commandParameter)`	Executes the specified command for a sensor based on the given parameter.
`abstract boolean`	`setSensorDataCallback(L callback, S sensor, int mode)`	Sets a callback for a sensor to receive sensor data in a specified sampling mode.
`abstract boolean`	`setSensorDataCallback(L callback, S sensor, int mode, long maxDelay)`	Sets a callback for a sensor to receive sensor data in a specified sampling mode based on the maximum event reporting latency.
`abstract boolean`	`setSensorDataCallback(L callback, S sensor, long interval, long maxDelay)`	Sets a callback for a sensor to receive the sensor data at a specified sampling interval based on the maximum event reporting latency.
`protected boolean`	`subscribeParamsCheck(L callback, S sensor, long interval, long maxDelay)`	Checks the validity of subscription parameters.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SENSOR_CATEGORY_BODY
```
public static final int SENSOR_CATEGORY_BODY
```
    Describes body sensors.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - SENSOR_CATEGORY_DEVICEMOTION
```
public static final int SENSOR_CATEGORY_DEVICEMOTION
```
    Describes motion sensors of devices.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_CATEGORY_ENVIRONMENT
```
public static final int SENSOR_CATEGORY_ENVIRONMENT
```
    Describes environment sensors.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_CATEGORY_LIGHT
```
public static final int SENSOR_CATEGORY_LIGHT
```
    Describes light sensors.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_CATEGORY_ORIENTATION
```
public static final int SENSOR_CATEGORY_ORIENTATION
```
    Describes orientation sensors.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_CATEGORY_OTHER
```
public static final int SENSOR_CATEGORY_OTHER
```
    Describes other sensors.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_SAMPLING_RATE_FASTEST
```
public static final int SENSOR_SAMPLING_RATE_FASTEST
```
    Indicates the fastest sampling rate for obtaining sensor data.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_SAMPLING_RATE_GAME
```
public static final int SENSOR_SAMPLING_RATE_GAME
```
    Indicates the sampling rate for obtaining sensor data in gaming scenarios.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_SAMPLING_RATE_NORMAL
```
public static final int SENSOR_SAMPLING_RATE_NORMAL
```
    Indicates the default sampling rate for obtaining sensor data, for example, in screen rotation scenarios.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - SENSOR_SAMPLING_RATE_UI
```
public static final int SENSOR_SAMPLING_RATE_UI
```
    Indicates the sampling rate for obtaining sensor data on UIs.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_BODY
```
public static final String STRING_SENSOR_CATEGORY_BODY
```
    Describes body sensors using a string of characters.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_DEVICEMOTION
```
public static final String STRING_SENSOR_CATEGORY_DEVICEMOTION
```
    Describes motion sensors using a string of characters.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_ENVIRONMENT
```
public static final String STRING_SENSOR_CATEGORY_ENVIRONMENT
```
    Describes environment sensors using a string of characters.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_LIGHT
```
public static final String STRING_SENSOR_CATEGORY_LIGHT
```
    Describes light sensors using a string of characters.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_ORIENTATION
```
public static final String STRING_SENSOR_CATEGORY_ORIENTATION
```
    Describes orientation sensors using a string of characters.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - STRING_SENSOR_CATEGORY_OTHER
```
public static final String STRING_SENSOR_CATEGORY_OTHER
```
    Describes sensors in the other category (a category other than motion, environment, orientation, light, and body) using a string of characters.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - SensorAgent
```
public SensorAgent()
```
    Default constructor used to create a SensorAgent instance.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - subscribeParamsCheck
```
protected boolean subscribeParamsCheck(L callback,
                                       S sensor,
                                       long interval,
                                       long maxDelay)
```
    Checks the validity of subscription parameters.
    
    参数:
    
    callback - Indicates the callback for receiving the sensor data.
    
    sensor - Indicates the sensor for which the callback is to be set.
    
    interval - Indicates the sampling interval, in nanoseconds.
    
    maxDelay - Indicates the maximum latency for the sensor to report events to the application, in nanoseconds.
    
    返回:
    
    Returns true if the input parameters are valid; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getAllSensors
```
public abstract List<S> getAllSensors()
```
    Obtains a specified category of sensors.
    
    返回:
    
    Returns a list of sensors of the specified category.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    getAllSensors(int), getSingleSensor(int)
  - getAllSensors
```
public abstract List<S> getAllSensors(int sensorType)
```
    Obtains a specified type of sensors in a sensor category.
    
    参数:
    
    sensorType - Indicates a type in the sensor category.
    
    返回:
    
    Returns a list of sensors of the specified type.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    getAllSensors(), getSingleSensor(int)
  - getSingleSensor
```
public abstract S getSingleSensor(int sensorType)
```
    Obtains the default sensor of a specified type in a sensor category.
    The default sensor is the first sensor of a specified type in a sensor category.
    
    参数:
    
    sensorType - Indicates a type in the sensor category.
    
    返回:
    
    Returns the default sensor of a specified type in the sensor category.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    getAllSensors(), getAllSensors(int)
  - setSensorDataCallback
```
public abstract boolean setSensorDataCallback(L callback,
                                              S sensor,
                                              long interval,
                                              long maxDelay)
```
    Sets a callback for a sensor to receive the sensor data at a specified sampling interval based on the maximum event reporting latency.
    
    参数:
    
    callback - Indicates the callback to set for receiving 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
  - setSensorDataCallback
```
public abstract boolean setSensorDataCallback(L callback,
                                              S sensor,
                                              int mode)
```
    Sets a callback for a sensor to receive sensor data in a specified sampling mode.
    
    参数:
    
    callback - Indicates the callback to set for receiving 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 abstract boolean setSensorDataCallback(L callback,
                                              S sensor,
                                              int mode,
                                              long maxDelay)
```
    Sets a callback for a sensor to receive sensor data in a specified sampling mode based on the maximum event reporting latency.
    
    参数:
    
    callback - Indicates the callback to set for receiving 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 abstract boolean releaseSensorDataCallback(L callback,
                                                  S sensor)
```
    Releases the callback for a sensor.
    
    参数:
    
    callback - Indicates the callback set for receiving 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 sensors in the category will be released.
    
    返回:
    
    Returns true if the callback is released successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - releaseSensorDataCallback
```
public abstract boolean releaseSensorDataCallback(L callback)
```
    Releases the callback for all sensors.
    
    参数:
    
    callback - Indicates the callback set for receiving sensor data. If this parameter is null, releasing the callback fails.
    
    返回:
    
    Returns true if the callback is released successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getSensorMinSampleInterval
```
public long getSensorMinSampleInterval(int sensorId)
```
    Queries the minimum sampling interval of a sensor.
    You can query this value and set the sampling interval accordingly.
    
    参数:
    
    sensorId - Indicates the ID of a sensor. You can use the SensorBase.getSensorId() method to obtain the sensor ID.
    
    返回:
    
    Returns the minimum sampling interval of the sensor.
    
    从以下版本开始:
    
    1
  - runCommand
```
public int runCommand(int sensorId,
                      int commandType,
                      int commandParameter)
```
    Executes the specified command for a sensor based on the given parameter.
    
    参数:
    
    sensorId - Indicates the ID of a sensor. You can use the SensorBase.getSensorId() method to obtain the sensor ID.
    
    commandType - Indicates the type of the command to execute. SensorBase defines the constants to store the command types. For example, you can pass SensorBase.COMMAND_TYPE_FLUSH to this parameter to flush data.
    
    commandParameter - Indicates the parameter of the command to execute. SensorBase defines the constants to store the command parameters. For example, you can pass SensorBase.COMMAND_PARAMETER_FLUSH to this parameter to flush data.
    
    返回:
    
    Returns the command execution result.
    
    从以下版本开始:
    
    3

类 SensorAgent<S extends SensorBase,D extends SensorData<S>,L extends ISensorDataCallback<D,S>>

字段概要

构造器概要

方法概要

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

字段详细资料

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

构造器详细资料

SensorAgent

方法详细资料

subscribeParamsCheck

getAllSensors

getAllSensors

getSingleSensor

setSensorDataCallback

setSensorDataCallback

setSensorDataCallback

releaseSensorDataCallback

releaseSensorDataCallback

getSensorMinSampleInterval

runCommand