@ohos.distributedsched.abilityConnectionManager (应用多端协同管理)(系统接口)

abilityConnectionManager模块提供了应用协同接口管理能力。设备组网成功（需登录同账号、双端打开蓝牙）后，系统应用和三方应用可以跨设备拉起同应用的一个UIAbility，拉起并连接成功后可实现跨设备数据传输，包括字符串、ArrayBuffer字节流、图片、传输流。

说明：

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

本模块为系统接口。

导入模块

import { abilityConnectionManager } from '@kit.DistributedServiceKit';

abilityConnectionManager.on(‘collaborateEvent’)

on(type: ‘collaborateEvent’, sessionId: number, callback: Callback<CollaborateEventInfo>): void

注册collaborateEvent事件的回调监听。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  abilityConnectionManager.on("collaborateEvent", sessionId, (callbackInfo) => {
    hilog.info(0x0000, 'testTag', 'session collaborateEvent, eventType is', callbackInfo.eventType);
  });

abilityConnectionManager.on(‘receiveImage’)

on(type: ‘receiveImage’, sessionId: number, callback: Callback<EventCallbackInfo>): void

注册receiveImage事件的回调监听。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  abilityConnectionManager.on("receiveImage", sessionId, (callbackInfo) => {
    hilog.info(0x0000, 'testTag', 'session receiveImage, sessionId is', callbackInfo.sessionId);
  });

abilityConnectionManager.off(‘collaborateEvent’)

off(type: ‘collaborateEvent’, sessionId: number, callback?: Callback<CollaborateEventInfo>): void

取消collaborateEvent事件的回调监听。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  abilityConnectionManager.off("collaborateEvent", sessionId);

abilityConnectionManager.off(‘receiveImage’)

off(type: ‘receiveImage’, sessionId: number, callback?: Callback<EventCallbackInfo>): void

取消receiveImage事件的回调监听。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  abilityConnectionManager.off("receiveImage", sessionId);

abilityConnectionManager.sendImage

sendImage(sessionId: number, image: image.PixelMap, quality?: number): Promise<void>

应用连接成功并创建传输流后，设备A或设备B可向对端设备发送图片。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

返回值：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';
  import { photoAccessHelper } from '@kit.MediaLibraryKit';
  import { image } from '@kit.ImageKit';
  import { fileIo as fs } from '@kit.CoreFileKit';

  try {
    let photoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
    photoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
    photoSelectOptions.maxSelectNumber = 5;
    let photoPicker = new photoAccessHelper.PhotoViewPicker();
    photoPicker.select(photoSelectOptions).then((photoSelectResult) => {
      if (!photoSelectResult) {
        hilog.error(0x0000, 'testTag', 'photoSelectResult = null');
      return;
      }

      let file = fs.openSync(photoSelectResult.photoUris[0], fs.OpenMode.READ_ONLY);
      hilog.info(0x0000, 'testTag', 'file.fd:' + file.fd);

      let sessionId = 100;
      let imageSourceApi: image.ImageSource = image.createImageSource(file.fd);
      if (imageSourceApi) {
        imageSourceApi.createPixelMap().then((pixelMap) => {
          abilityConnectionManager.sendImage(sessionId, pixelMap)
        });
      } else {
        hilog.info(0x0000, 'testTag', 'imageSourceApi is undefined');
      }
    })
  } catch (error) {
    hilog.error(0x0000, 'testTag', 'photoPicker failed with error: ' + JSON.stringify(error));
  }

abilityConnectionManager.createStream

createStream(sessionId: number, param: StreamParam): Promise<number>

应用连接成功后，设备A或设备B可创建传输流，发送图片和视频流。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

返回值：

错误码：

以下错误码详细介绍请参考通用错误码和分布式设备管理错误码。

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  hilog.info(0x0000, 'testTag', 'startStream');
  let sessionId = 100;
  abilityConnectionManager.createStream(sessionId ,{name: 'receive', role: 0}).then(async (streamId) => {
    let surfaceParam: abilityConnectionManager.SurfaceParam = {
      width: 640,
      height: 480,
      format: 1
    }
    let surfaceId = abilityConnectionManager.getSurfaceId(streamId, surfaceParam);
    hilog.info(0x0000, 'testTag', 'surfaceId is'+surfaceId);
    AppStorage.setOrCreate<string>('surfaceId', surfaceId);
    abilityConnectionManager.startStream(streamId);
  })

abilityConnectionManager.setSurfaceId

setSurfaceId(sessionId: number, surfaceId: string, param: SurfaceParam): void

