harmony 鸿蒙oh_input_manager.h

2025-06-16
浏览 (2)

oh_input_manager.h

概述

提供事件注入和关键状态查询等功能。

库： libohinput.so

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

相关模块： input

汇总

结构体

枚举

函数

枚举类型说明

Input_KeyStateAction

enum Input_KeyStateAction

描述

按键状态的枚举值。

起始版本： 12

Input_KeyEventAction

enum Input_KeyEventAction

描述

按键事件类型的枚举值。

起始版本： 12

Input_MouseEventAction

enum Input_MouseEventAction

描述

鼠标动作的枚举值。

起始版本： 12

InputEvent_MouseAxis

enum InputEvent_MouseAxis

描述

鼠标轴事件类型。

起始版本： 12

|枚举项|描述| |–|–| |MOUSE_AXIS_SCROLL_VERTICAL = 0|垂直滚动轴。| |MOUSE_AXIS_SCROLL_HORIZONTAL = 1|水平滚动轴。|

Input_MouseEventButton

enum Input_MouseEventButton

描述

鼠标按键的枚举值。

起始版本： 12

Input_TouchEventAction

enum Input_TouchEventAction

描述

触屏动作的枚举值。

起始版本： 12

InputEvent_SourceType

enum InputEvent_SourceType

描述

输入事件源类型。

起始版本： 12

Input_KeyboardType

enum Input_KeyboardType

描述

输入设备的键盘类型。

起始版本： 13

Input_Result

enum Input_Result

描述

错误码枚举值。

起始版本： 12

函数说明

Input_HotkeyCallback()

typedef void (*Input_HotkeyCallback)(Input_Hotkey* hotkey)

描述

回调函数，用于回调快捷键事件。

起始版本： 14

Input_KeyEventCallback()

typedef void (*Input_KeyEventCallback)(const Input_KeyEvent* keyEvent)

描述

按键事件的回调函数，keyEvent的生命周期为回调函数内。

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。|

Input_MouseEventCallback()

typedef void (*Input_MouseEventCallback)(const Input_MouseEvent* mouseEvent)

描述

鼠标事件的回调函数，mouseEvent的生命周期为回调函数内。

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。|

Input_TouchEventCallback()

typedef void (*Input_TouchEventCallback)(const Input_TouchEvent* touchEvent)

描述

触屏事件的回调函数，touchEvent的生命周期为回调函数内。

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。|

Input_AxisEventCallback()

typedef void (*Input_AxisEventCallback)(const Input_AxisEvent* axisEvent)

描述

轴事件的回调函数，axisEvent的生命周期为回调函数内。

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。|

Input_DeviceAddedCallback()

typedef void (*Input_DeviceAddedCallback)(int32_t deviceId)

描述

回调函数，用于回调输入设备的热插事件。

起始版本： 13

参数：

|参数项|描述| |–|–| |int32_t deviceId|设备的ID。|

Input_DeviceRemovedCallback()

typedef void (*Input_DeviceRemovedCallback)(int32_t deviceId)

描述

回调函数，用于回调输入设备的热拔事件。

起始版本： 13

参数：

|参数项|描述| |–|–| |int32_t deviceId|设备的ID。|

OH_Input_GetKeyState()

Input_Result OH_Input_GetKeyState(struct Input_KeyState* keyState)

描述

查询按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。|

返回：

|类型|说明| |–|–| |Input_Result|如果操作成功，@return返回INPUT_SUCCESS；
否则返回Input_Result中定义的其他错误代码。|

OH_Input_CreateKeyState()

struct Input_KeyState* OH_Input_CreateKeyState()

描述

创建按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

|类型|说明| |–|–| |struct|如果操作成功，@return返回一个Input_KeyState指针对象；否则返回空指针。|

OH_Input_DestroyKeyState()

void OH_Input_DestroyKeyState(struct Input_KeyState** keyState)

描述

销毁按键状态的枚举对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyState** keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。|

OH_Input_SetKeyCode()

void OH_Input_SetKeyCode(struct Input_KeyState* keyState, int32_t keyCode)

描述

设置按键状态对象的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。| |int32_t keyCode|按键键值。|

OH_Input_GetKeyCode()

int32_t OH_Input_GetKeyCode(const struct Input_KeyState* keyState)

描述

获取按键状态对象的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。|

返回：

|类型|说明| |–|–| |int32_t|返回按键状态对象的键值。|

OH_Input_SetKeyPressed()

void OH_Input_SetKeyPressed(struct Input_KeyState* keyState, int32_t keyAction)

描述

设置按键状态对象的按键是否按下。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。| |int32_t keyAction|按键是否按下，具体请参考Input_KeyEventAction。|

OH_Input_GetKeyPressed()

int32_t OH_Input_GetKeyPressed(const struct Input_KeyState* keyState)

描述

获取按键状态对象的按键是否按下。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。|

返回：

|类型|说明| |–|–| |int32_t|返回按键状态对象的按键按下状态。|

OH_Input_SetKeySwitch()

void OH_Input_SetKeySwitch(struct Input_KeyState* keyState, int32_t keySwitch)

描述

设置按键状态对象的按键开关。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。| |int32_t keySwitch|按键开关。|

OH_Input_GetKeySwitch()

int32_t OH_Input_GetKeySwitch(const struct Input_KeyState* keyState)

描述

获取按键状态对象的按键开关。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_KeyState* keyState|按键状态的枚举对象，具体请参考Input_KeyStateAction。|

返回：

|类型|说明| |–|–| |int32_t|返回按键状态对象的按键开关。|

OH_Input_InjectKeyEvent()

