Skip to content

按键映射

模块作用:读取和写入鼠标按键映射。调用入口为 client.keyRemapping

读取当前按键映射

client.keyRemapping.queryButtons()

简要描述: 读取当前按键映射。


参数

此方法不需要参数。


返回值

  • 总体类型: Promise<KeyRemappingResult>

返回字段:

字段类型说明
leftKeynumber左键映射 keycode。
rightKeynumber右键映射 keycode。
middleKeynumber中键映射 keycode。
forwardKeynumber前进键映射 keycode。
backKeynumber后退键映射 keycode。
scrollForwardnumber滚轮前向映射 keycode。
scrollBackwardnumber滚轮后向映射 keycode。
diyKeynumber自定义键映射 keycode。

使用示例

调用方式:

ts
const buttons = await client.keyRemapping.queryButtons();

调用示例:

ts
const buttons = await client.keyRemapping.queryButtons();
console.log(buttons.leftKey, buttons.rightKey);

写入鼠标按键映射

client.keyRemapping.setButtons(param)

简要描述: 写入鼠标按键映射。


参数

参数类型是否必需说明
param.leftKeynumber左键映射 keycode。
param.rightKeynumber右键映射 keycode。
param.middleKeynumber中键映射 keycode。
param.forwardKeynumber前进键映射 keycode。
param.backKeynumber后退键映射 keycode。
param.scrollForwardnumber滚轮前向映射 keycode。
param.scrollBackwardnumber滚轮后向映射 keycode。
param.diyKeynumber自定义键映射 keycode。

返回值

  • 总体类型: Promise<KeyRemappingResult>
  • 描述: 返回设备确认后的按键映射。

使用示例

调用方式:

ts
const result = await client.keyRemapping.setButtons(param);

调用示例:

ts
const buttons = await client.keyRemapping.queryButtons();

const result = await client.keyRemapping.setButtons({
  ...buttons,
  middleKey: 0x0004,
});