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

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

说明：

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

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

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

导入模块

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

inputMonitor.on('touch')

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

监听全局触屏输入事件，使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅触摸事件
            inputMonitor.on('touch', (touchEvent: TouchEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(touchEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor the touch screen event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('mouse')⁹⁺

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

监听全局鼠标事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅鼠标事件
            inputMonitor.on('mouse', (mouseEvent: MouseEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(mouseEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor the mouse event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('mouse')¹¹⁺

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

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

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { MouseEvent } from '@kit.InputKit';
import { display } from '@kit.ArkUI';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          /**
           * 鼠标在矩形区域内时，触发的回调任务。
           */
          let callback = (mouseEvent : MouseEvent) => {
            this.getUIContext().getPromptAction().showToast({
              message: `监听成功：${JSON.stringify(mouseEvent)}`
            })
            console.info(`Succeeded in monitoring on ${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.error(`Failed to monitor the mouse event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('touch')

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

取消监听全局触屏输入事件，使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (touchEvent: TouchEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(touchEvent)}.`);
            return false;
          };
          try {
            // 订阅触摸事件
            inputMonitor.on('touch', callback);
            // 取消订阅触摸事件
            inputMonitor.off('touch', callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to monitor the touch screen event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { TouchEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (touchEvent: TouchEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(touchEvent)}.`);
            return false;
          };
          try {
            // 订阅触摸事件
            inputMonitor.on('touch', callback);
            // 取消订阅触摸事件
            inputMonitor.off('touch');
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to monitor the touch screen event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('mouse')⁹⁺

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

取消监听全局鼠标事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (mouseEvent: MouseEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(mouseEvent)}.`);
            return false;
          };
          try {
            // 订阅鼠标事件
            inputMonitor.on('mouse', callback);
            // 取消订阅鼠标事件
            inputMonitor.off('mouse', callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to monitor the mouse event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (mouseEvent: MouseEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(mouseEvent)}.`);
            return false;
          };
          try {
            // 订阅鼠标事件
            inputMonitor.on('mouse', callback);
            // 取消订阅鼠标事件
            inputMonitor.off('mouse');
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to monitor the mouse event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

TouchEventReceiver

type TouchEventReceiver = (touchEvent: TouchEvent) => boolean

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

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

返回值：

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

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅触摸事件
            inputMonitor.on('touch', touchEvent => {
              if (touchEvent.touches.length === 3) { // 当前有三个手指按下
                return true;
              }
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor the touch screen event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('pinch')¹⁰⁺

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

监听全局触控板的捏合事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅捏合事件
            inputMonitor.on('pinch', (pinchEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor the pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('pinch')¹⁰⁺

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

取消监听全局触控板的捏合事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { Pinch } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (pinchEvent: Pinch) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
            return false;
          };
          try {
            // 订阅捏合事件
            inputMonitor.on('pinch', callback);
            // 取消订阅捏合事件
            inputMonitor.off('pinch', callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { Pinch } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (pinchEvent: Pinch) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
            return false;
          };
          try {
            // 订阅捏合事件
            inputMonitor.on('pinch', callback);
            // 取消订阅捏合事件
            inputMonitor.off('pinch');
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('threeFingersSwipe')¹⁰⁺

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

监听全局触控板的三指滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅三指滑动事件
            inputMonitor.on('threeFingersSwipe', (threeFingersSwipe) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersSwipe)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor three fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('threeFingersSwipe')¹⁰⁺

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

取消监听全局触控板的三指滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { ThreeFingersSwipe } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (threeFingersSwipe: ThreeFingersSwipe) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersSwipe)}.`);
            return false;
          };
          try {
            // 订阅三指滑动事件
            inputMonitor.on('threeFingersSwipe', callback);
            // 取消订阅三指滑动事件
            inputMonitor.off("threeFingersSwipe", callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor three fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { ThreeFingersSwipe } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (threeFingersSwipe: ThreeFingersSwipe) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersSwipe)}.`);
            return false;
          };
          try {
            // 订阅三指滑动事件
            inputMonitor.on("threeFingersSwipe", callback);
            // 取消订阅三指滑动事件
            inputMonitor.off("threeFingersSwipe");
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor three fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('fourFingersSwipe')¹⁰⁺

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

监听全局触控板的四指滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅四指滑动事件
            inputMonitor.on('fourFingersSwipe', (fourFingersSwipe) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(fourFingersSwipe)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor four fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('fourFingersSwipe')¹⁰⁺

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

取消监听全局触控板的四指滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { FourFingersSwipe } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (fourFingersSwipe: FourFingersSwipe) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(fourFingersSwipe)}.`);
            return false;
          };
          try {
            // 订阅四指滑动事件
            inputMonitor.on('fourFingersSwipe', callback);
            // 取消订阅四指滑动事件
            inputMonitor.off('fourFingersSwipe', callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitoring four fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { FourFingersSwipe } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (fourFingersSwipe: FourFingersSwipe) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(fourFingersSwipe)}.`);
            return false;
          };
          try {
            // 订阅四指滑动事件
            inputMonitor.on('fourFingersSwipe', callback);
            // 取消订阅四指滑动事件
            inputMonitor.off('fourFingersSwipe');
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitoring four fingers swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('rotate')¹¹⁺

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

监听全局触控板的旋转事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { Rotate } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 旋转手势监听手指数2
            inputMonitor.on('rotate', 2, (rotateEvent: Rotate) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(rotateEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor rotate event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('rotate')¹¹⁺

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

取消监听全局触控板的旋转事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { Rotate } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (rotateEvent: Rotate) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(rotateEvent)}.`);
            return false;
          };
          try {
            // 旋转手势监听手指数2
            inputMonitor.on('rotate', 2, callback);
            // 取消订阅旋转事件
            inputMonitor.off('rotate', 2, callback);
            console.info(`Succeeded in turning off monitor.`); 
          } catch (error) {
            console.error(`Failed to cancel monitor rotate event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { Rotate } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (rotateEvent: Rotate) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(rotateEvent)}.`);
            return false;
          };
          try {
            // 旋转手势监听手指数2
            inputMonitor.on('rotate', 2, callback);
            // 取消订阅旋转事件
            inputMonitor.off('rotate', 2);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor rotate event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('pinch')¹¹⁺

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

监听全局触控板的捏合事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { Pinch } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 捏合手势监听手指数2
            inputMonitor.on('pinch', 2, (pinchEvent: Pinch) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('pinch')¹¹⁺

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

取消监听全局触控板的捏合事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { Pinch } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (pinchEvent: Pinch) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
            return false;
          };
          try {
            // 订阅捏合事件
            inputMonitor.on('pinch', 2, callback);
            // 取消订阅捏合事件
            inputMonitor.off('pinch', 2, callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { Pinch } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (pinchEvent: Pinch) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(pinchEvent)}.`);
            return false;
          };
          try {
            // 捏合手势监听手指数2
            inputMonitor.on('pinch', 2, callback);
            // 取消订阅捏合事件
            inputMonitor.off('pinch', 2);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor pinch event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('threeFingersTap')¹¹⁺

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

监听全局触控板的三指轻点事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅三指点击事件
            inputMonitor.on('threeFingersTap', (threeFingersTap) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersTap)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor three fingers tap, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('threeFingersTap')¹¹⁺

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

取消监听全局触控板的三指轻点事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { ThreeFingersTap } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (threeFingersTap: ThreeFingersTap) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersTap)}.`);
            return false;
          };
          try {
            // 订阅三指点击事件
            inputMonitor.on('threeFingersTap', callback);
            // 取消订阅三指点击事件
            inputMonitor.off("threeFingersTap", callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor three fingers tap, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { ThreeFingersTap } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (threeFingersTap: ThreeFingersTap) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(threeFingersTap)}.`);
            return false;
          };
          try {
            // 订阅三指点击事件
            inputMonitor.on('threeFingersTap', callback);
            // 取消订阅三指点击事件
            inputMonitor.off("threeFingersTap");
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor three fingers tap, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('touchscreenSwipe')¹⁸⁺

on(type: 'touchscreenSwipe', fingers: number, receiver: Callback<TouchGestureEvent>): void

监听触摸屏滑动手势事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touchscreenSwipe'。
fingers	number	是	滑动手势的手指数，取值范围：[3,5]。
receiver	Callback<TouchGestureEvent>	是	回调函数，返回触摸屏滑动手势事件。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          let fingers: number = 4;
          try {
            // 订阅触摸屏滑动事件
            inputMonitor.on('touchscreenSwipe', fingers, (event: TouchGestureEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
          } catch (error) {
            console.error(`Failed to monitor touch screen swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('touchscreenSwipe')¹⁸⁺

off(type: 'touchscreenSwipe', fingers: number, receiver?: Callback<TouchGestureEvent>): void

取消监听触摸屏滑动手势事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touchscreenSwipe'。
fingers	number	是	滑动手势的手指数，取值范围：[3,5]。
receiver	Callback<TouchGestureEvent>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (event: TouchGestureEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
          };
          let fingers: number = 4;
          try {
            // 订阅触摸屏滑动事件
            inputMonitor.on('touchscreenSwipe', fingers, callback);
            // 取消订阅触摸屏滑动事件
            inputMonitor.off('touchscreenSwipe', fingers, callback);
          } catch (error) {
            console.error(`Failed to cancel monitor touch screen swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let fingers: number = 4;
          try {
            // 订阅触摸屏滑动事件
            inputMonitor.on('touchscreenSwipe', fingers, (event: TouchGestureEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
            // 取消订阅触摸屏滑动事件
            inputMonitor.off('touchscreenSwipe', fingers);
          } catch (error) {
            console.error(`Failed to monitor touch screen swipe, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('touchscreenPinch')¹⁸⁺

on(type: 'touchscreenPinch', fingers: number, receiver: Callback<TouchGestureEvent>): void

监听触摸屏捏合手势事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touchscreenPinch'。
fingers	number	是	捏合手势的手指数，取值范围：[4,5]。
receiver	Callback<TouchGestureEvent>	是	回调函数，返回触摸屏捏合手势事件。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          let fingers: number = 4;
          try {
            // 订阅触摸屏捏合事件
            inputMonitor.on('touchscreenPinch', fingers, (event: TouchGestureEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
          } catch (error) {
            console.error(`Failed to monitor touch screen pinch, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('touchscreenPinch')¹⁸⁺

off(type: 'touchscreenPinch', fingers: number, receiver?: Callback<TouchGestureEvent>): void

取消监听触摸屏捏合手势事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入设备事件类型，取值'touchscreenPinch'。
fingers	number	是	捏合手势的手指数，取值范围：[4,5]。
receiver	Callback<TouchGestureEvent>	否	需要取消监听的回调函数。若不填，则取消当前应用监听的所有回调函数。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Caller is not a system application.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (event: TouchGestureEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
          };
          let fingers: number = 4;
          try {
            // 订阅触摸屏捏合事件
            inputMonitor.on('touchscreenPinch', fingers, callback);
            // 取消订阅触摸屏捏合事件
            inputMonitor.off("touchscreenPinch", fingers, callback);
          } catch (error) {
            console.error(`Failed to cancel monitor touch screen pinch, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { TouchGestureEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let fingers: number = 4;
          try {
            // 订阅触摸屏捏合事件
            inputMonitor.on('touchscreenPinch', fingers, (event: TouchGestureEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
            // 取消订阅触摸屏捏合事件
            inputMonitor.off("touchscreenPinch", fingers);
          } catch (error) {
            console.error(`Failed to cancel monitor touch screen pinch, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.on('keyPressed')¹⁵⁺

on(type: 'keyPressed', keys: Array<KeyCode>, receiver: Callback<KeyEvent>): void

监听指定按键的按下抬起事件，支持监听META_LEFT键、META_RIGHT键、电源键、音量键。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	按键事件类型，取唯一值'keyPressed'。
keys	Array<KeyCode>	是	键值，支持如下键值：KEYCODE_META_LEFT、KEYCODE_META_RIGHT、KEYCODE_POWER、KEYCODE_VOLUME_DOWN、KEYCODE_VOLUME_UP。
receiver	Callback<KeyEvent>	是	回调函数，返回按键输入事件。

错误码：

以下错误码的详细介绍请参见通用错误码和按键前置监听错误码。

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
4100001	Event listening not supported for the key.

示例：

import { inputMonitor, KeyEvent, KeyCode } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            let keys: Array<KeyCode> = [KeyCode.KEYCODE_VOLUME_UP];
            // 订阅按键按下事件
            inputMonitor.on('keyPressed', keys, (event: KeyEvent ) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
          } catch (error) {
            console.error(`Failed to monitor key pressed, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('keyPressed')¹⁵⁺

off(type: 'keyPressed', receiver?: Callback<KeyEvent>): void

取消监听按键按下抬起事件。支持取消监听META_LEFT键、META_RIGHT键、电源键、音量键。需和inputMonitor.on('keyPressed')配套使用。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	按键事件类型，取唯一值'keyPressed'。
receiver	Callback<KeyEvent>	否	需要取消监听的回调函数。若不填，取消应用所有按键监听的回调函数。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor, KeyEvent, KeyCode } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          try {
            let callback = (event: KeyEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            };
            let keys: Array<KeyCode> = [KeyCode.KEYCODE_VOLUME_UP];
            // 订阅按键按下事件
            inputMonitor.on('keyPressed', keys, callback);
            // 取消订阅按键按下事件
            inputMonitor.off("keyPressed", callback);
          } catch (error) {
            console.error(`Failed to cancel monitor key pressed, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor, KeyEvent, KeyCode } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          try {
            let keys: Array<KeyCode> = [KeyCode.KEYCODE_VOLUME_UP];
            // 订阅按键按下事件
            inputMonitor.on('keyPressed', keys, (event: KeyEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(event)}.`);
            });
            // 取消订阅按键按下事件
            inputMonitor.off("keyPressed");
          } catch (error) {
            console.error(`Failed to cancel monitor key pressed, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.queryTouchEvents()²⁰⁺

queryTouchEvents(count: number): Promise<Array<TouchEvent>>

查询最近的触屏输入事件，最多支持查询100条事件，从API版本26.0.0开始，最多支持查询60条事件，使用Promise异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
count	number	是	需要查询的触屏输入事件数量，取值范围为0到100的整数。小于0时取值为0、大于100时取值为100。从API版本26.0.0开始，大于60时取值为60。如果实际触屏输入事件只有30个，但该参数取值为50 ，则仅支持查询到30个触屏输入事件。

返回值：

类型	说明
Promise<Array<TouchEvent>>	Promise对象，返回查询到的触屏输入事件。包含以下有效信息，其余均为无效信息： - actionTime：触屏输入事件发生的时间，表示系统启动运行至今逝去的微秒数，单位为微秒（μs）。 - SourceType：触摸来源的设备类型。 - isInject：表示该触屏输入事件是否为注入事件。 - pressure：压力值，取值范围是[0.0, 1.0]，0.0表示不支持。 - tiltX：相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。 - tiltY：相对XZ平面的角度，取值的范围[-90, 90]，其中正值是向下倾斜。从API version 23开始，可以额外获取以下有效信息： - Action：触屏输入事件类型。 - screenX：相对于屏幕左上角的X轴坐标，单位为像素，取值范围[0, 屏幕宽度]，向右递增。仅限指定应用获取。 - screenY：相对于屏幕左上角的Y轴坐标，单位为像素，取值范围[0, 屏幕高度]，向下递增。仅限指定应用获取。从API版本26.0.0开始，最多支持查询60条事件，且不会返回MOVE和PULL_MOVE类型的事件。screenX和screenY不再限制指定应用获取，所有系统应用均可获取。同时可以额外获取以下有效信息： - screenId：目标屏幕ID。

类型

说明

Promise<Array<TouchEvent>>

Promise对象，返回查询到的触屏输入事件。包含以下有效信息，其余均为无效信息：
- actionTime：触屏输入事件发生的时间，表示系统启动运行至今逝去的微秒数，单位为微秒（μs）。
- SourceType：触摸来源的设备类型。
- isInject：表示该触屏输入事件是否为注入事件。
- pressure：压力值，取值范围是[0.0, 1.0]，0.0表示不支持。
- tiltX：相对YZ平面的角度，取值的范围[-90, 90]，其中正值是向右倾斜。
- tiltY：相对XZ平面的角度，取值的范围[-90, 90]，其中正值是向下倾斜。
从API version 23开始，可以额外获取以下有效信息：
- Action：触屏输入事件类型。
- screenX：相对于屏幕左上角的X轴坐标，单位为像素，取值范围[0, 屏幕宽度]，向右递增。仅限指定应用获取。
- screenY：相对于屏幕左上角的Y轴坐标，单位为像素，取值范围[0, 屏幕高度]，向下递增。仅限指定应用获取。
从API版本26.0.0开始，最多支持查询60条事件，且不会返回MOVE和PULL_MOVE类型的事件。screenX和screenY不再限制指定应用获取，所有系统应用均可获取。同时可以额外获取以下有效信息：
- screenId：目标屏幕ID。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	Permission denied, non-system app called system api.

示例：

import { inputMonitor, TouchEvent } from '@kit.InputKit'
import { BusinessError } from '@kit.BasicServicesKit';

try {
  // 查询触屏事件数量
  inputMonitor.queryTouchEvents(10).then((events: Array<TouchEvent>) => {
    events.forEach((event, index) => {
      console.info(`Succeeded in querying touch event ${index}, actionTime=${event.actionTime}, sourceType=${event.sourceType}.`);
    });
  }).catch((error: BusinessError) => {
    console.error(`Failed to query touch events promise, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
  });
} catch (error) {
  const code = (error as BusinessError).code;
  const message = (error as BusinessError).message;
  console.error(`Failed to query touch events, Code: ${code}, message: ${message}.`);
}

inputMonitor.on('swipeInward')¹²⁺

on(type: 'swipeInward', receiver: Callback<SwipeInward>): void

监听向内滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入事件类型，取唯一值'SwipeInward'。
receiver	Callback<SwipeInward>	是	回调函数，返回向内滑动事件。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅向内滑动事件
            inputMonitor.on('swipeInward', (SwipeInward) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(SwipeInward)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor swipe inward, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('swipeInward')¹²⁺

off(type: 'swipeInward', receiver?: Callback<SwipeInward>): void

取消监听向内滑动事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor, SwipeInward } from '@kit.InputKit';

@Entry
@Component
struct Index {
build() {
  RelativeContainer() {
    Text()
      .onClick(() => {
        // 取消监听单个回调函数
        let callback = (swipeInward: SwipeInward) => {
          console.info(`Succeeded in monitoring on ${JSON.stringify(swipeInward)}.`);
          return false;
        };
        try {
          // 订阅向内滑动事件
          inputMonitor.on('swipeInward', callback);
          // 取消订阅向内滑动事件
          inputMonitor.off("swipeInward", callback);
          console.info(`Succeeded in turning off monitor.`);
        } catch (error) {
          console.error(`Failed to cancel monitor swipe inward, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
        }
      })
  }
}
}

import { inputMonitor, SwipeInward } from '@kit.InputKit';

@Entry
@Component
struct Index {
build() {
  RelativeContainer() {
    Text()
      .onClick(() => {
        // 取消监听所有回调函数
        let callback = (swipeInward: SwipeInward) => {
          console.info(`Succeeded in monitoring on ${JSON.stringify(swipeInward)}.`);
          return false;
        };
        try {
          // 订阅向内滑动事件
          inputMonitor.on('swipeInward', callback);
          // 取消订阅向内滑动事件
          inputMonitor.off("swipeInward");
          console.info(`Succeeded in turning off monitor.`);
        } catch (error) {
          console.error(`Failed to cancel monitor swipe inward, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
        }
      })
  }
}
}

inputMonitor.on('fingerprint')¹²⁺

on(type: 'fingerprint', receiver: Callback<FingerprintEvent>): void

监听指纹手势输入事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

参数名	类型	必填	说明
type	string	是	输入事件类型，取唯一值'fingerprint'。
receiver	Callback<FingerprintEvent>	是	回调函数，返回指纹器件手势输入事件。

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 订阅指纹事件
            inputMonitor.on('fingerprint', (FingerprintEvent) => {
              console.info(`Succeeded in monitoring on ${JSON.stringify(FingerprintEvent)}.`);
              return false;
            });
          } catch (error) {
            console.error(`Failed to monitor finger print event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

inputMonitor.off('fingerprint')¹²⁺

off(type: 'fingerprint', receiver?: Callback<FingerprintEvent>): void

取消监听指纹手势输入事件。使用callback异步回调。

需要权限： ohos.permission.INPUT_MONITORING

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

参数：

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

错误码：

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

错误码ID	错误信息
201	Permission denied.
202	SystemAPI permit error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { inputMonitor } from '@kit.InputKit';
import { FingerprintEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听单个回调函数
          let callback = (fingerprintEvent: FingerprintEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(fingerprintEvent)}.`);
            return false;
          };
          try {
            // 订阅指纹事件
            inputMonitor.on('fingerprint', callback);
            // 取消订阅指纹事件
            inputMonitor.off("fingerprint", callback);
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor finger print event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

import { inputMonitor } from '@kit.InputKit';
import { FingerprintEvent } from '@kit.InputKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          // 取消监听所有回调函数
          let callback = (fingerprintEvent: FingerprintEvent) => {
            console.info(`Succeeded in monitoring on ${JSON.stringify(fingerprintEvent)}.`);
            return false;
          };
          try {
            // 订阅指纹事件
            inputMonitor.on('fingerprint', callback);
            // 取消订阅指纹事件
            inputMonitor.off("fingerprint");
            console.info(`Succeeded in turning off monitor.`);
          } catch (error) {
            console.error(`Failed to cancel monitor finger print event, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).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('touchscreenSwipe')18+

inputMonitor.off('touchscreenSwipe')18+

inputMonitor.on('touchscreenPinch')18+

inputMonitor.off('touchscreenPinch')18+

inputMonitor.on('keyPressed')15+

inputMonitor.off('keyPressed')15+

inputMonitor.queryTouchEvents()20+

inputMonitor.on('swipeInward')12+

inputMonitor.off('swipeInward')12+

inputMonitor.on('fingerprint')12+

inputMonitor.off('fingerprint')12+

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')¹¹⁺

inputMonitor.on('touchscreenSwipe')¹⁸⁺

inputMonitor.off('touchscreenSwipe')¹⁸⁺

inputMonitor.on('touchscreenPinch')¹⁸⁺

inputMonitor.off('touchscreenPinch')¹⁸⁺

inputMonitor.on('keyPressed')¹⁵⁺

inputMonitor.off('keyPressed')¹⁵⁺

inputMonitor.queryTouchEvents()²⁰⁺

inputMonitor.on('swipeInward')¹²⁺

inputMonitor.off('swipeInward')¹²⁺

inputMonitor.on('fingerprint')¹²⁺

inputMonitor.off('fingerprint')¹²⁺