SDK概述_会议_客户端SDK参考_华为云

(1)

22 客户端 SDK 参考

文档版本 70.14.5 发布日期 2022-02-19

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

华为技术有限公司

地址：深圳市龙岗区坂田华为总部办公楼邮编：518129

网址：

https://www.huawei.com

客户服务邮箱：

[email protected]

客户服务电话：4008302118

(3)

1 ^{SDK 概述}

华为云会议服务为开发者提供Windows、Android、iOS、Mac的客户端SDK，方便开发者将华为云会议的音频会议、视频会议、桌面共享能力快速集成到自己的应用中。

华为云会议的客户端SDK已经实现了会议中UI界面，包括会场画面显示，会议控制功能，桌面共享等，开发者只需要调用少量接口即可完成华为云会议能力的集成。客户端SDK已经提供的主要UI如下（以Windows SDK为例，其他平台的SDK能力相同，只是界面布局有差异。）。

1. 会议中的主界面

图1-1 会中主界面

2. 桌面共享界面

(16)

图1-2 桌面共享界面

3. 会议来电界面

图1-3 会议来电界面

说明

● 来电通知界面只有在应用进程没有被系统杀掉的情况下才能收到来电通知，移动端SDK并不提供VoIP Push能力。

(17)

2 ^{Demo 体验}

2.1 Demo安装包下载 2.2 Demo一览

2.1 Demo 安装包下载

1. Android Demo安装包下载

图2-1 Android Demo 安装包下载二维码

(18)

说明

使用手机浏览器扫一扫下载 2.Windows Demo安装包下载

图2-2 Windows Demo 安装包下载链接

32位MFC Demo下载链接：hmwsdk-win-demo-win32.zip 64位MFC Demo下载链接：hmwsdk-win-demo-x64.zip

32位Electron Demo下载：hwmsdk-electron-demo-ia32-pkg.zip 64位Electron Demo下载：hwmsdk-electron-demo-X64-pkg.zip 3.Mac Demo安装包下载

图2-3 Mac Demo 安装包下载链接

(19)

原生Demo下载链接：hwmsdk-mac-demo.dmg

Electron Demo下载链接：hwm-electron-mac-demo.dmg

2.2 Demo 一览

1. Android Demo

图2-4 Android Demo

(20)

2. iOS Demo

图2-5 iOS Demo

3. Windows MFC Demo

图2-6 Windows MFC Demo

4. Windows Electron Demo

(21)

图2-7 Windows Electron Demo

5. Mac Native Demo

图2-8 Mac Native Demo

6. Mac Electron Demo

(22)

图2-9 Mac Electron Demo

(23)

3 ^{SDK 下载}

说明

华为云会议的UI SDK提供一年的维护周期，如果超过一年的版本使用中有问题，请升级到最新版本。

表3-1 Android/iOS/Windows/Mac UI SDK 资源下载路径

版本发布日期资源下载链接安装包增

量

说明

70.14.5 (最新)

2022-02-

16 Android UI

SDK

hwmsdk-

android-70.14.5.zi p

32位:27.5M 64位:27.9M 32位+64 位: 45.8M iOS UI

SDK

hwmsdk-

ios-70.14.5.zip

33.7M Windows

UI SDK

hwmsdk-

win-70.14.5.zip

约60.7M Windows

Electron Demo

hwm-electron- demo-

src-70.14.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.14.5.zip

47.5M MacElectron

Demo

hwmsdk-electron-

mac-70.14.5.zip

-

(24)

70.13.5

（维护）

2022-01-

18 Android UI

SDK

hwmsdk-

Windows Electron Demo

hwm-electron- demo-

src-70.13.5.zip

- △下载

前必看，

【重要说明】

“登录”和

“退出登录”

的回调函数新增了参数 Mac UI

SDK

hwmsdk-

mac-70.13.5.zip

【重要说明】

“登录”和

“退出登录”

的回调函数新增了参数由于App Store限制，本地录制默认路径变更，接入方App需要申请下载文件夹权限

(26)

MacElectron Demo

hwmsdk-electron-

mac-70.13.5.zip

- △下载前必看，

【重要说明】

“登录”和

“退出登录”

的回调函数新增了参数由于App Store限制，本地录制默认路径变更，接入方App需要申请下载文件夹权限 70.12.6

（维护）

2021-12-

23 Android UI

SDK

hwmsdk-

android-70.12.6.zi p

32位:28.1M 64位:28.3M 32位+64 位: 47.3M iOS UI

SDK

hwmsdk-

ios-70.12.6.zip

33.7M Windows

UI SDK

hwmsdk-

win-70.12.6.zip

约59.3M Windows

Electron Demo

hwm-electron- demo-

src-70.12.6.zip

-

Mac UI

SDK

hwmsdk-

mac-70.12.6.zip

46.8M MacElectron

Demo

hwmsdk-electron-

mac-70.12.6.zip

-

(27)

70.12.4

