@ohos.multimodalInput.inputMonitor (输入监听)(系统接口)

输入监听模块，提供了监听输入设备事件的能力。输入设备事件当前包括触摸（触屏）事件、鼠标输入事件和触控板输入事件。

说明：

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

文档中“全局”表示整个触控屏或触控板。如监听全局触摸事件，表示触摸触控板任何位置时，整个触控板的触摸事件均被监听。

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

导入模块

import inputMonitor from '@ohos.multimodalInput.inputMonitor';

inputMonitor.on('touch')

on(type: 'touch', receiver: TouchEventReceiver): void

监听全局触摸（触屏）事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touch'。
receiver	TouchEventReceiver	是	回调函数，异步上报触摸屏输入事件。

示例：

import { TouchEvent } from '@ohos.multimodalInput.touchEvent';
try {
  inputMonitor.on('touch', (touchEvent: TouchEvent) => {
    console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('mouse')⁹⁺

on(type: 'mouse', receiver: Callback<MouseEvent>): void

监听全局鼠标事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'mouse'。
receiver	Callback<MouseEvent>	是	回调函数，异步上报鼠标输入事件。

示例：

import { MouseEvent } from '@ohos.multimodalInput.mouseEvent';

try {
  inputMonitor.on('mouse', (mouseEvent: MouseEvent) => {
    console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('mouse')¹¹⁺

on(type: 'mouse', rect: display.Rect[], receiver: Callback<MouseEvent>): void

监听鼠标事件，当鼠标移动至指定矩形区域内时，触发回调任务。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'mouse'。
rect	display.Rect[]	是	可以触发回调任务的矩形区域，可传入1至2个。
receiver	Callback<MouseEvent>	是	回调函数，异步上报鼠标输入事件。

示例：

import { MouseEvent } from '@ohos.multimodalInput.mouseEvent';
import promptAction from '@ohos.promptAction'
import display from '@ohos.display';

/**
 * 鼠标在矩形区域内时，触发的回调任务。
 */
function callback(mouseEvent : MouseEvent) {
  promptAction.showToast({
    message: `监听成功：${JSON.stringify(mouseEvent)}`
  })
  console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
  return false;
};

/**
 * 触发回调事件矩形区域。
 */
let rect: display.Rect[] = [{
  left: 100,
  top: 100,
  width: 100,
  height: 100
}, {
  left: 600,
  top: 100,
  width: 100,
  height: 100
}];

try {
  inputMonitor.on('mouse', rect, callback);
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('touch')

off(type: 'touch', receiver?: TouchEventReceiver): void

取消监听全局触摸（触屏）事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touch'。
receiver	TouchEventReceiver	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

import { TouchEvent } from '@ohos.multimodalInput.touchEvent';
// 取消监听单个回调函数
let callback = (touchEvent: TouchEvent) => {
  console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
  return false;
};
try {
  inputMonitor.on('touch', callback);
  inputMonitor.off('touch', callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

import { TouchEvent } from '@ohos.multimodalInput.touchEvent';
// 取消监听所有回调函数
let callback = (touchEvent: TouchEvent) => {
  console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
  return false;
};
try {
  inputMonitor.on('touch', callback);
  inputMonitor.off('touch');
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('mouse')⁹⁺

off(type: 'mouse', receiver?: Callback<MouseEvent>): void

取消监听全局鼠标事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'mouse'。
receiver	Callback<MouseEvent>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

import { MouseEvent } from '@ohos.multimodalInput.mouseEvent';
// 取消监听单个回调函数
let callback = (mouseEvent: MouseEvent) => {
  console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
  return false;
};
try {
  inputMonitor.on('mouse', callback);
  inputMonitor.off('mouse', callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

import { MouseEvent } from '@ohos.multimodalInput.mouseEvent';
// 取消监听所有回调函数
let callback = (mouseEvent: MouseEvent) => {
  console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
  return false;
};
try {
  inputMonitor.on('mouse', callback);
  inputMonitor.off('mouse');
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

TouchEventReceiver

(touchEvent: TouchEvent): Boolean

触摸（触屏）输入事件的回调函数。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
touchEvent	TouchEvent	是	触摸输入事件。

返回值：

类型	说明
Boolean	若返回true，本次触摸后续产生的事件不再分发到窗口；若返回false，本次触摸后续产生的事件还会分发到窗口。

示例：

import { TouchEvent } from '@ohos.multimodalInput.touchEvent';
try {
  inputMonitor.on('touch', touchEvent => {
    if (touchEvent.touches.length == 3) { // 当前有三个手指按下
      return true;
    }
    return false;
  });
} catch (error) {
    console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('pinch')¹⁰⁺

on(type: 'pinch', receiver: Callback<Pinch>): void

监听全局触控板的捏合事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'pinch'。
receiver	Callback<Pinch>	是	回调函数，异步上报捏合输入事件。

示例：

import type { Pinch } from '@ohos.multimodalInput.gestureEvent';
try {
  inputMonitor.on('pinch', (pinchEvent) => {
    console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('pinch')¹⁰⁺

off(type: 'pinch', receiver?: Callback<Pinch>): void

取消监听全局触控板的捏合事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'pinch'。
receiver	Callback<Pinch>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { Pinch } from '@ohos.multimodalInput.gestureEvent';

let callback = (pinchEvent: Pinch) => {
  console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
  return false;
};
try {
  inputMonitor.on('pinch', callback);
  inputMonitor.off('pinch', callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { Pinch } from '@ohos.multimodalInput.gestureEvent';

let callback = (pinchEvent: Pinch) => {
  console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
  return false;
};
try {
  inputMonitor.on('pinch', callback);
  inputMonitor.off('pinch');
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('threeFingersSwipe')¹⁰⁺

on(type: 'threeFingersSwipe', receiver: Callback<ThreeFingersSwipe>): void

监听全局触控板的三指滑动事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'threeFingersSwipe'。
receiver	Callback<ThreeFingersSwipe>	是	回调函数，异步上报三指滑动输入事件。

示例：

try {
  inputMonitor.on('threeFingersSwipe', (threeFingersSwipe) => {
    console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('threeFingersSwipe')¹⁰⁺

off(type: 'threeFingersSwipe', receiver?: Callback<ThreeFingersSwipe>): void

取消监听全局触控板的三指滑动事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'threeFingersSwipe'。
receiver	Callback<ThreeFingersSwipe>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { ThreeFingersSwipe } from '@ohos.multimodalInput.gestureEvent';

let callback = (threeFingersSwipe: ThreeFingersSwipe) => {
  console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
  return false;
};
try {
  inputMonitor.on('threeFingersSwipe', callback);
  inputMonitor.off("threeFingersSwipe", callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { ThreeFingersSwipe } from '@ohos.multimodalInput.gestureEvent';

let callback = (threeFingersSwipe: ThreeFingersSwipe) => {
  console.log(`Monitor on success ${JSON.stringify(threeFingersSwipe)}`);
  return false;
};
try {
  inputMonitor.on("threeFingersSwipe", callback);
  inputMonitor.off("threeFingersSwipe");
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('fourFingersSwipe')¹⁰⁺

on(type: 'fourFingersSwipe', receiver: Callback<FourFingersSwipe>): void

监听全局触控板的四指滑动事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'fourFingersSwipe'。
receiver	Callback<FourFingersSwipe>	是	回调函数，异步上报四指滑动输入事件。

示例：

try {
  inputMonitor.on('fourFingersSwipe', (fourFingersSwipe) => {
    console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('fourFingersSwipe')¹⁰⁺

off(type: 'fourFingersSwipe', receiver?: Callback<FourFingersSwipe>): void

取消监听全局触控板的四指滑动事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'fourFingersSwipe'。
receiver	Callback<FourFingersSwipe>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { FourFingersSwipe } from '@ohos.multimodalInput.gestureEvent';

let callback = (fourFingersSwipe: FourFingersSwipe) => {
  console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
  return false;
};
try {
  inputMonitor.on('fourFingersSwipe', callback);
  inputMonitor.off('fourFingersSwipe', callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { FourFingersSwipe } from '@ohos.multimodalInput.gestureEvent';

let callback = (fourFingersSwipe: FourFingersSwipe) => {
  console.log(`Monitor on success ${JSON.stringify(fourFingersSwipe)}`);
  return false;
};
try {
  inputMonitor.on('fourFingersSwipe', callback);
  inputMonitor.off('fourFingersSwipe');
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('rotate')¹¹⁺

on(type: 'rotate', fingers: number, receiver: Callback<Rotate>): void

监听全局触控板的旋转事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'rotate'。
fingers	number	是	旋转的手指数，目前支持监听手指数是2。
receiver	Callback<Rotate>	是	回调函数，异步上报旋转输入事件。

示例：

import type { Rotate } from '@ohos.multimodalInput.gestureEvent';
try {
  inputMonitor.on('rotate', 2, (rotateEvent: Rotate) => {
    console.log(`Monitor on success ${JSON.stringify(rotateEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('rotate')¹¹⁺

off(type: 'rotate', fingers: number, receiver?: Callback<Rotate>): void

取消监听全局触控板的旋转事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'rotate'。
fingers	number	是	旋转的手指数，目前支持监听手指数是2。
receiver	Callback<Rotate>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { Rotate } from '@ohos.multimodalInput.gestureEvent';

let callback = (rotateEvent: Rotate) => {
  console.log(`Monitor on success ${JSON.stringify(rotateEvent)}`);
  return false;
};
try {
  inputMonitor.on('rotate', 2, callback);
  inputMonitor.off('rotate', 2, callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { Rotate } from '@ohos.multimodalInput.gestureEvent';

let callback = (rotateEvent: Rotate) => {
  console.log(`Monitor on success ${JSON.stringify(rotateEvent)}`);
  return false;
};
try {
  inputMonitor.on('rotate', 2, callback);
  inputMonitor.off('rotate', 2);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('pinch')¹¹⁺

on(type: 'pinch', fingers: number, receiver: Callback<Pinch>): void

监听全局触控板的捏合事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'pinch'。
fingers	number	是	捏合的手指数，取值范围：大于等于2。
receiver	Callback<Pinch>	是	回调函数，异步上报捏合输入事件。

示例：

import type { Pinch } from '@ohos.multimodalInput.gestureEvent';
try {
  inputMonitor.on('pinch', 2, (pinchEvent: Pinch) => {
    console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('pinch')¹¹⁺

off(type: 'pinch', fingers: number, receiver?: Callback<Pinch>): void

取消监听全局触控板的捏合事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'pinch'。
fingers	number	是	捏合的手指数，取值范围：大于等于2。
receiver	Callback<Pinch>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { Pinch } from '@ohos.multimodalInput.gestureEvent';

let callback = (pinchEvent: Pinch) => {
  console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
  return false;
};
try {
  inputMonitor.on('pinch', 2, callback);
  inputMonitor.off('pinch', 2, callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { Pinch } from '@ohos.multimodalInput.gestureEvent';

let callback = (pinchEvent: Pinch) => {
  console.log(`Monitor on success ${JSON.stringify(pinchEvent)}`);
  return false;
};
try {
  inputMonitor.on('pinch', 2, callback);
  inputMonitor.off('pinch', 2);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.on('threeFingersTap')¹¹⁺

on(type: 'threeFingersTap', receiver: Callback<ThreeFingersTap>): void

监听全局触控板的三指轻点事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'threeFingersTap'。
receiver	Callback<ThreeFingersTap>	是	回调函数，异步上报三指轻点输入事件。

示例：

try {
  inputMonitor.on('threeFingersTap', (threeFingersTap) => {
    console.log(`Monitor on success ${JSON.stringify(threeFingersTap)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputMonitor.off('threeFingersTap')¹¹⁺

off(type: 'threeFingersTap', receiver?: Callback<ThreeFingersTap>): void

取消监听全局触控板的三指轻点事件。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'threeFingersTap'。
receiver	Callback<ThreeFingersTap>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

示例：

// 取消监听单个回调函数
import { ThreeFingersTap } from '@ohos.multimodalInput.gestureEvent';

let callback = (threeFingersTap: ThreeFingersTap) => {
  console.log(`Monitor on success ${JSON.stringify(threeFingersTap)}`);
  return false;
};
try {
  inputMonitor.on('threeFingersTap', callback);
  inputMonitor.off("threeFingersTap", callback);
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

// 取消监听所有回调函数
import { ThreeFingersTap } from '@ohos.multimodalInput.gestureEvent';

let callback = (threeFingersTap: ThreeFingersTap) => {
  console.log(`Monitor on success ${JSON.stringify(threeFingersTap)}`);
  return false;
};
try {
  inputMonitor.on('threeFingersTap', callback);
  inputMonitor.off("threeFingersTap");
  console.log(`Monitor off success`);
} catch (error) {
  console.log(`Monitor execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

@ohos.multimodalInput.inputMonitor (输入监听)(系统接口)

导入模块

inputMonitor.on('touch')

inputMonitor.on('mouse')9+

inputMonitor.on('mouse')11+

inputMonitor.off('touch')

inputMonitor.off('mouse')9+

TouchEventReceiver

inputMonitor.on('pinch')10+

inputMonitor.off('pinch')10+

inputMonitor.on('threeFingersSwipe')10+

inputMonitor.off('threeFingersSwipe')10+

inputMonitor.on('fourFingersSwipe')10+

inputMonitor.off('fourFingersSwipe')10+

inputMonitor.on('rotate')11+

inputMonitor.off('rotate')11+

inputMonitor.on('pinch')11+

inputMonitor.off('pinch')11+

inputMonitor.on('threeFingersTap')11+

inputMonitor.off('threeFingersTap')11+

inputMonitor.on('mouse')⁹⁺

inputMonitor.on('mouse')¹¹⁺

inputMonitor.off('mouse')⁹⁺

inputMonitor.on('pinch')¹⁰⁺

inputMonitor.off('pinch')¹⁰⁺

inputMonitor.on('threeFingersSwipe')¹⁰⁺

inputMonitor.off('threeFingersSwipe')¹⁰⁺

inputMonitor.on('fourFingersSwipe')¹⁰⁺

inputMonitor.off('fourFingersSwipe')¹⁰⁺

inputMonitor.on('rotate')¹¹⁺

inputMonitor.off('rotate')¹¹⁺

inputMonitor.on('pinch')¹¹⁺

inputMonitor.off('pinch')¹¹⁺

inputMonitor.on('threeFingersTap')¹¹⁺

inputMonitor.off('threeFingersTap')¹¹⁺