文件名称:
InputReporter.md
所在目录:
Openharmony v1.0 / docs / api / api-SmartVision-Devices
文件大小:
8.01 KB
下载地址:
文本预览:
# InputReporter
## **Overview**
**Related Modules:**
[Input](Input.md)
**Description:**
Provides interfaces for reporting event data of input devices.
The interfaces include the callback for reporting the input event data and the functions for obtaining the data in polling mode.
## **Summary**
## Data Fields
## **Details**
## **Field Documentation**
## GetInputEvent
```
int32_t(* InputReporter::GetInputEvent) (uint32_t devIndex, [InputEventData](InputEventData.md) *eventData)
```
**Description:**
Gets the input event data.
This function enables the input service to proactively obtain the input event data in polling mode.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
## RegisterReportCallback
```
int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, [InputReportEventCb](InputReportEventCb.md) *callback)
```
**Description:**
Registers a callback for reporting subscribed data of specified input devices.
After this callback is successfully registered, the driver can report the input event data to the input service through this callback.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
## UnregisterReportCallback
```
int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex)
```
**Description:**
Unregisters the callback for reporting subscribed data of specified input devices.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
## **Overview**
**Related Modules:**
[Input](Input.md)
**Description:**
Provides interfaces for reporting event data of input devices.
The interfaces include the callback for reporting the input event data and the functions for obtaining the data in polling mode.
## **Summary**
## Data Fields
RegisterReportCallback )(uint32_t devIndex, InputReportEventCb *callback) | Registers a callback for reporting subscribed data of specified input devices. |
UnregisterReportCallback )(uint32_t devIndex) | Unregisters the callback for reporting subscribed data of specified input devices. |
GetInputEvent )(uint32_t devIndex, InputEventData *eventData) |
## **Details**
## **Field Documentation**
## GetInputEvent
```
int32_t(* InputReporter::GetInputEvent) (uint32_t devIndex, [InputEventData](InputEventData.md) *eventData)
```
**Description:**
Gets the input event data.
This function enables the input service to proactively obtain the input event data in polling mode.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
## RegisterReportCallback
```
int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, [InputReportEventCb](InputReportEventCb.md) *callback)
```
**Description:**
Registers a callback for reporting subscribed data of specified input devices.
After this callback is successfully registered, the driver can report the input event data to the input service through this callback.
**Parameters:**
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
## UnregisterReportCallback
```
int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex)
```
**Description:**
Unregisters the callback for reporting subscribed data of specified input devices.
**Parameters:**
devIndex | Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device. |
**Returns:**
Returns **0** if the operation is successful; returns an error code defined in [RetStatus](Input.md#ga85d58a5185669daa4995e332b63eba7a) otherwise.
点赞
回复
X