设置传输流与Surface的绑定关系。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  hilog.info(0x0000, 'testTag', 'setSurfaceId');
  let sessionId = 100;
  abilityConnectionManager.createStream(sessionId ,{name: 'receive', role: 0}).then(async (streamId) => {
    let surfaceParam: abilityConnectionManager.SurfaceParam = {
      width: 640,
      height: 480,
      format: 1
    }
    let surfaceId = abilityConnectionManager.getSurfaceId(streamId, surfaceParam);
    abilityConnectionManager.setSurfaceId(streamId, surfaceId, surfaceParam);
  })

abilityConnectionManager.getSurfaceId

getSurfaceId(sessionId: number, param: SurfaceParam): string

获取指定传输流绑定的Surface的唯一标识符。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

返回值：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  hilog.info(0x0000, 'testTag', 'getSurfaceId');
  let sessionId = 100;
  abilityConnectionManager.createStream(sessionId ,{name: 'receive', role: 0}).then(async (streamId) => {
    let surfaceParam: abilityConnectionManager.SurfaceParam = {
      width: 640,
      height: 480,
      format: 1
    }
    let surfaceId = abilityConnectionManager.getSurfaceId(streamId, surfaceParam);
  })

abilityConnectionManager.updateSurfaceParam

updateSurfaceParam(sessionId: number, param: SurfaceParam): void

更新与传输流绑定的Surface的配置信息。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  hilog.info(0x0000, 'testTag', 'updateSurfaceParam');
  let sessionId = 100;
  abilityConnectionManager.createStream(sessionId ,{name: 'receive', role: 0}).then(async (streamId) => {
    let surfaceParam: abilityConnectionManager.SurfaceParam = {
      width: 640,
      height: 480,
      format: 1
    }
    abilityConnectionManager.updateSurfaceParam(streamId, surfaceParam);
  })

abilityConnectionManager.destroyStream

destroyStream(sessionId: number): void

发送图片和视频流等业务结束后，创建传输流的应用应及时销毁传输流，否则会增加系统功耗。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  hilog.info(0x0000, 'testTag', 'destroyStream called');
  abilityConnectionManager.destroyStream(sessionId)

abilityConnectionManager.startStream

startStream(sessionId: number): void

启动指定传输流。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

以下错误码详细介绍请参考通用错误码和分布式设备管理错误码。

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  hilog.info(0x0000, 'testTag', 'startStream called');
  abilityConnectionManager.startStream(sessionId)

abilityConnectionManager.stopStream

stopStream(sessionId: number): void

停止指定传输流。

系统能力：SystemCapability.DistributedSched.AppCollaboration

系统API：此接口为系统接口。

参数：

错误码：

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

示例：

  import { abilityConnectionManager } from '@kit.DistributedServiceKit';
  import { hilog } from '@kit.PerformanceAnalysisKit';

  let sessionId = 100;
  hilog.info(0x0000, 'testTag', 'stopStream called');
  abilityConnectionManager.stopStream(sessionId)

CollaborateEventInfo

协作事件信息。

系统能力：SystemCapability.DistributedSched.AppCollaboration

StreamParam

流传输配置的参数。

系统能力：SystemCapability.DistributedSched.AppCollaboration

SurfaceParam

Surface配置参数。

系统能力：SystemCapability.DistributedSched.AppCollaboration

CollaborateEventType

协作事件的类型的枚举。

系统能力：SystemCapability.DistributedSched.AppCollaboration

FlipOptions

翻转选项的枚举。

系统能力：SystemCapability.DistributedSched.AppCollaboration

StreamRole

流传输的方式。

系统能力：SystemCapability.DistributedSched.AppCollaboration

VideoPixelFormat

视频像素格式的枚举。

系统能力：SystemCapability.DistributedSched.AppCollaboration

ConnectOptions

应用连接时所需的连接选项。

系统能力：SystemCapability.DistributedSched.AppCollaboration

EventCallbackInfo

回调方法的接收信息。

系统能力：SystemCapability.DistributedSched.AppCollaboration

StartOptionParams

启动选项参数的枚举。

系统能力：SystemCapability.DistributedSched.AppCollaboration

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Distributed Service Kit（分布式管理服务）

harmony 鸿蒙DeviceManager

harmony 鸿蒙oh_device_manager_err_code.h

harmony 鸿蒙oh_device_manager.h

harmony 鸿蒙设备管理错误码

harmony 鸿蒙键鼠穿越管理错误码

harmony 鸿蒙增强连接错误码

harmony 鸿蒙@ohos.distributedHardware.deviceManager (设备管理)(系统接口)

harmony 鸿蒙@ohos.cooperate (键鼠穿越)（系统接口）

harmony 鸿蒙@ohos.distributedsched.abilityConnectionManager (应用多端协同管理)