（维护）

2021-12-

14 Android UI

SDK

hwmsdk-

android-70.12.4.zi p

32位:28.1M 64位:28.3M 32位+64 位: 47.3M iOS UI

SDK

hwmsdk-

ios-70.12.4.zip

33.7M Windows

UI SDK

hwmsdk-

win-70.12.4.zip

约59.3M Windows

Electron Demo

hwm-electron- demo-

src-70.12.4.zip

-

Mac UI

SDK

hwmsdk-

mac-70.12.4.zip

46.8M MacElectron

Demo

hwmsdk-electron- mac-70.12.4.zip

-

70.11.5

（维护）

2021-11-

26 Android UI

SDK

hwmsdk-

android-70.11.5.zi p

32位:28.1M 64位:28.3M 32位+64 位: 47.3M iOS UI

SDK

hwmsdk-

ios-70.11.5.zip

【重要说明】

△HWRTC Engine.

framew ork更名为HWMM REngin e.frame work(

只修改包名，

集成方式不变)

Windows

UI SDK

hwmsdk-

win-70.11.5.zip

约60M

(28)

hwm-electron- demo-

src-70.11.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.11.5.zip

46.7M MacElectron

Demo

hwmsdk-electron- mac-70.11.5.zip

-

70.10.5

（维护）

2021-10-

22 Android UI

SDK

hwmsdk-

android-70.10.5.zi p

32位:28.4M 64位:28.6M 32位+64 位: 47.5M iOS UI

SDK

hwmsdk-

ios-70.10.5.zip

34.4M Windows

UI SDK

hwmsdk-

win-70.10.5.zip

约60M Windows

Electron Demo

hwm-electron- demo-

src-70.10.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.10.5.zip

49.6M MacElectron

Demo

hwmsdk-electron- mac-70.10.5.zip

-

70.9.5

（维护）

2021-9-1

5 Android UI

SDK

hwmsdk-

android-70.9.5.zip

32位:

28.3M 64位:28.4M 32位+64 位: 47.3M iOS UI

SDK

hwmsdk-

ios-70.9.5.zip

35.8M Windows

UI SDK

hwmsdk-

win-70.9.5.zip

约60M Windows

Electron Demo

hwm-electron- demo-

src-70.9.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.9.5.zip

49.8M

(29)

MacElectron Demo

hwmsdk-electron- mac-70.9.5.zip

-

70.8.6

（维护）

2021-8-2

8 Android UI

SDK

hwmsdk-

android-70.8.6.zip

32位:

27.9M 64位:28.1M 32位+64 位: 46.7M iOS UI

SDK

hwmsdk-

ios-70.8.6.zip

35.2M Windows

UI SDK

hwmsdk-

win-70.8.6.zip

约60M Windows

Electron Demo

hwm-electron- demo-

src-70.8.6.zip

-

Mac UI

SDK

hwmsdk-

mac-70.8.6.zip

约45M MacElectron

Demo

hwmsdk-electron- mac-70.8.6.zip

-

70.8.5

（维护）

2021-08-

hwmsdk-

mac-70.8.5.zip

约45M MacElectron

Demo

hwmsdk-electron- mac-70.8.5.zip

70.7.5

（维护）

2021-07-

16 Android UI

SDK

hwmsdk-

android-70.7.5.zip

32位:

28.1M 64位:28.3M 32位+64 位: 46.9M iOS UI

SDK

hwmsdk-

ios-70.7.5.zip

34.5M Windows

UI SDK

hwmsdk-

win-70.7.5.zip

约66M Windows

Electron Demo

hwm-electron- demo-

src-70.7.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.7.5.zip

约47M MacElectron

Demo

hwmsdk-electron- mac-70.7.5.zip

-

70.6.5

（维护）

2021-06-

21 Android UI

SDK

hwmsdk-

android-70.6.5.zip

32位:

28.3M 64位:28.5M 32位+64 位: 47.1M iOS UI

SDK

hwmsdk-

ios-70.6.5.zip

34.5M Windows

UI SDK

hwmsdk-

-

Mac UI

SDK

hwmsdk-

mac-70.5.8.zip

约56M △下载前必看，

【重要说明】

MacElectron Demo

hwmsdk-electron- mac-70.5.8.zip

-

70.4.5

（维护）

2021-04-

15 Android UI

SDK

hwmsdk-

android-70.4.5.zip

32位:

26.8M 64位:26.9M 32位+64 位: 45.2M iOS UI

SDK

hwmsdk-

ios-70.4.5.zip

33.1M Windows

UI SDK

hwmsdk-

win-70.4.5.zip

约46M Windows

Electron Demo

hwm-electron- demo-

src-70.4.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.4.5.zip

约49M △下载前必看，

【重要说明】

MacElectron Demo

hwmsdk-electron-

mac-70.4.5.zip

-

(32)

70.3.5

（维护）

2021-03-

12 Android UI

SDK

hwmsdk-

