一分钟集成 SDK

本文主要介绍如何集成 BRTC HarmonyOS SDK到您的项目中。

环境要求

• DevEco Studio 最新版本

前提条件

• 已注册开通了 BRTC 服务
• 已经拥有华为开发者账号（没有的话请先注册）
• 一部已经更新为 HarmonyOS NEXT 版本的真机 （BRTC HarmonyOS SDK 不提供模拟器版本）

集成步骤

一、获取 SDK

BRTC HarmonyOS SDK 通过 har 文件提供给开发者集成使用。您可以在 BRTC 的开发者文档中心的下载页面获取，也可以在 BRTC HarmonyOS Demo App 源码工程中找到。

二、导入 SDK

2.1 引入 SDK 包
如果您尚未创建 HarmonyOS 应用程序项目，请先创建一个应用程序项目。然后将下载到的 brtcohossdk.har 放到工程 entry/libs 目录下（如果没有libs目录，请手动创建一个）

打开 entry/oh-package.json5 文件，添加 SDK 依赖：

"dependencies": {
    "@ohos/brtcohossdk": "file:./libs/brtcohossdk.har"
}

2.2 添加权限申请
音视频应用必需要求您的应用具备麦克风、摄像头、网络、蓝牙等权限。请参考 Demo App 源码在您的应用中添加相应的权限。通常位于entry/src/main目录下的module.json5文件。

另外，我们也强烈建议您动态申请敏感权限，例如在 Demo App 的 entry/src/main/ets/entryability/EntryAbility.ets中，您可以找到动态申请权限的示例代码。

2.3 添加后台保活任务
在 HarmonyOS 上，应用必需添加后台保活任务，否则在应用退到后台后，音视频功能将无法继续工作。例如声音无法播放、屏幕共享会自动停止等。因此，请参考 Demo App 的源码，为您的应用添加后台保活任务。请在 Demo 源码中找到 entry/src/main/ets/common/BackgroundUtil.ets，并参考示例使用方法，拷贝移植到您的应用中。

三、导入相关模块并编码

推荐您参考 BRTC HarmonyOS Demo App 导入必要的模块，利用 BrtcEngine 提供的接口完成业务逻辑。下方是一些示例说明：

导入模块

import BrtcEngine, {
  BrtcRoomParams,
  BrtcVideoStreamType,
  BrtcVideoEncParam,
  BrtcVideoResolutionMode,
  BrtcEngineAdvancedConfig } from '@ohos/brtcohossdk/Index'

创建实例

BrtcEngine.createEngine(this.engineConfig).then((engineInstance) => {
    this.brtcEngine = engineInstance;
}).catch((err: BusinessError) => {
})

监听回调

this.brtcEngine.on('回调方法名', (参数) => {})

进入房间

let roomParams = new BrtcRoomParams();
roomParams.appId = this.keyCenter.getAppId();
roomParams.roomId = this.roomId;
roomParams.userId = this.userId;
roomParams.userSig = sig;
this.brtcEngine.enterRoom(roomParams);

开启视频预览

this.brtcEngine?.startLocalPreview(true or false);

显示远端用户的视频

this.brtcEngine?.startRemoteView(userId, streamType);

销毁实例

BrtcEngine.destroyEngine();

更多的功能需要您的探索，可以结合 demo 程序以及官网开发者中心的 API 接口文档来进行编码。