@ohos.multimodalInput.inputMonitor (输入监听)


@ohos.multimodalInput.inputMonitor (输入监听)

输入监听模块,提供了监听输入设备事件(当前支持触摸屏和鼠标)的能力。

说明:

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

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

导入模块

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

inputMonitor.on

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

开始监听全局触屏事件。

需要权限: ohos.permission.INPUT_MONITORING

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

参数:

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

示例:

try {
  inputMonitor.on("touch", (touchEvent) => {
    console.log(`Monitor on success ${JSON.stringify(touchEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
1
2
3
4
5
6
7
8

inputMonitor.on9+

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

开始监听全局鼠标事件。

需要权限: ohos.permission.INPUT_MONITORING

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

参数:

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

示例:

try {
  inputMonitor.on("mouse", (mouseEvent) => {
    console.log(`Monitor on success ${JSON.stringify(mouseEvent)}`);
    return false;
  });
} catch (error) {
  console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
1
2
3
4
5
6
7
8

inputMonitor.off

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

停止监听全局触屏事件。

需要权限: ohos.permission.INPUT_MONITORING

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

参数:

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

示例:

// 取消监听单个回调函数
function callback(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`])}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
// 取消监听所有回调函数
function callback(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`])}`);
}
1
2
3
4
5
6
7
8
9
10
11
12

inputMonitor.off9+

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

停止监听全局鼠标事件。

需要权限: ohos.permission.INPUT_MONITORING

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

参数:

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

示例:

// 取消监听单个回调函数
function callback(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`])}`);
}
1
2
3
4
5
6
7
8
9
10
11
12
// 取消监听所有回调函数
function callback(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`])}`);
}
1
2
3
4
5
6
7
8
9
10
11
12

TouchEventReceiver

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

需要权限: ohos.permission.INPUT_MONITORING

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

参数:

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

返回值:

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

示例:

try {
  inputMonitor.on("touch", touchEvent => {
    if (touchEvent.touches.length == 3) { // 当前有三个手指按下
      return true;
    } else {
      return false;
    }
  });
} catch (error) {
    console.log(`Monitor on failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}
1
2
3
4
5
6
7
8
9
10
11