android-70.3.5.zip

32位：

33M 64位：34.3M 32位 &

64位：58.6M

iOS UI

SDK

hwmsdk-

ios-70.3.5.zip

33.1M Windows

UI SDK

hwmsdk-

win-70.3.5.zip

约46M Windows

Electron Demo

hwm-electron- demo-

src-70.3.5.zip

-

Mac UI

SDK

hwmsdk-

mac-70.3.5.zip

约47M MacElectron

Demo

hwmsdk-electron- mac-70.3.5.zip

-

60.15.6

（停止维护）

约46M Windows

Electron Demo

hwm-electron- demo-

src-60.15.5.zip

-

Mac UI

SDK

hwmsdk-

mac-60.15.5.zip

约43M MacElectron

Demo

hwmsdk-electron-

mac-60.15.5.zip

-

(33)

60.13.2

（停止维护）

【重要说明】

hwm-electron- demo-

src-60.13.2.zip

-

Mac UI

SDK

hwmsdk-

mac-60.13.2.zip

- MacElectron

Demo

hwmsdk-electron- mac-60.13.2.zip

-

60.12.5

（停止维护）

- Windows

Electron Demo

hwm-electron- demo-

src-60.12.5.zip

-

Mac UI

SDK

hwmsdk-

mac-60.12.5.zip

- MacElectron

Demo

hwmsdk-electron- mac-60.12.5.zip

-

60.11.6

（停止维护）

2020-11-

06 Android UI

SDK

hwmsdk-

android-60.11.6.zi

4 一分钟跑通 Demo

4.1 跑通Android Demo 4.2 跑通iOS Demo

4.3 跑通Windows MFC Demo 4.4 跑通Windows Electron Demo 4.5 跑通Mac Native Demo 4.6 跑通Mac Electron Demo

4.1 跑通 Android Demo

本小节描述如何快速编译并运行客户端SDK的Android Demo。

环境要求

在Android Demo的编译运行过程中请满足如下环境要求。

表4-1 环境要求（强制要求）

名称要求

JDK版本 >= 1.8.0

最小Android API 版本 API 21

CPU架构支持 ARM64、ARMV7

集成工具 Android Studio 3.3.2

测试资源及App ID申请请参见“开发前准备”。

(37)

表4-2 编译配置要求（非强制要求）

名称要求

jdk配置 sourceCompatibility

JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 gradle version gradle-5.4.1-all

compileSdkVersion 30 targetSdkVersion 30

gradle plugin version com.android.tools.build:gradle:3.5.2 buildToolsVersion 28.0.3

操作步骤

步骤1 下载SDK和Demo源码

● 参考“SDK下载”章节，下载SDK的ZIP包。

● 解压ZIP包到DEMO文件夹下，得到如图1所示的文件及目录

● Demo示例工程的目录结构如图2所示

图4-1 SDK ZIP 包解压后的目录结构

步骤2 拷贝SDK aar文件

● 拷贝SDK aar资源目录下的所有aar资源到Demo工程的libs文件夹中，如图2所示

(38)

图4-2 Demo 示例工程的目录结构

步骤3 编辑和运行

● 打开Android Studio

● 打开Demo示例工程，如图3所示

● 打开后如图4所示

图4-3 工程目录

(39)

图4-4 工程目录

● 打开gradle-wrapper.properties，确认是否可以下载到gradle，如果不可以则可以手动到该网址下载，配置成本地依赖

图4-5 配置 gradle-wrapper.properties

图4-6 配置本地 gradle

● 打开build.gradle,查看是否可以连接到google,如果不可以则注释掉其他，并且添加自己可用的maven仓

(40)

图4-7 配置 maven

● 编译并运行demo工程步骤4 使用demo

● 登录

(41)

图4-8 Android Demo 登录前后界面

● 创建会议

(42)

图4-9 Android Demo 创建会议界面

● 会中界面

(43)

图4-10 Android Demo 会中界面

----结束

4.2 跑通 iOS Demo

本小节描述如何快速编译并运行客户端SDK的iOS Demo。

环境要求

在iOS Demo的编译运行过程中请满足如下环境要求。

表4-3 环境要求

环境和工具名称版本要求说明

操作系统 Mac OSX High Sierra

10.14.4及以上 Xcode对Mac系统要求，

推荐版本10.15以上

Xcode Xcode11及以上 Demo及文档以

Xcode11.3.1为例

(44)

环境和工具名称版本要求说明 iOS系统版本 iOS10.0及以上，64位设

备屏幕共享功能需iOS12及

以上

测试资源及App ID申请 - 请参见“开发前准备”。

表4-4 项目配置要求

名称要求说明

Enable Bitcode NO 不支持编译代码优化

Valid Architectures arm64 支持CPU架构 Other Link Flags -ObjC 把静态库中所有的

Objective-C类和分类都加载到最后的可执行文件中

表4-5 第三方开源库

开源库名称建议版本

