From ce53bd6635770deffbaf89e00dbac3ee8230ad27 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Mon, 21 Mar 2022 11:21:12 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- zh-cn/application-dev/media/video-playback.md | 2 +- .../reference/apis/js-apis-inputconsumer.md | 86 ++++++++++++++ .../reference/apis/js-apis-inputdevice.md | 112 ++++++++++++++++++ 3 files changed, 199 insertions(+), 1 deletion(-) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-inputdevice.md diff --git a/zh-cn/application-dev/media/video-playback.md b/zh-cn/application-dev/media/video-playback.md index 16cdafc618..0f976e3aff 100644 --- a/zh-cn/application-dev/media/video-playback.md +++ b/zh-cn/application-dev/media/video-playback.md @@ -462,7 +462,7 @@ await videoPlayer.play().then(() => { ### Xcomponent创建方法 -播放视频中获取surfaceID依赖了Xcomponent,需要创建一个和xxx.js同名的xxx.hml文件,xxx.hml里面需要添加如下代码： +播放视频中获取surfaceID依赖了Xcomponent，需要创建一个和xxx.js同名的xxx.hml文件，xxx.hml里面需要添加如下代码： ```js ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> +> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> - 本模块接口均为系统接口，三方应用不支持调用。 + + +## 导入模块 + + +``` +import inputConsumer from '@ohos.multimodalInput.inputConsumer'; +``` + + +## inputConsumer.on + +on(type: "key", keyOption: KeyOption, callback: Callback<KeyOption>): void + +开始监听组合按键事件, 当满足条件的组合按键输入事件发生时，将KeyOption回调到入参callback表示的回调函数上。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer + +**参数：** + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听输入事件类型，只支持“key”。 | +| keyOption | [KeyOption](#keyoption) | 是 | 组合键选项，用来指定组合键输入时应该符合的条件。 | +| callback | Callback<KeyOption> | 是 | 回调函数。当满足条件的按键输入产生时，回调到此函数，以传入的keyOption为入参。 | + +**示例：** + +``` +let keyOption = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} +let callback = function(keyOption) { + console.info("preKeys: " + keyOption.preKeys, "finalKey: " + keyOption.finalKey, + "isFinalKeyDown: " + keyOption.isFinalKeyDown, "finalKeyDownDuration: " + keyOption.finalKeyDownDuration) +} +inputConsumer.on('key', keyOption, callback); +``` + + +## inputConsumer.off + +off(type: "key", keyOption: KeyOption, callback: Callback<KeyOption>): void + +停止监听组合按键事件。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer + +**参数：** + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| type | string | 是 | 监听输入事件类型，只支持“key”。 | +| keyOption | [KeyOption](#keyoption) | 是 | 开始监听时传入的KeyOption。 | +| callback | Callback<KeyOption> | 是 | 开始监听时与KeyOption一同传入的回调函数 。 | + +**示例：** + +``` +let keyOption = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} +let callback = function(keyOption) { + console.info("preKeys: " + keyOption.preKeys, "finalKey: " + keyOption.finalKey, + "isFinalKeyDown: " + keyOption.isFinalKeyDown, "finalKeyDownDuration: " + keyOption.finalKeyDownDuration) +} +inputConsumer.off('key', keyOption, callback); +``` + + +## KeyOption + +组合键输入事件发生时，组合键满足的选项。 + +**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputConsumer + + | 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| preKeys | Array | 是 | 组合键前置按键集合，可为空，前置按键无顺序要求。 | +| finalKey | Number | 是 | 组合键最后按键，不能为空。 | +| isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起，默认是按下。 | +| finalKeyDownDuration | Number | 是 | 组合键最后按键按下持续时长，默认无时长要求。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md new file mode 100644 index 0000000000..8d07bea349 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -0,0 +1,112 @@ +# 输入设备 + + +输入设备管理模块，用于监听输入设备连接、断开和变化，并查看输入设备相关信息。比如监听鼠标插拔，并获取鼠标的id、name和指针移动速度等信息。 + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + + +``` +import inputDevice from '@ohos.multimodalInput.inputDevice'; +``` + + +## inputDevice.getDeviceIds + +getDeviceIds(callback: AsyncCallback<Array<number>>): void + +获取所有输入设备的id列表，使用callback方式作为异步方法。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputDevice + +**参数：** + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<Array<number>> | 是 | 回调函数。 | + +**示例：** + +``` +data: { + deviceIds: Array, +}, +callback: function(ids) { + this.deviceIds = ids; +}, +testGetDeviceIds: function () { + console.info("InputDeviceJsTest---start---testGetDeviceIds"); + inputDevice.getDeviceIds(this.callback); + console.info("InputDeviceJsTest---end---testGetDeviceIds"); +} +``` + + +## inputDevice.getDevice + +getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): void + +获取输入设备的描述信息，使用callback方式作为异步方法。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputDevice + +**参数：** + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| deviceId | number | 是 | 需要获取信息的设备id。 | +| callback | AsyncCallback<[InputDeviceData](#inputdevicedata)> | 是 | 回调函数，异步返回InputDeviceData对象。 | + +**示例：** + +``` +InputDeviceData { + deviceId : 0, + name : "NA", + sources : Array, + axisRanges : Array, +}, +callback: function(deviceData) { + this.InputDeviceData = deviceData; +}, +testGetDevice: function () { + // 示例获取设备id为1的设备信息。 + console.info("InputDeviceJsTest---start---testGetDevice"); + inputDevice.getDevice(1, this.callback); + console.info("InputDeviceJsTest---end---testGetDevice"); +} +``` + + +## InputDeviceData + +输入设备的描述信息。 + +**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputDevice + + | 名称 | 参数类型 | 说明 | +| -------- | -------- | -------- | +| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | +| name | string | 输入设备的名字。 | +| sources | Array<[SourceType](#sourcetype)> | 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 | + + +## SourceType + +定义这个轴的输入源类型。比如鼠标设备可上报x轴事件，则x轴的源就是鼠标。 + +**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputDevice + + | 名称 | 参数类型 | 说明 | +| -------- | -------- | -------- | +| keyboard | string | 表示输入设备是键盘。 | +| touchscreen | string | 表示输入设备是触摸屏。 | +| mouse | string | 表示输入设备是鼠标。 | +| trackball | string | 表示输入设备是轨迹球。 | +| touchpad | string | 表示输入设备是触摸板。 | +| joystick | string | 表示输入设备是操纵杆。 | -- GitLab