@ohos.multimodalInput.inputDeviceCooperate (键鼠穿越)

键鼠穿越功能模块，提供两台或多台设备组网协同后键鼠共享能力，实现键鼠输入设备的跨设备协同操作。

说明

• 从API Version 10开始，该接口不再维护，推荐使用新接口@ohos.cooperate (键鼠穿越)。

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

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

导入模块

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'

inputDeviceCooperate.enable

enable(enable: boolean, callback: AsyncCallback<void>): void

开启、关闭键鼠穿越，使用AsyncCallback异步方式返回结果。

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

参数：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

try {
  inputDeviceCooperate.enable(true, (error: BusinessError) => {
    if (error) {
      console.log(`Keyboard mouse crossing enable failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Keyboard mouse crossing enable success.`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing enable failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.enable

enable(enable: boolean): Promise<void>

开启、关闭键鼠穿越，使用Promise异步方式返回结果。

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

参数：

返回值：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

try {
  inputDeviceCooperate.enable(true).then(() => {
    console.log(`Keyboard mouse crossing enable success.`);
  }, (error: BusinessError) => {
    console.log(`Keyboard mouse crossing enable failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Keyboard mouse crossing enable failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.start

start(sinkDeviceDescriptor: string, srcInputDeviceId: number, callback: AsyncCallback<void>): void

启动键鼠穿越，使用AsyncCallback异步方式返回结果。

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

参数：

错误码：

以下错误码的详细介绍请参见ohos.multimodalinput错误码。

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

let sinkDeviceDescriptor = "descriptor";
let srcInputDeviceId = 0;
try {
  inputDeviceCooperate.start(sinkDeviceDescriptor, srcInputDeviceId, (error: BusinessError) => {
    if (error) {
      console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Start Keyboard mouse crossing success.`);
  });
} catch (error) {
  console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.start

start(sinkDeviceDescriptor: string, srcInputDeviceId: number): Promise<void>

启动键鼠穿越，使用Promise异步方式返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.multimodalinput错误码。

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

let sinkDeviceDescriptor = "descriptor";
let srcInputDeviceId = 0;
try {
  inputDeviceCooperate.start(sinkDeviceDescriptor, srcInputDeviceId).then(() => {
    console.log(`Start Keyboard mouse crossing success.`);
  }, (error: BusinessError) => {
    console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Start Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.stop

stop(callback: AsyncCallback<void>): void

停止键鼠穿越，使用AsyncCallback异步方式返回结果。

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

参数：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

try {
  inputDeviceCooperate.stop((error: BusinessError) => {
    if (error) {
      console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Stop Keyboard mouse crossing success.`);
  });
} catch (error) {
  console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.stop

stop(): Promise<void>

停止键鼠穿越，使用Promise异步方式返回结果。

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

返回值：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

try {
  inputDeviceCooperate.stop().then(() => {
    console.log(`Stop Keyboard mouse crossing success.`);
  }, (error: BusinessError) => {
    console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Stop Keyboard mouse crossing failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.getState

getState(deviceDescriptor: string, callback: AsyncCallback<{ state: boolean }>): void

获取键鼠穿越开关的状态，使用AsyncCallback异步方式返回结果。

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

参数：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

let deviceDescriptor = "descriptor";
try {
  inputDeviceCooperate.getState(deviceDescriptor, (error: BusinessError, data: boolean) => {
    if (error) {
      console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Get the status success, data: ${JSON.stringify(data)}`);
  });
} catch (error) {
  console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

inputDeviceCooperate.getState

getState(deviceDescriptor: string): Promise<{ state: boolean }>

获取键鼠穿越开关的状态，使用Promise异步方式返回结果。

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

参数：

返回值：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'
import { BusinessError } from '@ohos.base'

let deviceDescriptor = "descriptor";
try {
  inputDeviceCooperate.getState(deviceDescriptor).then((data: boolean) => {
    console.log(`Get the status success, data: ${JSON.stringify(data)}`);
  }, (error: BusinessError) => {
    console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  });
} catch (error) {
  console.log(`Get the status failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

on('cooperation')

on(type: 'cooperation', callback: AsyncCallback<{ deviceDescriptor: string, eventMsg: EventMsg }>): void

注册监听键鼠穿越状态。

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

参数：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'

function callback(deviceDescriptor: string, eventMsg: inputDeviceCooperate.EventMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(deviceDescriptor)}`);
  return false;
}
try {
  inputDeviceCooperate.on('cooperation', callback);
} catch (error) {
  console.log(`Register failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

off('cooperation')

off(type: 'cooperation', callback?: AsyncCallback<void>): void

关闭监听键鼠穿越状态。

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

参数：

示例：

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'

// 取消注册单个回调函数
function callbackOn(deviceDescriptor: string, eventMsg: inputDeviceCooperate.EventMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(deviceDescriptor)}`);
  return false;
}
function callbackOff() {
  console.log(`Keyboard mouse crossing event`);
  return false;
}
try {
  inputDeviceCooperate.on('cooperation', callbackOn);
  inputDeviceCooperate.off("cooperation", callbackOff);
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

import inputDeviceCooperate from '@ohos.multimodalInput.inputDeviceCooperate'

// 取消注册所有回调函数
function callback(deviceDescriptor: string, eventMsg: inputDeviceCooperate.EventMsg) {
  console.log(`Keyboard mouse crossing event: ${JSON.stringify(deviceDescriptor)}`);
  return false;
}
try {
  inputDeviceCooperate.on('cooperation', callback);
  inputDeviceCooperate.off("cooperation");
} catch (error) {
  console.log(`Execute failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

EventMsg

键鼠穿越事件。

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