Masonry 必须使用1.1.0及以上 SSZipArchive 2.1.3

YYModel 1.0.4 CocoaLumberjack 3.4.1

libyuv 1.0.2

操作步骤

1. 按照“SDK下载”章节，下载SDK的ZIP包。

2. 解压ZIP包，得到如下文件及目录。

图4-11 SDK 包的目录结构

步骤2 添加依赖库

1. 把HWMUISDK.framework、HWMMREngine.framework拷贝到Demo中。在

“TARGETS->HWMSDKDemo->General->Frameworks、Libraries、and Embedded Content” 中修改为Embed & Sign。

(45)

2. 把HWMExtension.framework拷贝到ScreenShareExtension中,“TARGETS—

>ScreenShareExtension—>Build Settings->Other Linker Flags” 中添加-lc++。

3. 把导入的HWMUISDK.framework设置为Embed & Sign。

图4-12 HWMUISDK.framework 设置

图4-13 HWMExtension.framework 设置

4. 下载masonry，拷贝源码到工程中。

步骤3 工程配置

1. 修改bundle identifier、App Groups，安装对应的证书。创建和管理证书地址参见“证书地址”。

2. 编译运行。

步骤4 使用Demo

以创建1个即时会议为例：

1. 点击“初始化”按钮，初始化SDK。

(46)

图4-14 iOS Demo 首界面

2. 点击“登录”按钮进入“登录页面”，在“登录页面”输入帐号密码后点击“登录”。

(47)

图4-15 iOS Demo 登录界面

3. 点击“创建会议”按钮，进入创建会议界面，创建会议。

(48)

图4-16 iOS Demo 创建会议界面

(49)

图4-17 iOS Demo 会中界面

----结束

4.3 跑通 Windows MFC Demo

本小节描述如何快速编译并运行客户端SDK的Windows MFC Demo。

环境要求

在Windows MFC Demo的编译运行过程中请满足如下环境要求。

表4-6 环境要求

操作系统 Windows 10专业版硬件要求：

● CPU：i5-2400四核 3.1GHz及以上。

● 内存：4GB及以上。

(50)

环境和工具名称版本要求说明 Microsoft Visual Studio Visual Studio 2017 NA

测试资源及App ID申请 NA 请参见“开发前准备”。

操作步骤

步骤2 拷贝依赖文件

1. 运行bat目录下的批处理脚本。以编译32位Release版本为例，执行 copy_dependency_win32_release.bat脚本，脚本将：

● SDK的头文件和lib文件拷贝到SDK目录下。

● SDK的dll文件和资源文件拷贝到out目录下。

步骤3 编译和运行

1. 双击demo目录下的demo.sln VS工程文件。

2. 在VS中选择32位Release版本。

(51)

图4-19 选择 32 位 Release 版本

3. 编译并运行demo工程

图4-20 Windows Demo 登录前界面

步骤4 使用Demo

假设环境中的网络没有Proxy，PC可以直接访问公网。以创建一个即时会议为例：

1. 点击“Init”按钮。

2. 点击“Login”按钮，并输入华为云会议帐号和密码。

(52)

图4-21 Windows Demo 登录后界面

3. 点击“Create Conf”按钮，创建会议。

图4-22 会中界面

----结束

4.4 跑通 Windows Electron Demo

本小节描述如何快速编译并运行客户端SDK的Windows Electron Demo。

环境要求

在Windows Electron Demo的运行过程中请满足如下环境要求。

(53)

表4-7 环境要求

操作系统 Windows 10专业版硬件要求：

● CPU：i5-2400四核 3.1GHz及以上。

● 内存：4GB及以上。

Electron 10.1.3及以上 NA

Microsoft Visual Studio Visual Studio 2017 可选，仅在需要重新编译 Demo中的C++代码时才需要

操作步骤

1. 按照“SDK下载”章节，下载Electron Demo的ZIP包（如“hwm-electron-

demo-src-70.7.5.zip”）。

2. 解压Electron Demo ZIP包，得到如下文件及目录。

图4-23 Electron Demo ZIP 包的目录结构

(54)

说明

– “C++代码目录”下的是接口转换通道的C++源代码。源代码编译后的生成了32位和64 位动态库文件“JsAdapter.dll”分别是“UISDKJsAdapter\build-2017\Win32\Release

\JsAdapter.dll”和“UISDKJsAdapter\build-2017\x64\Release\JsAdapter.dll”。

Demo中直接使用了这个动态库文件。

– hwm-electron-demo\src\AppService\是接口转换通道的JavaScript代码。当前已经提供的接口请参考“表7-156”。如果这部分接口能满足第三方应用的要求，您可以直接使用。如果Windows SDK已经提了接口，但是AppService中没有这部分接口，您可以参考“7.8.3 增加新接口指导(可选)”自己增加新的接口，并重新编译

UISDKJsAdapter。

步骤2 拷贝Windows SDK文件

注意