int32_t OH_Input_InjectKeyEvent(const struct Input_KeyEvent* keyEvent)

描述

注入按键事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。|

返回：

|类型|说明| |–|–| |int32_t|OH_Input_InjectKeyEvent 函数错误码。
若注入成功，返回INPUT_SUCCESS；
若缺少权限，返回INPUT_PERMISSION_DENIED；
若参数错误，返回INPUT_PARAMETER_ERROR。|

OH_Input_CreateKeyEvent()

struct Input_KeyEvent* OH_Input_CreateKeyEvent()

描述

创建按键事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

|类型|说明| |–|–| |struct|如果操作成功返回一个Input_KeyEvent指针对象，否则返回空指针。|

OH_Input_DestroyKeyEvent()

void OH_Input_DestroyKeyEvent(struct Input_KeyEvent** keyEvent)

描述

销毁按键事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent** keyEvent|按键事件对象。|

OH_Input_SetKeyEventAction()

void OH_Input_SetKeyEventAction(struct Input_KeyEvent* keyEvent, int32_t action)

描述

设置按键事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。| |int32_t action|按键事件类型。相关取值可参考Input_KeyEventAction。|

OH_Input_GetKeyEventAction()

int32_t OH_Input_GetKeyEventAction(const struct Input_KeyEvent* keyEvent)

描述

获取按键事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|返回按键事件类型。相关取值可参考Input_KeyEventAction。|

OH_Input_SetKeyEventKeyCode()

void OH_Input_SetKeyEventKeyCode(struct Input_KeyEvent* keyEvent, int32_t keyCode)

描述

设置按键事件的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。| |int32_t keyCode|按键的键值。|

OH_Input_GetKeyEventKeyCode()

int32_t OH_Input_GetKeyEventKeyCode(const struct Input_KeyEvent* keyEvent)

描述

获取按键事件的键值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|Key code.|

OH_Input_SetKeyEventActionTime()

void OH_Input_SetKeyEventActionTime(struct Input_KeyEvent* keyEvent, int64_t actionTime)

描述

设置按键事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。| |int64_t actionTime|按键事件发生的时间，表示从1970.1.1 00:00:00 GMT逝去的微秒数。|

OH_Input_GetKeyEventActionTime()

int64_t OH_Input_GetKeyEventActionTime(const struct Input_KeyEvent* keyEvent)

描述

获取按键事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int64_t|返回按键事件发生的时间。|

OH_Input_SetKeyEventWindowId()

void OH_Input_SetKeyEventWindowId(struct Input_KeyEvent* keyEvent, int32_t windowId)

描述

设置按键事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。| |int32_t windowId|按键事件对应的窗口Id。|

OH_Input_GetKeyEventWindowId()

int32_t OH_Input_GetKeyEventWindowId(const struct Input_KeyEvent* keyEvent)

描述

获取按键事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|按键事件的窗口Id。|

OH_Input_GetKeyEventDisplayId()

int32_t OH_Input_GetKeyEventDisplayId(const struct Input_KeyEvent* keyEvent)

描述

获取按键事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|按键事件的屏幕Id。|

OH_Input_SetKeyEventDisplayId()

void OH_Input_SetKeyEventDisplayId(struct Input_KeyEvent* keyEvent, int32_t displayId)

描述

设置按键事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |struct Input_KeyEvent* keyEvent|按键事件对象，通过OH_Input_CreateKeyEvent接口可以创建按键事件对象。
使用完需使用OH_Input_DestroyKeyEvent接口销毁按键事件对象。| |int32_t displayId|按键事件对应的屏幕Id。|

OH_Input_CreateMouseEvent()

struct Input_MouseEvent* OH_Input_CreateMouseEvent()

描述

创建鼠标事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

|类型|说明| |–|–| |struct|如果操作成功返回一个Input_MouseEvent指针对象，否则返回空指针。|

OH_Input_DestroyMouseEvent()

void OH_Input_DestroyMouseEvent(struct Input_MouseEvent** mouseEvent)

描述

销毁鼠标事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent** mouseEvent|鼠标事件对象。|

OH_Input_SetMouseEventAction()

void OH_Input_SetMouseEventAction(struct Input_MouseEvent* mouseEvent, int32_t action)

描述

设置鼠标事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int32_t action|鼠标的动作。相关取值可参考Input_MouseEventAction。|

OH_Input_GetMouseEventAction()

