@ohos.multimodalInput.inputEventClient (输入事件注入)(系统接口)

输入事件注入模块，提供输入事件注入能力。

说明：

• 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口为系统接口。

导入模块

import { inputEventClient } from '@kit.InputKit';

inputEventClient.injectEvent

injectEvent({KeyEvent: KeyEvent}): void

按键(包括单个按键和组合键)注入。

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

需要权限： ohos.permission.INJECT_INPUT_EVENT

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

try {
  let backKeyDown: inputEventClient.KeyEvent = {
    isPressed: true,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
  }

  class EventDown {
    KeyEvent: inputEventClient.KeyEvent|null = null
  }

  let eventDown: EventDown = { KeyEvent: backKeyDown }
  inputEventClient.injectEvent(eventDown);

  let backKeyUp: inputEventClient.KeyEvent = {
    isPressed: false,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
  };

  class EventUp {
    KeyEvent: inputEventClient.KeyEvent|null = null
  }

  let eventUp: EventUp = { KeyEvent: backKeyUp }
  inputEventClient.injectEvent(eventUp);
} catch (error) {
  console.error(`Failed to inject KeyEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputEventClient.injectKeyEvent¹¹⁺

injectKeyEvent(keyEvent: KeyEventData): void

按键(包括单个按键和组合键)事件注入。

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

需要权限： ohos.permission.INJECT_INPUT_EVENT

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

try {
  let backKeyDown: inputEventClient.KeyEvent = {
    isPressed: true,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
  }

  class EventDown {
    keyEvent: inputEventClient.KeyEvent|null = null
  }

  let eventDown: EventDown = { keyEvent: backKeyDown }
  inputEventClient.injectKeyEvent(eventDown);

  let backKeyUp: inputEventClient.KeyEvent = {
    isPressed: false,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
  };

  class EventUp {
    keyEvent: inputEventClient.KeyEvent|null = null
  }

  let eventUp: EventUp = { keyEvent: backKeyUp }
  inputEventClient.injectKeyEvent(eventUp);
} catch (error) {
  console.error(`Failed to inject KeyEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputEventClient.injectMouseEvent¹¹⁺

injectMouseEvent(mouseEvent: MouseEventData): void

鼠标/触摸板事件注入。

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

需要权限： ohos.permission.INJECT_INPUT_EVENT

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { MouseEvent } from '@kit.InputKit';

try {
  let mouseButtonUpData: MouseEvent = {
    id: 0,
    deviceId: 1,
    actionTime: 2,
    screenId: 1,
    windowId: 0,
    action: 3,
    screenX: 100,
    screenY: 200,
    windowX: 100,
    windowY: 200,
    rawDeltaX: 200,
    rawDeltaY: 200,
    button: 2,
    pressedButtons: [2],
    axes: [],
    pressedKeys: [0],
    ctrlKey: false,
    altKey: false,
    shiftKey: false,
    logoKey: false,
    fnKey: false,
    capsLock: false,
    numLock: false,
    scrollLock: false,
    toolType: 1,
  }
  let mouseButtonUp: inputEventClient.MouseEventData = {
    mouseEvent: mouseButtonUpData
  }
  inputEventClient.injectMouseEvent(mouseButtonUp);

  let mouseButtonDownData: MouseEvent = {
    id: 0,
    deviceId: 1,
    actionTime: 2,
    screenId: 1,
    windowId: 0,
    action: 2,
    screenX: 100,
    screenY: 200,
    windowX: 100,
    windowY: 200,
    rawDeltaX: 200,
    rawDeltaY: 200,
    button: 2,
    pressedButtons: [2],
    axes: [],
    pressedKeys: [0],
    ctrlKey: false,
    altKey: false,
    shiftKey: false,
    logoKey: false,
    fnKey: false,
    capsLock: false,
    numLock: false,
    scrollLock: false,
    toolType: 1,
  }
  let mouseButtonDown: inputEventClient.MouseEventData = {
    mouseEvent: mouseButtonDownData
  };
  inputEventClient.injectMouseEvent(mouseButtonDown);
}

catch (error) {
  console.error(`Failed to inject MouseEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputEventClient.injectTouchEvent¹¹⁺

injectTouchEvent(touchEvent: TouchEventData): void

触摸屏事件注入。

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

需要权限： ohos.permission.INJECT_INPUT_EVENT

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

示例：

import { Touch, TouchEvent } from '@kit.InputKit';

try {
  let touchEvent: Touch = {
    id: 1,
    pressedTime: 1,
    screenX: 0,
    screenY: 0,
    windowX: 0,
    windowY: 0,
    pressure: 0,
    width: 0,
    height: 0,
    tiltX: 0,
    tiltY: 0,
    toolX: 0,
    toolY: 0,
    toolWidth: 0,
    toolHeight: 0,
    rawX: 0,
    rawY: 0,
    toolType: 0,
  }

  let touchEventUpData: TouchEvent = {
    action: 1,
    sourceType: 0,
    touch: touchEvent,
    touches: [],
    id: 0,
    deviceId: 0,
    actionTime: 0,
    screenId: 0,
    windowId: 0
  }
  ;
  let touchEventUp: inputEventClient.TouchEventData = {
    touchEvent: touchEventUpData
  }
  inputEventClient.injectTouchEvent(touchEventUp);

  let touchEventDownData: TouchEvent = {
    action: 1,
    sourceType: 0,
    touch: touchEvent,
    touches: [],
    id: 0,
    deviceId: 0,
    actionTime: 0,
    screenId: 0,
    windowId: 0
  }
  ;
  let touchEventDown: inputEventClient.TouchEventData = {
    touchEvent: touchEventDownData
  }
  inputEventClient.injectTouchEvent(touchEventDown);
} catch (error) {
  console.error(`Failed to inject touchEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputEventClient.permitInjection¹²⁺

permitInjection(result: boolean): void

允许事件注入权限。

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

需要权限： ohos.permission.INJECT_INPUT_EVENT

参数：

错误码：

以下错误码的详细介绍请参见通用错误码。

import { inputEventClient } from '@kit.InputKit';

try {
  let result = true;
  inputEventClient.permitInjection(result);
}catch(error){
  console.error("failed:" + JSON.stringify(error));
}

KeyEvent

按键注入描述信息。

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

KeyEventData¹¹⁺

按键注入描述信息。

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

MouseEventData¹¹⁺

鼠标注入描述信息。

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

TouchEventData¹¹⁺

触摸屏注入描述信息。

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

你可能感兴趣的鸿蒙文章

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