InputReporter

Overview

Related Modules:

Input

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 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 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 otherwise.