IInputInterfaces

概述

Input模块向上层服务提供了统一接口。

上层服务开发人员可根据Input模块提供的向上统一接口实现Input设备的打开和关闭、Input事件获取、设备信息查询、回调函数注册、特性状态控制等功能。

起始版本： 3.2

相关模块：HdiInput

汇总

Public 成员函数

成员函数说明

CloseInputDevice()

IInputInterfaces::CloseInputDevice ([in] unsigned int devIndex)

描述 Input服务关闭对应设备的设备文件。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetChipInfo()

IInputInterfaces::GetChipInfo ([in] unsigned int devIndex, [out] String chipInfo )

描述 获取devIndex对应的Input设备的编码信息。

一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetChipName()

IInputInterfaces::GetChipName ([in] unsigned int devIndex, [out] String chipName )

描述 获取devIndex对应的Input设备的驱动芯片名。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetDeviceType()

IInputInterfaces::GetDeviceType ([in] unsigned int devIndex, [out] unsigned int deviceType )

描述 获取devIndex对应的Input设备的类型。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetInputDevice()

IInputInterfaces::GetInputDevice ([in] unsigned int devIndex, [out] struct DeviceInfo devInfo )

描述 Input服务获取devIndex对应的Input设备信息。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetInputDeviceList()

IInputInterfaces::GetInputDeviceList ([out] unsigned int devNum, [out] struct DeviceInfo[] devList, [in] unsigned int size )

描述 Input服务获取所有Input设备列表的设备信息。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetPowerStatus()

IInputInterfaces::GetPowerStatus ([in] unsigned int devIndex, [out] unsigned int status )

描述 获取devIndex对应Input设备的电源状态。

在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

GetVendorName()

IInputInterfaces::GetVendorName ([in] unsigned int devIndex, [out] String vendorName )

描述 获取devIndex对应的Input设备的模组厂商名。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

OpenInputDevice()

IInputInterfaces::OpenInputDevice ([in] unsigned int devIndex)

描述 Input服务打开对应设备的设备文件。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

RegisterHotPlugCallback()

IInputInterfaces::RegisterHotPlugCallback ([in] IInputCallback hotPlugCallback)

描述 注册Input设备的热插拔回调函数。

Input服务通过此接口注册回调函数到HDI中，所有Input设备由此函数进行热插拔事件上报。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

RegisterReportCallback()

IInputInterfaces::RegisterReportCallback ([in] unsigned int devIndex, [in] IInputCallback eventPkgCallback )

描述 注册devIndex对应的Input设备的回调函数。

Input服务通过此接口注册数据回调函数到HDI中，HDI通过此回调函数上报Input事件。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

RunCapacitanceTest()

IInputInterfaces::RunCapacitanceTest ([in] unsigned int devIndex, [in] unsigned int testType, [out] String result, [in] unsigned int length )

描述 执行容值自检测试。

启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

RunExtraCommand()

IInputInterfaces::RunExtraCommand ([in] unsigned int devIndex, [in] struct ExtraCmd cmd )

描述 执行拓展指令。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

ScanInputDevice()

IInputInterfaces::ScanInputDevice ([out] struct DevDesc[] staArr)

描述 Input服务用于扫描所有在线设备。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

SetGestureMode()

IInputInterfaces::SetGestureMode ([in] unsigned int devIndex, [in] unsigned int gestureMode )

描述 设置devIndex对应的Input设备的手势模式。

上层应用开关手势模式，即设置手势模式的对应使能bit。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

SetPowerStatus()

IInputInterfaces::SetPowerStatus ([in] unsigned int devIndex, [in] unsigned int status )

描述 设置devIndex对应的Input设备的电源状态。

在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，使驱动IC能正常进入对应的模式。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

UnregisterHotPlugCallback()

IInputInterfaces::UnregisterHotPlugCallback ()

描述 注销Input设备的热插拔回调函数。

起始版本： 3.2

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。

UnregisterReportCallback()

IInputInterfaces::UnregisterReportCallback ([in] unsigned int devIndex)

描述 注销devIndex对应的Input设备的回调函数。

起始版本： 3.2

参数:

返回：

如果操作成功，则返回0。

如果操作失败，则返回负值。