1. 如果已经安装node，请先确定自己node版本是32位还是64位，可以执行cmd/shell 命令查看node版本的位数，结果：x64为64位， ia32为32位。

$ node -p "process.arch"

2. 如果没有安装node，可到nodejs官网下载对应版本。

● 如果node版本是32位，执行步骤1中解压目录下的copy_win32_depend_dll.bat

● 如果node版本是64位，执行步骤1中解压目录下的copy_x64_depend_dll.bat bat脚本会将对应位数的JsAdapter.dll文件、hwm_sdk_agent.dll文件、HwmSdk.exe文件（x64独有）、HwmSdk文件夹内的dll文件和资源文件拷贝到“hwm-electron- demo\resources\HwmSdk\”目录下

图4-24 执行脚本拷贝 dll 文件

步骤3 环境准备

1. 如确认node已经安装，请先配置npm镜像

安装依赖前先配置npm镜像，以提高安装速度，执行以下命令：

npm config set registry http://registry.npm.taobao.org/

npm config set electron_mirror https://npm.taobao.org/mirrors/electron/

2. 因为安装 ffi-napi 依赖的时候，需要有编译环境，否则会因为无法编译而报错。

● Python 2.7

● visual C++ Build Tools

● .net framework 4.5.1

(55)

如已安装了以上环境，则忽略以下流程，直接看步骤4 安装依赖。

3. 以管理员身份运行cmd，否则会提示权限不足执行 npm install –global windows-build-tools；

以上命令行会自动把python和c++开发工具包都集成进去。

python系统环境变量需要自行配置图4-25 安装 windows-build-tools

步骤4 安装依赖

1. 执行npm install -g node-gyp

2. 在"hwm-electron-demo\"下执行"npm install"。(安装项目依赖的 node_modules)

3. 在"hwm-electron-demo\"下执行"npm install -S ffi-napi"。（安装ffi-napi依赖时，会自动使用node-gyp进行编译）

4. 在"hwm-electron-demo\"下执行"npm install -S ref-napi"。

5. 在"hwm-electron-demo\"下执行"npm install -S ref-array-napi ref-struct- napi"。

步骤5 启动react项目

1. 打开“hwm-electron-demo\main.js”