int32_t OH_Input_GetMouseEventAction(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。|

返回：

|类型|说明| |–|–| |int32_t|鼠标的动作。|

OH_Input_SetMouseEventDisplayX()

void OH_Input_SetMouseEventDisplayX(struct Input_MouseEvent* mouseEvent, int32_t displayX)

描述

设置鼠标事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int32_t displayX|屏幕X坐标。|

OH_Input_GetMouseEventDisplayX()

int32_t OH_Input_GetMouseEventDisplayX(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|屏幕X坐标。|

OH_Input_SetMouseEventDisplayY()

void OH_Input_SetMouseEventDisplayY(struct Input_MouseEvent* mouseEvent, int32_t displayY)

描述

设置鼠标事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

OH_Input_GetMouseEventDisplayY()

int32_t OH_Input_GetMouseEventDisplayY(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|屏幕Y坐标。|

OH_Input_SetMouseEventButton()

void OH_Input_SetMouseEventButton(struct Input_MouseEvent* mouseEvent, int32_t button)

描述

设置鼠标事件的按键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int32_t button|鼠标按键。相关取值可参考Input_MouseEventButton。|

OH_Input_GetMouseEventButton()

int32_t OH_Input_GetMouseEventButton(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的按键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|鼠标按键。相关取值可参考Input_MouseEventButton。|

OH_Input_SetMouseEventAxisType()

void OH_Input_SetMouseEventAxisType(struct Input_MouseEvent* mouseEvent, int32_t axisType)

描述

设置鼠标轴事件的类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int32_t axisType|轴类型，比如垂直轴、水平轴。相关取值可参考InputEvent_MouseAxis。|

OH_Input_GetMouseEventAxisType()

int32_t OH_Input_GetMouseEventAxisType(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标轴事件的类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|轴类型。相关取值可参考InputEvent_MouseAxis。|

OH_Input_SetMouseEventAxisValue()

void OH_Input_SetMouseEventAxisValue(struct Input_MouseEvent* mouseEvent, float axisValue)

描述

设置鼠标轴事件的值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |float axisValue|轴事件的值，正数向前滚动（例如，1.0表示向前滚动一个单位），负数向后滚动（例如，-1.0表示向后滚动一个单位）,零表示没有滚动。|

OH_Input_GetMouseEventAxisValue()

float OH_Input_GetMouseEventAxisValue(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标轴事件的值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |float|轴事件的值。|

OH_Input_SetMouseEventActionTime()

void OH_Input_SetMouseEventActionTime(struct Input_MouseEvent* mouseEvent, int64_t actionTime)

描述

设置鼠标事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int64_t actionTime|鼠标事件发生的时间，表示从1970.1.1 00:00:00 GMT逝去的微秒数。|

OH_Input_GetMouseEventActionTime()

int64_t OH_Input_GetMouseEventActionTime(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。|

返回：

|类型|说明| |–|–| |int64_t|返回鼠标事件发生的时间。|

OH_Input_SetMouseEventWindowId()

void OH_Input_SetMouseEventWindowId(struct Input_MouseEvent* mouseEvent, int32_t windowId)

描述

设置鼠标事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |struct Input_MouseEvent* mouseEvent|鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。| |int32_t windowId|鼠标事件的窗口Id。|

OH_Input_GetMouseEventWindowId()

int32_t OH_Input_GetMouseEventWindowId(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|鼠标事件的窗口Id。|

OH_Input_SetMouseEventDisplayId()

void OH_Input_SetMouseEventDisplayId(struct Input_MouseEvent* mouseEvent, int32_t displayId)

描述

设置鼠标事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

OH_Input_CreateTouchEvent()

struct Input_TouchEvent* OH_Input_CreateTouchEvent()

描述

创建触屏事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

|类型|说明| |–|–| |struct|如果操作成功返回一个Input_TouchEvent指针对象，否则返回空指针。|

OH_Input_DestroyTouchEvent()

void OH_Input_DestroyTouchEvent(struct Input_TouchEvent** touchEvent)

描述

销毁触屏事件对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_TouchEvent** touchEvent|触屏事件对象。|

OH_Input_SetTouchEventAction()

void OH_Input_SetTouchEventAction(struct Input_TouchEvent* touchEvent, int32_t action)

描述

设置触屏事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。| |int32_t action|触屏的动作。相关取值可参考Input_TouchEventAction。|

OH_Input_GetTouchEventAction()

int32_t OH_Input_GetTouchEventAction(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。|

返回：

|类型|说明| |–|–| |int32_t|触屏的动作。相关取值可参考Input_TouchEventAction。|

OH_Input_SetTouchEventFingerId()

void OH_Input_SetTouchEventFingerId(struct Input_TouchEvent* touchEvent, int32_t id)

描述

设置触屏事件的手指ID。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。| |int32_t id|触屏的手指ID。第一个手指碰到屏幕，id就是0，第二个手指碰到屏幕，id就是1，依次累加。|

OH_Input_GetTouchEventFingerId()

int32_t OH_Input_GetTouchEventFingerId(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的手指ID。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|触屏的手指ID。第一个手指碰到屏幕，id就是0，第二个手指碰到屏幕，id就是1，依次累加。|

OH_Input_SetTouchEventDisplayX()

void OH_Input_SetTouchEventDisplayX(struct Input_TouchEvent* touchEvent, int32_t displayX)

描述

设置触屏事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |struct Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。| |int32_t displayX|触屏的屏幕X坐标。|

OH_Input_GetTouchEventDisplayX()

int32_t OH_Input_GetTouchEventDisplayX(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的屏幕X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|触屏的屏幕X坐标。|

OH_Input_SetTouchEventDisplayY()

void OH_Input_SetTouchEventDisplayY(struct Input_TouchEvent* touchEvent, int32_t displayY)

描述

设置触屏事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

OH_Input_GetTouchEventDisplayY()

int32_t OH_Input_GetTouchEventDisplayY(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的屏幕Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|触屏的屏幕Y坐标。|

OH_Input_SetTouchEventActionTime()

void OH_Input_SetTouchEventActionTime(struct Input_TouchEvent* touchEvent, int64_t actionTime)

描述

设置触屏事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。| |int64_t actionTime|触屏事件发生的时间，表示从1970.1.1 00:00:00 GMT逝去的微秒数。|

OH_Input_GetTouchEventActionTime()

int64_t OH_Input_GetTouchEventActionTime(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。|

返回：

|类型|说明| |–|–| |int64_t|返回触屏事件发生的时间。|

OH_Input_SetTouchEventWindowId()

void OH_Input_SetTouchEventWindowId(struct Input_TouchEvent* touchEvent, int32_t windowId)

描述

设置触屏事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |struct Input_TouchEvent* touchEvent|触屏事件对象，通过OH_Input_CreateTouchEvent接口可以创建触屏事件对象。
使用完需使用OH_Input_DestroyTouchEvent接口销毁触屏事件对象。| |int32_t windowId|触屏事件的窗口Id。|

OH_Input_GetTouchEventWindowId()

int32_t OH_Input_GetTouchEventWindowId(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|触屏事件的窗口Id。|

OH_Input_SetTouchEventDisplayId()

void OH_Input_SetTouchEventDisplayId(struct Input_TouchEvent* touchEvent, int32_t displayId)

描述

设置触屏事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

OH_Input_GetTouchEventDisplayId()

int32_t OH_Input_GetTouchEventDisplayId(const struct Input_TouchEvent* touchEvent)

描述

获取触屏事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|触屏事件的屏幕Id。|

OH_Input_CancelInjection()

void OH_Input_CancelInjection()

描述

取消事件注入并撤销授权。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

OH_Input_CreateAxisEvent()

Input_AxisEvent* OH_Input_CreateAxisEvent(void)

描述

创建轴事件对象实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

返回：

|类型|说明| |–|–| |Input_AxisEvent*|成功返回Input_AxisEvent对象实例，失败则返回null。|

OH_Input_DestroyAxisEvent()

Input_Result OH_Input_DestroyAxisEvent(Input_AxisEvent** axisEvent)

描述

销毁轴事件对象实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent** axisEvent|轴事件对象实例的指针。|

返回：

|类型|说明| |–|–| |Input_Result|若销毁成功，则返回INPUT_SUCCESS；若axisEvent为NULL或者axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventAction()

Input_Result OH_Input_SetAxisEventAction(Input_AxisEvent* axisEvent, InputEvent_AxisAction action)

描述

设置轴事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_AxisAction action|轴事件动作，具体请参考InputEvent_AxisAction。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件的动作成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventAction()

Input_Result OH_Input_GetAxisEventAction(const Input_AxisEvent* axisEvent, InputEvent_AxisAction *action)

描述

获取轴事件的动作。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_AxisAction *action|action 出参，返回轴事件动作，具体请参考在InputEvent_AxisAction。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件的动作成功，则返回INPUT_SUCCESS；若axisEvent或者action为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventDisplayX()

Input_Result OH_Input_SetAxisEventDisplayX(Input_AxisEvent* axisEvent, float displayX)

描述

设置轴事件的X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |float displayX|轴事件X坐标。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件的X坐标成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventDisplayX()

Input_Result OH_Input_GetAxisEventDisplayX(const Input_AxisEvent* axisEvent, float* displayX)

描述

获取轴事件的X坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |float* displayX|出参，返回轴事件X坐标。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件的X坐标成功，则返回INPUT_SUCCESS；若axisEvent或者displayX为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventDisplayY()

Input_Result OH_Input_SetAxisEventDisplayY(Input_AxisEvent* axisEvent, float displayY)

描述

设置轴事件的Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |float displayY|轴事件Y坐标。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件的Y坐标成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventDisplayY()

Input_Result OH_Input_GetAxisEventDisplayY(const Input_AxisEvent* axisEvent, float* displayY)

描述

获取轴事件的Y坐标。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |float* displayY|出参，返回轴事件Y坐标。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件的Y坐标成功，则返回INPUT_SUCCESS；若axisEvent或者displayY为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventAxisValue()

Input_Result OH_Input_SetAxisEventAxisValue(Input_AxisEvent* axisEvent,InputEvent_AxisType axisType, double axisValue)

描述

设置轴事件指定轴类型的轴值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件指定轴类型的轴值成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventAxisValue()

Input_Result OH_Input_GetAxisEventAxisValue(const Input_AxisEvent* axisEvent,InputEvent_AxisType axisType, double* axisValue)

描述

获取轴事件指定轴类型的轴值。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件指定轴类型的轴值成功，则返回INPUT_SUCCESS；若axisEvent或者axisValue为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventActionTime()

Input_Result OH_Input_SetAxisEventActionTime(Input_AxisEvent* axisEvent, int64_t actionTime)

描述

设置轴事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int64_t actionTime|轴事件发生的时间，表示从1970.1.1 00:00:00 GMT逝去的微秒数。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件发生的时间成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventActionTime()

Input_Result OH_Input_GetAxisEventActionTime(const Input_AxisEvent* axisEvent, int64_t* actionTime)

描述

获取轴事件发生的时间。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int64_t* actionTime|出参，返回轴事件发生的时间，表示从1970.1.1 00:00:00 GMT逝去的微秒数。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件发生的时间成功，则返回INPUT_SUCCESS；若axisEvent或者actionTime为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventType()

Input_Result OH_Input_SetAxisEventType(Input_AxisEvent* axisEvent, InputEvent_AxisEventType axisEventType)

描述

设置轴事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_AxisEventType axisEventType|轴事件类型，具体请参考InputEvent_AxisEventType。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件类型成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventType()

Input_Result OH_Input_GetAxisEventType(const Input_AxisEvent* axisEvent, InputEvent_AxisEventType* axisEventType)

描述

获取轴事件类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_AxisEventType* axisEventType|出参，返回轴事件类型，具体请参考InputEvent_AxisEventType。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件类型成功，则返回INPUT_SUCCESS；若axisEvent或者axisEventType为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventSourceType()

Input_Result OH_Input_SetAxisEventSourceType(Input_AxisEvent* axisEvent, InputEvent_SourceType sourceType)

描述

设置轴事件源类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_SourceType sourceType|轴事件源类型,具体请参考InputEvent_SourceType。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件源类型成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventSourceType()

Input_Result OH_Input_GetAxisEventSourceType(const Input_AxisEvent* axisEvent, InputEvent_SourceType* sourceType)

描述

获取轴事件源类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |InputEvent_SourceType* sourceType|出参，返回轴事件源类型，具体请参考InputEvent_SourceType。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件源类型成功，则返回INPUT_SUCCESS；若axisEvent或者sourceType为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventWindowId()

Input_Result OH_Input_SetAxisEventWindowId(Input_AxisEvent* axisEvent, int32_t windowId)

描述

设置轴事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int32_t windowId|轴事件窗口Id。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件的窗口Id成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventWindowId()

Input_Result OH_Input_GetAxisEventWindowId(const Input_AxisEvent* axisEvent, int32_t* windowId)

描述

获取轴事件的窗口Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int32_t* windowId|出参，返回轴事件窗口Id。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件的窗口Id成功，则返回INPUT_SUCCESS；若axisEvent或者windowId为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_SetAxisEventDisplayId()

Input_Result OH_Input_SetAxisEventDisplayId(Input_AxisEvent* axisEvent, int32_t displayId)

描述

设置轴事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int32_t displayId|轴事件屏幕Id。|

返回：

|类型|说明| |–|–| |Input_Result|若设置轴事件的屏幕Id成功，则返回INPUT_SUCCESS；若axisEvent为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_GetAxisEventDisplayId()

Input_Result OH_Input_GetAxisEventDisplayId(const Input_AxisEvent* axisEvent, int32_t* displayId)

描述

获取轴事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

|参数项|描述| |–|–| |const Input_AxisEvent* axisEvent|轴事件对象，通过OH_Input_CreateAxisEvent接口可以创建轴事件对象。
使用完需使用OH_Input_DestroyAxisEvent接口销毁轴事件对象。| |int32_t* displayId|出参，返回轴事件屏幕Id。|

返回：

|类型|说明| |–|–| |Input_Result|若获取轴事件的屏幕Id成功，则返回INPUT_SUCCESS；若axisEvent或者displayId为NULL，则返回INPUT_PARAMETER_ERROR。|

OH_Input_AddKeyEventMonitor()

Input_Result OH_Input_AddKeyEventMonitor(Input_KeyEventCallback callback)

描述

添加按键事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_KeyEventCallback callback|回调函数，用于接收按键事件。|

返回：

|类型|说明| |–|–| |Input_Result|若添加按键事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_AddMouseEventMonitor()

Input_Result OH_Input_AddMouseEventMonitor(Input_MouseEventCallback callback)

描述

添加鼠标事件监听,包含鼠标点击，移动，不包含滚轮事件，滚轮事件归属于轴事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_MouseEventCallback callback|回调函数，用于接收鼠标事件。|

返回：

|类型|说明| |–|–| |Input_Result|若添加鼠标事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_AddTouchEventMonitor()

Input_Result OH_Input_AddTouchEventMonitor(Input_TouchEventCallback callback)

描述

添加触屏事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_TouchEventCallback callback|回调函数，用于接收触屏事件。|

返回：

|类型|说明| |–|–| |Input_Result|若添加触屏事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_AddAxisEventMonitorForAll()

Input_Result OH_Input_AddAxisEventMonitorForAll(Input_AxisEventCallback callback)

描述

添加所有类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEventCallback callback|回调函数，用于接收轴事件。|

返回：

|类型|说明| |–|–| |Input_Result|若添加轴事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_AddAxisEventMonitor()

Input_Result OH_Input_AddAxisEventMonitor(InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback)

描述

添加指定类型的轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |InputEvent_AxisEventType axisEventType|要监听的轴事件类型，轴事件类型定义在InputEvent_AxisEventType中。| |Input_AxisEventCallback callback|回调函数，用于接收指定类型的轴事件|

返回：

OH_Input_RemoveKeyEventMonitor()

Input_Result OH_Input_RemoveKeyEventMonitor(Input_KeyEventCallback callback)

描述

移除按键事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_KeyEventCallback callback|指定要被移除的用于按键事件监听的回调函数。|

返回：

|类型|说明| |–|–| |Input_Result|若移除按键事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveMouseEventMonitor()

Input_Result OH_Input_RemoveMouseEventMonitor(Input_MouseEventCallback callback)

描述

移除鼠标事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_MouseEventCallback callback|指定要被移除的用于鼠标事件监听的回调函数。|

返回：

|类型|说明| |–|–| |Input_Result|若移除鼠标事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveTouchEventMonitor()

Input_Result OH_Input_RemoveTouchEventMonitor(Input_TouchEventCallback callback)

描述

移除触屏事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_TouchEventCallback callback|指定要被移除的用于触屏事件监听的回调函数。|

返回：

|类型|说明| |–|–| |Input_Result|若移除触屏事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveAxisEventMonitorForAll()

Input_Result OH_Input_RemoveAxisEventMonitorForAll(Input_AxisEventCallback callback)

描述

移除所有类型轴事件监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_AxisEventCallback callback|指定要被移除的用于所有类型轴事件监听的回调函数。|

返回：

|类型|说明| |–|–| |Input_Result|若移除轴事件监听成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空或者没有被添加监听，则返回INPUT_PARAMETER_ERROR；若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveAxisEventMonitor()

Input_Result OH_Input_RemoveAxisEventMonitor(InputEvent_AxisEventType axisEventType, Input_AxisEventCallback callback)

描述

移除指定类型轴事件监听，轴事件类型定义在InputEvent_AxisEventType中。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INPUT_MONITORING

起始版本： 12

参数：

|参数项|描述| |–|–| |InputEvent_AxisEventType axisEventType|指定要移除监听的轴事件类型，轴事件类型定义在InputEvent_AxisEventType中。| |Input_AxisEventCallback callback|指定要被移除的用于指定类型轴事件监听的回调函数。|

返回：

OH_Input_AddKeyEventInterceptor()

Input_Result OH_Input_AddKeyEventInterceptor(Input_KeyEventCallback callback, Input_InterceptorOptions *option)

描述

添加按键事件的拦截，重复添加只有第一次生效。仅在应用获焦时拦截按键事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INTERCEPT_INPUT_EVENT

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_KeyEventCallback callback|回调函数，用于接收按键事件。| |Input_InterceptorOptions *option|option 输入事件拦截的可选项，传null则使用默认值。|

返回：

|类型|说明| |–|–| |Input_Result|若添加按键事件的拦截成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若重复添加拦截器，则返回INPUT_REPEAT_INTERCEPTOR；
若服务异常；则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_AddInputEventInterceptor()

Input_Result OH_Input_AddInputEventInterceptor(Input_InterceptorEventCallback *callback,Input_InterceptorOptions *option)

描述

添加输入事件拦截，包括鼠标、触屏和轴事件，重复添加只有第一次生效。仅命中应用窗口时拦截输入事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INTERCEPT_INPUT_EVENT

起始版本： 12

参数：

|参数项|描述| |–|–| |Input_InterceptorEventCallback *callback|callback 用于回调输入事件的结构体指针，请参考定义Input_InterceptorEventCallback。| |Input_InterceptorOptions *option|option 输入事件拦截的可选项，传null则使用默认值。|

返回：

|类型|说明| |–|–| |Input_Result|若添加输入事件的拦截成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若callback为空，则返回INPUT_PARAMETER_ERROR；若重复添加拦截器，则返回INPUT_REPEAT_INTERCEPTOR；
若服务异常；则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveKeyEventInterceptor()

Input_Result OH_Input_RemoveKeyEventInterceptor(void)

描述

移除按键事件拦截。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INTERCEPT_INPUT_EVENT

起始版本： 12

返回：

|类型|说明| |–|–| |Input_Result|若移除按键事件拦截成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_RemoveInputEventInterceptor()

Input_Result OH_Input_RemoveInputEventInterceptor(void)

描述

移除输入事件拦截，包括鼠标、触屏和轴事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

需要权限： ohos.permission.INTERCEPT_INPUT_EVENT

起始版本： 12

返回：

|类型|说明| |–|–| |Input_Result|若移除输入事件拦截成功，则返回INPUT_SUCCESS；若权限校验失败，则返回INPUT_PERMISSION_DENIED；
若服务异常，则返回INPUT_SERVICE_EXCEPTION。|

OH_Input_GetIntervalSinceLastInput()

Input_Result OH_Input_GetIntervalSinceLastInput(int64_t *timeInterval)

描述

获取距离上次系统输入事件的时间间隔。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |int64_t *timeInterval|timeInterval 时间间隔，单位为微秒。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetIntervalSinceLastInput 函数错误码。
若获取时间间隔成功，则返回INPUT_SUCCESS；若获取失败，返回INPUT_SERVICE_EXCEPTION。|

OH_Input_CreateHotkey()

Input_Hotkey *OH_Input_CreateHotkey(void)

描述

创建快捷键对象的实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

返回：

|类型|说明| |–|–| |Input_Hotkey|如果操作成功,则返回一个Input_Hotkey指针对象。否则, 返回一个空指针，可能的原因是内存分配失败。|

OH_Input_DestroyHotkey()

void OH_Input_DestroyHotkey(Input_Hotkey **hotkey)

描述

销毁快捷键对象的实例。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |Input_Hotkey **hotkey|hotkey 快捷键对象的实例。|

OH_Input_SetPreKeys()

void OH_Input_SetPreKeys(Input_Hotkey *hotkey, int32_t *preKeys, int32_t size)

描述

设置修饰键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

OH_Input_GetPreKeys()

Input_Result OH_Input_GetPreKeys(const Input_Hotkey *hotkey, int32_t **preKeys, int32_t *preKeyCount)

描述

获取修饰键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetpressedKeys 函数错误码。
若获取成功，返回INPUT_SUCCESS；若获取失败，返回INPUT_PARAMETER_ERROR。|

OH_Input_SetFinalKey()

void OH_Input_SetFinalKey(Input_Hotkey* hotkey, int32_t finalKey)

描述

设置被修饰键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |Input_Hotkey* hotkey|快捷键对象的实例。| |int32_t finalKey|被修饰键值，被修饰键值只能是1个。|

OH_Input_GetFinalKey()

Input_Result OH_Input_GetFinalKey(const Input_Hotkey* hotkey, int32_t *finalKeyCode)

描述

获取被修饰键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |const Input_Hotkey* hotkey|快捷键对象的实例。| |int32_t *finalKeyCode|finalKeyCode 返回被修饰键键值。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetfinalKey 函数错误码。
若获取成功，返回INPUT_SUCCESS；
若获取失败，返回INPUT_PARAMETER_ERROR。|

OH_Input_CreateAllSystemHotkeys()

Input_Hotkey **OH_Input_CreateAllSystemHotkeys(int32_t count)

描述

创建Input_Hotkey类型实例的数组。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |int32_t count|创建Input_Hotkey实例的数量。|

返回：

|类型|说明| |–|–| |Input_Hotkey|OH_Input_CreateAllSystemHotkey 函数错误码。
INPUT_SUCCESS 创建实例数组的双指针成功。|

OH_Input_DestroyAllSystemHotkeys()

void OH_Input_DestroyAllSystemHotkeys(Input_Hotkey **hotkeys, int32_t count)

描述

销毁Input_Hotkey实例数组并回收内存。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |Input_Hotkey **hotkeys|hotkeys 指向Input_Hotkey实例数组的双指针。| |int32_t count|销毁Input_Hotkey实例的数量。|

OH_Input_GetAllSystemHotkeys()

Input_Result OH_Input_GetAllSystemHotkeys(Input_Hotkey **hotkey, int32_t *count)

描述

获取设置的所有快捷键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |Input_Hotkey **hotkey|hotkey 返回Input_Hotkey 类型实例数组。首次调用可传入NULL，可获取数组长度。| |int32_t *count|count 返回支持快捷键的个数。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetAllSystemHotkeys 函数错误码。
若获取成功，返回INPUT_SUCCESS；
若获取失败，返回INPUT_PARAMETER_ERROR。|

OH_Input_SetRepeat()

void OH_Input_SetRepeat(Input_Hotkey* hotkey, bool isRepeat)

描述

设置是否上报重复key事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |Input_Hotkey* hotkey|快捷键对象的实例。| |bool isRepeat|是否上报重复key事件。true表示上报，false表示不上报。|

OH_Input_GetRepeat()

Input_Result OH_Input_GetRepeat(const Input_Hotkey* hotkey, bool *isRepeat)

描述

获取是否上报重复key事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |const Input_Hotkey* hotkey|快捷键对象的实例。| |bool *isRepeat|isRepeat 返回Key事件是否重复。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetIsRepeat 函数错误码。
若获取成功，返回INPUT_SUCCESS；
若获取失败，返回INPUT_PARAMETER_ERROR。|

OH_Input_AddHotkeyMonitor()

Input_Result OH_Input_AddHotkeyMonitor(const Input_Hotkey* hotkey, Input_HotkeyCallback callback)

描述

订阅快捷键事件。此接口在智能穿戴、轻量级智能穿戴设备不生效。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |const Input_Hotkey* hotkey|指定要订阅的快捷键对象。| |Input_HotkeyCallback callback|回调函数，用于回调快捷键事件。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_AddHotkeyMonitor 函数错误码。
INPUT_SUCCESS 表示订阅组合按键成功。
INPUT_PARAMETER_ERROR 参数检查失败。
INPUT_OCCUPIED_BY_SYSTEM 该快捷键已被系统占用，可以通过接口OH_Input_GetAllSystemHotkeys查询所有的系统快捷键。
INPUT_OCCUPIED_BY_OTHER 已被抢占订阅。
INPUT_DEVICE_NOT_SUPPORTED 表示功能不受支持。|

OH_Input_RemoveHotkeyMonitor()

Input_Result OH_Input_RemoveHotkeyMonitor(const Input_Hotkey* hotkey, Input_HotkeyCallback callback)

描述

取消订阅快捷键。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 14

参数：

|参数项|描述| |–|–| |const Input_Hotkey* hotkey|指定要取消订阅的快捷键对象。| |Input_HotkeyCallback callback|回调函数，用于回调快捷键事件。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_RemoveHotkeyMonitor 函数错误码。
INPUT_SUCCESS 取消订阅组合按键成功， INPUT_PARAMETER_ERROR 参数检查失败。|

OH_Input_RegisterDeviceListener()

Input_Result OH_Input_RegisterDeviceListener(Input_DeviceListener* listener)

描述

注册设备热插拔的监听器。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceListener* listener|指向设备热插拔监听器Input_DeviceListener的指针。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_RegisterDeviceListener 的返回值。
INPUT_SUCCESS 表示注册成功。
INPUT_PARAMETER_ERROR 表示listener 为NULL。|

OH_Input_UnregisterDeviceListener()

Input_Result OH_Input_UnregisterDeviceListener(Input_DeviceListener* listener)

描述

取消注册设备热插拔的监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceListener* listener|指向设备热插拔监听器Input_DeviceListener的指针。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_UnregisterDeviceListener 的返回值。
INPUT_SUCCESS 表示取消注册成功。
INPUT_PARAMETER_ERROR 表示listener 为 NULL 或者 listener 未被注册。
INPUT_SERVICE_EXCEPTION 表示由于服务异常调用失败。|

OH_Input_UnregisterDeviceListeners()

Input_Result OH_Input_UnregisterDeviceListeners()

描述

取消注册所有的设备热插拔的监听。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_UnregisterDeviceListener 的返回值。
INPUT_SUCCESS 表示调用成功。
INPUT_SERVICE_EXCEPTION 表示由于服务异常调用失败。|

OH_Input_GetDeviceIds()

Input_Result OH_Input_GetDeviceIds(int32_t *deviceIds, int32_t inSize, int32_t *outSize)

描述

获取所有输入设备的ID列表。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceIds或outSize为空指针或inSize小于0。|

OH_Input_GetDevice()

Input_Result OH_Input_GetDevice(int32_t deviceId, Input_DeviceInfo **deviceInfo)

描述

获取输入设备信息。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |int32_t deviceId|设备ID。| |Input_DeviceInfo **deviceInfo|deviceInfo 指向输入设备信息Input_DeviceInfo的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo为空指针或deviceId无效。
可以通过 OH_Input_GetDeviceIds 表示接口查询系统支持的设备ID。|

OH_Input_CreateDeviceInfo()

Input_DeviceInfo* OH_Input_CreateDeviceInfo(void)

描述

创建输入设备信息的对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

返回：

|类型|说明| |–|–| |Input_DeviceInfo*|如果操作成功，返回设备信息Input_DeviceInfo实例的指针。否则返回空指针，可能的原因是分配内存失败。|

OH_Input_DestroyDeviceInfo()

void OH_Input_DestroyDeviceInfo(Input_DeviceInfo **deviceInfo)

描述

销毁输入设备信息的对象。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo **deviceInfo|deviceInfo 设备信息的对象。|

OH_Input_GetKeyboardType()

Input_Result OH_Input_GetKeyboardType(int32_t deviceId, int32_t *keyboardType)

描述

获取输入设备的键盘类型。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |int32_t deviceId|设备ID。| |int32_t *keyboardType|keyboardType 指向输入设备的键盘指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示设备ID为无效值或者keyboardType是空指针。|

OH_Input_GetDeviceId()

Input_Result OH_Input_GetDeviceId(Input_DeviceInfo *deviceInfo, int32_t *id)

描述

获取输入设备的id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |int32_t *id|id 指向输入设备ID的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者id是空指针。|

OH_Input_GetDeviceName()

Input_Result OH_Input_GetDeviceName(Input_DeviceInfo *deviceInfo, char **name)

描述

获取输入设备的名称。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |char **name|name 指向输入设备名称的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者name是空指针。|

OH_Input_GetCapabilities()

Input_Result OH_Input_GetCapabilities(Input_DeviceInfo *deviceInfo, int32_t *capabilities)

描述

获取有关输入设备能力信息，比如设备是触摸屏、触控板、键盘等。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |int32_t *capabilities|capabilities 指向输入设备能力信息的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者capabilities是空指针。|

OH_Input_GetDeviceVersion()

Input_Result OH_Input_GetDeviceVersion(Input_DeviceInfo *deviceInfo, int32_t *version)

描述

获取输入设备的版本信息。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |int32_t *version|version 指向输入设备版本信息的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者version是空指针。|

OH_Input_GetDeviceProduct()

Input_Result OH_Input_GetDeviceProduct(Input_DeviceInfo *deviceInfo, int32_t *product)

描述

获取输入设备的产品信息。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |int32_t *product|product 指向输入设备产品信息的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者product是空指针。|

OH_Input_GetDeviceVendor()

Input_Result OH_Input_GetDeviceVendor(Input_DeviceInfo *deviceInfo, int32_t *vendor)

描述

获取输入设备的厂商信息。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |int32_t *vendor|vendor 指向输入设备厂商信息的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者vendor是空指针。|

OH_Input_GetDeviceAddress()

Input_Result OH_Input_GetDeviceAddress(Input_DeviceInfo *deviceInfo, char **address)

描述

获取输入设备的物理地址。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 13

参数：

|参数项|描述| |–|–| |Input_DeviceInfo *deviceInfo|deviceInfo 输入设备信息Input_DeviceInfo。| |char **address|address 指向输入设备物理地址的指针。|

返回：

|类型|说明| |–|–| |Input_Result|INPUT_SUCCESS 表示操作成功。
INPUT_PARAMETER_ERROR 表示deviceInfo或者address是空指针。|

OH_Input_GetFunctionKeyState()

Input_Result OH_Input_GetFunctionKeyState(int32_t keyCode, int32_t *state)

描述

获取功能键状态。

起始版本： 15

参数：

|参数项|描述| |–|–| |int32_t keyCode|功能键值。支持的功能键包含CapsLock键。| |int32_t *state|state 功能键状态。0表示功能键关闭，1表示功能键打开。|

返回：

|类型|说明| |–|–| |Input_Result|OH_Input_GetFunctionKeyState的执行结果。
INPUT_SUCCESS 表示获取状态成功。
INPUT_PARAMETER_ERROR 表示参数错误。
{@link INPUT_DEVICE_NOT_EXIST } 表示键盘设备不存在。|

OH_Input_InjectTouchEvent()

int32_t OH_Input_InjectTouchEvent(const struct Input_TouchEvent* touchEvent)

描述

注入触屏事件。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |int32_t|OH_Input_InjectTouchEvent的执行结果。
INPUT_SUCCESS 表示注入成功。
INPUT_PARAMETER_ERROR 表示参数错误。
INPUT_PERMISSION_DENIED 表示缺少权限。|

OH_Input_InjectMouseEvent()

int32_t OH_Input_InjectMouseEvent(const struct Input_MouseEvent* mouseEvent)

描述

注入鼠标事件。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 12

参数：

|参数项|描述| |–|–| |const struct Input_MouseEvent* mouseEvent| 鼠标事件对象，通过OH_Input_CreateMouseEvent接口可以创建鼠标事件对象。
使用完需使用OH_Input_DestroyMouseEvent接口销毁鼠标事件对象。|

返回：

OH_Input_GetMouseEventDisplayId()

int32_t OH_Input_GetMouseEventDisplayId(const struct Input_MouseEvent* mouseEvent)

描述

获取鼠标事件的屏幕Id。

系统能力： SystemCapability.MultimodalInput.Input.Core

起始版本： 15

参数：

返回：

|类型|说明| |–|–| |int32_t|若获取鼠标事件的屏幕Id成功，则返回鼠标事件的屏幕Id；若mouseEvent为NULL，则返回-1。|

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Input Kit（多模输入服务）

harmony 鸿蒙Input_AxisEvent

harmony 鸿蒙Input_DeviceInfo

harmony 鸿蒙Input_DeviceListener

harmony 鸿蒙Input_Hotkey

harmony 鸿蒙Input_InterceptorEventCallback

harmony 鸿蒙Input_InterceptorOptions

harmony 鸿蒙Input_KeyEvent

harmony 鸿蒙Input_KeyState

harmony 鸿蒙Input_MouseEvent

0 赞

所属分类： 后端技术
本文标签： 软件鸿蒙
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/3ZKpvp