取消“win.loadURL('http://localhost:3000'”的注释，然后注释掉

“win.loadFile(path.join(__dirname, './index.html'))”

结果如下：

(56)

win.loadURL('http://localhost:3000')

// win.loadFile(path.join(__dirname, './build/index.html')) // win.loadFile(path.join(__dirname, './index.html'))

2. 在“hwm-electron-demo\”下执行"npm run start"。

图4-26 启动 react 项目

说明

浏览器中的“TypeError: Cannot read property 'remote' of undefined”错误提示不用管。

步骤6 启动Electron项目

另外启动一个命令行Shell，在“hwm-electron-demo\”执行“npm run auto”。

(57)

图4-27 Electron Demo 主界面

步骤7 使用Electron Demo

● 点击“Init”初始化SDK。（如果是32位，ExePath不用填）

(58)

图4-28 初始化 SDK

说明

ExePath是Windows SDK的HwmSdk所在的路径，以步骤2的示例为例路径则是：“D:\hwm- electron-demo-src-70.7.5\hwm-electron-demo\resources\app\resources\”。（千万不要少了最后的反斜杠\）

图4-29 登录

(59)

图4-30 创建会议

----结束

4.5 跑通 Mac Native Demo

本小节描述如何快速编译并运行客户端SDK的Mac Native Demo。

环境要求

在Mac Native Demo的编译运行过程中请满足如下环境要求。

表4-8 环境要求

操作系统 Mac OSX High Sierra

10.14.4及以上 Xcode对Mac系统要求，

推荐版本10.15以上

Xcode Xcode11及以上 Demo及文档以

xcode12.0.1为例

测试资源及App ID申请 - 请参见“开发前准备”。

操作步骤

(60)

步骤2 编辑和运行

1. 修改bundle identifier、安装对应的证书。换成自己公司的对应证书。

2. 修改Xcode Preferense的Build Location改成Custom

图4-32 Xcode Build location 修改

3. 编译运行。

步骤3 使用Demo

以创建1个即时会议为例：

1. 点击“初始化”按钮，初始化SDK。

(61)

图4-33 Mac Demo 首界面

2. 点击“登录”按钮进入“登录页面”，在“登录页面”输入帐号密码后点击“登录”。

图4-34 Mac Demo 登录界面

(62)

3. 点击“创建会议”按钮，进入创建会议界面，创建会议。

图4-35 Mac Demo 创建会议界面

图4-36 Mac Demo 会中界面

----结束

4.6 跑通 Mac Electron Demo

本小节描述如何快速编译并运行Mac端的HWMUISDK Electron Demo。

(63)

环境要求

在Mac HWMUISDK Electron Demo的运行过程中请满足如下环境要求。

表4-9 环境要求

操作系统 MacOS 10.15 NA

Electron 10.1.3以上 Demo以Electron10.1.5版本做示例

XCode 12.0及以上 NA

node-gyp 7.1.2 编译JavaScript桥接动态库

需要

bindings 1.5.0 编译JavaScript桥接动态库

需要

操作步骤

1. 按照“SDK下载”章节，下载Mac HWMUISDK Electron Demo的ZIP包（如

“HWMUISDKElectronDemo-60.10.5.zip”）。

2. 解压Windows SDK的ZIP包，包结构参考“图1 SDK包的目录结构”。

3. 解压Electron Demo ZIP包，得到如下文件及目录。

(64)

图4-37 HWMUISDKElectronDemo ZIP 包的目录结构

图4-38 HWMUISDKElectronDemo 脚本说明

步骤2 准备运行electron demo的环境

1. 安装electron10.1.5版本，运行npm install --save-dev [email protected] -g

npm install --save-dev [email protected] -g

2. 安装node-gyp

npm install node-gyp -g

(65)

3. 安装bindings

npm install bindings -g

步骤3 在“HWMUISDKElectronDemo”下执行“sh build_nodeaddon_mac.sh”。会自动安装项目依赖的node_modules，并编译生成动态库hwmsdk.node，并拷贝到demo/

public目录下。

说明

● 由于国内环境问题，运行build_nodeaddon_mac.sh可能卡在install.js，或者下载electron失败。可以通过修改~/.npmrc文件添加如下代码解决

registry=https://registry.npm.taobao.org

electron_mirror=https://npm.taobao.org/mirrors/electron/

● build_nodeaddon_mac.sh还会执行package.json的postinstall-mac脚本拷贝原生Mac framework到Electron App下的framework目录中，所以脚本执行完后请检查demo/

node_modules/electron/dist/Electron.app的framework目录下是否有 HWMUISDK.framework等Mac原生framework

步骤4 启动Demo

在“HWMUISDKElectronDemo”下执行"sh run_demo_mac.sh"。即可成功运行起 Mac Electron Demo。

步骤5 Electron Demo功能介绍

图4-39 Electron Demo 主界面

步骤6 使用Electron Demo

● 点击“Init”初始化SDK。在登录前启动监听相关通知

(66)

图4-40 初始化 SDK，并监听相关通知

图4-41 登录

(67)

图4-42 登录成功后进入二级页面

图4-43 点击"Create Conf"按钮进入创建即时会议界面

(68)

图4-44 点击“Submit”按钮，创建会议，成功即进入会中界面

----结束

(69)

5 Android SDK

5.1 概述 5.2 修订记录 5.3 快速入门 5.4 典型场景 5.5 接口参考 5.6 错误码参考 5.7 版本更新内容

5.1 概述

会议二次开发Android SDK 提供了一套完整的接口集合，开发者可以通过调用 HUAWEI CLOUD Meeting SDK（以下简称SDK）开放的API，快速集成音视频会议，

包括创建/预约/加入会议、进行屏幕共享、点对点呼叫等。

说明

● Android SDK只能运行在主流的手机和Pad上。如果运行在定制硬件的Android设备上，可能会导致画面分辨率低、画面旋转角度不正确、回声等问题。

● Android SDK不支持在华为智慧屏和华为企业智慧屏上做二次开发。

(70)

5.2 修订记录

表5-1 修订记录

日期版本修订内容

2022-2-19 70.14.5 1. 预约、编辑会议支持设置“来宾在主持人之前加入会议”，并可设置提前入会时间，具体参数请见预约会议参数说明。 2. 预约云会议室时支持选择预约固定云会议室ID或随机云会议室ID，具体请见

VmrIdType枚举说明。

3．APPID登录支持指定部门ID，具体请见

AppIdAuthParam参数说明。

4. 问题修复

具体使用请见70.14.5更新内容

2022-1-19 70.13.5 1. 登录、登出接口新增uuid、account、

thirdAccount字段，具体请见LoginResult

类型说明、LogoutResult类型说明。如果

是老版本升级到70.13.5版本,需要修改回调函数的定义。

2. 第三方视频推流接口支持MMR会议，具体请见第三方视频推流。

3. 业务消息通知中新增onConfIncoming接口，允许在入会前获取来电信息，具体请见业务消息通知。

4. 问题修复

具体使用请见70.13.5更新内容

2021-12-23 70.12.6 1. 修复弱网情况下导致清晰度降低后不能恢复的问题

具体使用请见70.12.6更新内容 2021-12-15 70.12.4 1. RxJava升级到3.0.13版本

2. 问题修复

具体使用请见70.12.4更新内容 2021-12-3 70.11.5 1. 新增配置日志保存天数

2. HMS Scankit升级到2.1.0.300版本 3. 问题修复

具体使用请见70.11.5 更新内容 2021-10-22 70.10.5 1. 去除无效资源

2. 问题修复

具体使用请见70.10.5 更新内容

(71)

2021-09-16 70.9.5 1.新增SSO登录方式 2.移除tinypinyin库

具体使用请见70.9.5 更新内容 2021-08-28 70.8.6 问题修复，体验更稳定

2021-08-18 70.8.5 1.从此版本开始，Android UI SDK切换为 AndroidX依赖

2.支持获取与会者列表（含网络研讨会）

2021-07-16 70.7.5 1.支持会中设置本会场视频画面是否镜像 2.支持安卓11的API 30版本

3.okhttp升级到4.9.1

具体使用请见70.7.5 更新内容 2021-06-10 70.6.5 1.删除了ZXing的依赖

2.tinypinyin 升级到3.0.0 3.aspectjrt升级到1.9.6 4.gson升级到2.8.6

2021-05-17 70.5.8 1.会中与会者和聊天模块适配横屏体验 2.支持聊天弹幕

具体使用请见70.5.8 更新内容 2021-04-15 70.4.5 1.预约会议接口添加返回值参数说明

2.sdk初始化约束，限制初始化必须在 Application的OnCreate主线程中执行 3.新增获取用户当前状态接口

4.会中新增主持人邀请他人共享，主持人也可快速取消共享

5.移动端的前后摄像头切换按钮放到主界面上

6.会议日志大小优化

7.libs文件夹中aar文件整合，使用时需先清空之前历史版本文件，重新导入具体使用请见70.4.5 更新内容

(72)

2021-03-12 70.3.5 1.移除会中自定义分享链接，自定义分享链接功能可以通过自定义会中分享面板实现

2.去掉短信权限的要求 3.错误码变更

4.观看共享时叠加发言人视频窗口，并支持下拉关闭

5.支持手机、平板同时登录具体使用请见70.3.5 更新内容 2021-02-10 60.15.6 1.新增自定义来电自动处理接口

2.新增自定义设置来电响铃和震动 3.sdk 资源包aar依赖变更

4.自定义隐藏外部标签，

具体使用请见60.15.6 更新内容 2021-01-08 60.13.2 1. 添加与会者

2. 离开会议 3. 结束会议 4. 错误码更新

2020-12-07 60.12.5 1. 创建会议支持指定会议室（vmrId）和入会范围（joinConfRestrictionType）

2. 错误码更新 3. 新增头像上传接口

4. 新增头像拦截接口，可以使用自己的头像显示

5. 自定义菜单样例更新具体参见60.12.5更新内容 2020-11-07 60.11.1 1、新增支持会议自动录制

2、新增自定义会议来电接听按钮显示 3、新增呼叫设置昵称

具体参见60.11.1更新内容

2020-10-15 60.10.5 1、新增是否开启第三方数据采集配置：

2、新增自定义接入站点：

3、自定义会中分享面板参数变更：

4、加入会议接口参数变更：

具体参见60.10.5更新内容

(73)

2020-09-04 60.8.1 1、初始化增加App ID，可以传入企业App ID

2、新增App ID登录、预约会议、编辑会议、会议列表、会议详情、取消会议等接口

3、新增自定义是否开启高清优先、自定义会议接听摄像头麦克风开关等配置接口。

4、创建会议参数新增是否开启录制。

5、问题修复，体验更稳定具体参见60.8.1更新内容

2020-07-30 60.7.1 1、会议中UI界面优化，菜单目录结构和接口发生变更，逻辑更清晰

2、支持会议中成员文字聊天，支持自定义配置是否显示

3、会控菜单自定义接口优化，部分接口替换，使用更灵活

具体参见60.7.1更新内容 2020-06-29 60.6.4 新增如下接口

● 新增回调会中是否是主持人

● 新增接口当前是否是主持人修改如下接口

● 部分参数变更

参照自定义会中分享链接

● 部分接口修改

参照自定义底部菜单栏 2020-05-08 60.5.3 更新部分使用文档：

● 删除“创建会议（携带与会人信息）”

接口，和“创建会议”接口合并

● 优化接口名称和结构 2019-11-12 6.1.223 修复部分已知问题 2019-08-31 6.1.203 新增如下接口

●

注销功能

修改如下接口

●

登录登录：接口参数发生变更，登录地

址与端口不再需要传入

●

加入会议：加入会议接口与匿名入会接

口合并，删除匿名入会接口，加入会议接口参数发生变更

(74)

日期版本修订内容 2019-07-23 6.1.195 新增如下接口：

● 匿名入会：支持用户匿名入会（未登录场景下的入会）。

● 支持会议中返回到悬浮窗状态。

2019-06-21 6.1.187 新增如下接口：

●

发起呼叫：支持用户主动发起点对点呼

叫。

2019-04-13 6.1.27 新增如下接口：

● 创建会议（携带与会人信息）：支持在创建即时会议的时候携带与会者，与会者会收到呼叫入会的来电。

新增如下能力：

● 来电接听：支持应用在前台收到其他人的来电接听后加入会议。

● 应用集成，详见基于应用的集成。

2019-03-29 6.1.23 首次发布。

5.3 快速入门

本文面向有一定Android原生开发能力的开发者，以登录华为云会议并发起和加入视频会议的流程为例，介绍如何使用SDK 进行二次开发

开发环境准备

在接入SDK前需要准备如下环境：

环境要求（强制要求）

开发环境，目的是为了给编译运行源码的人员提供参考：

环境要求（非强制要求）

SDK 快速集成

步骤1 解压SDK

下载解压软件包，得到如下几个文件：

图5-1 文件目录

(75)

步骤2 新建工程

● 打开Android Studio，单击“File -> New -> New Project...”新建工程，选择 Phone and Tablet -> Empty Activity 单击Next：

图5-2 创建工程

● 输入相关项目信息，单击“Finish”完成工程创建。（请注意最小Android API 版本为23）：

(76)

图5-3 设置名称

步骤3 集成SDK

● 在Android Studio中，将工程目录结构切换到Project：

SDK概述_会议_客户端SDK参考_华为云

22 客户端 SDK 参考

华为技术有限公司

https://www.huawei.com

[email protected]

目 录

1 SDK 概述... 1

2 Demo 体验...3

2.1 Demo 安装包下载... 3

2.2 Demo 一览... 5

3 SDK 下载... 9

4 一分钟跑通 Demo...22

4.1 跑通 Android Demo... 22

4.2 跑通 iOS Demo...29

4.3 跑通 Windows MFC Demo... 35

4.4 跑通 Windows Electron Demo... 38

4.5 跑通 Mac Native Demo... 45

4.6 跑通 Mac Electron Demo... 48

5 Android SDK...55

5.1 概述... 55

5.2 修订记录... 56

5.3 快速入门... 60

5.4 典型场景... 73

5.4.1 典型场景接口调用概览...74

5.4.2 场景 1： 初始化... 76

5.4.3 场景 2： 帐号密码方式登录...76

5.4.4 场景 3： App ID 方式登录... 77

5.4.5 场景 4： 预约会议... 78

5.4.6 场景 5： 编辑会议... 80

5.4.7 场景 6： 创建会议... 81

5.4.8 场景 7： 加入会议... 83

5.4.9 场景 8： 发起呼叫... 84

5.4.10 场景 9： 注销... 85

5.5 接口参考... 85

5.5.1 基础配置... 85

5.5.1.1 初始化...85

5.5.1.2 设置接入站点...87

5.5.1.3 自定义会中分享面板...87

5.5.1.4 自定义日志保存路径...88

5.5.1.5 自定义开关会中聊天功能... 89

5.5.1.6 自定义是否开启会议高清优先... 90

5.5.1.7 自定义会议接听时摄像头/麦克风开关...90

5.5.1.8 自定义设置来电响铃和震动...91

5.5.1.9 自定义隐藏外部标签...92

5.5.2 界面定制... 92

5.5.2.1 自定义底部菜单栏... 92

5.5.2.2 自定义与会者列表页面中的菜单...100

5.5.2.3 自定义会中标题栏点击弹出菜单...104

5.5.2.4 自定义会议中加人...106

5.5.2.5 自定义会中通知栏...108

5.5.2.6 头像拦截显示... 109

5.5.2.7 自定义视频会议来电时接听方式按钮... 112

5.5.2.8 自定义会议中水印...113

5.5.3 帐号操作... 115

5.5.3.1 帐号密码方式登录...115

5.5.3.2 App ID 方式登录... 116

5.5.3.3 SSO 方式登录... 118

5.5.3.4 注销...120

5.5.3.5 上传个人头像... 121

5.5.4 会议管理... 122

5.5.4.1 预约会议... 122

5.5.4.2 编辑会议... 126

5.5.4.3 取消会议... 127

5.5.4.4 获取会议列表... 128

5.5.4.5 获取会议详情... 129

5.5.4.6 获取云会议室列表...131

5.5.4.7 修改云会议室信息...132

5.5.5 会议控制... 132

5.5.5.1 创建会议... 133

5.5.5.2 加入会议... 135

5.5.5.3 添加与会者...137

5.5.5.4 离开会议... 138

5.5.5.5 结束会议... 139

5.5.6 呼叫控制... 139

5.5.6.1 发起呼叫... 139

5.5.7 获取会议信息...141

5.5.7.1 获取与会者列表... 141

5.5.7.2 获取观众列表... 141

5.5.7.3 获取用户状态... 142

5.5.8 音视频数据流...143

目录

5.4.2 场景 1：初始化... 76

5.4.3 场景 2：帐号密码方式登录...76

5.4.5 场景 4：预约会议... 78

5.4.6 场景 5：编辑会议... 80

5.4.7 场景 6：创建会议... 81

5.4.8 场景 7：加入会议... 83

5.4.9 场景 8：发起呼叫... 84

5.4.10 场景 9：注销... 85