华为云用户手册

setScreenShareExtensionBundleId: 接口描述 该接口用于设置屏幕共享插件bundleId。 注意事项 该接口非必需调用，若不设置，则使用默认格式生成bundleId，用来拉起屏幕共享插件。 方法定义 1 + (void)setScreenShareExtensionBundleId:(NSString *)bundleId; 参数描述 表1 参数说明 参数 是否必须 类型 描述 bundleId 是 NSString * 屏幕共享插件bundleId 返回值 无 示例代码 1 [HWMSdk setScreenShareExtensionBundleId:setScreenShareExtensionBundleId];

windows平台集成ElectronSDK后启动失败，报错The specified module could not be found 客户案例： windows平台在集成Electron SDK后启动失败，报错The specified module could not be found。 原因分析： 集成uisdk库时dll文件缺失，导致HwmUisdk.node加载报错。 解决方案： 参照electronSDK快速入门操作重新集成，也可参照electron demo对应目录下的库进行集成，32位路径参考：hwmsdk-electron-ia32\resources\sdk\win32，64位路径参考：\hwmsdk-electron-x64\resources\sdk\x64。 父主题： Electron SDK

windows平台集成ElectronSDK后启动失败，报错HwmUisdk.node is not a valid Win32 application 客户案例： windows平台在集成Electron SDK后启动失败，报错HwmUisdk.node is not a valid Win32 application。 原因分析： 该问题有2种原因导致：1、系统缺失所需的运行时库 2、dll和.node文件的位数不一致 解决方案： 通过运行官网windows C++ Demo安装包来区分是上述哪种原因导致： 1、如果c++ demo运行失败，报错应用程序无法正常启动(0xc000007b)，则明确是原因1导致，需要下载对应版本的运行时库 2、如果c++ demo运行成功，则参照electronSDK快速入门操作重新集成，保证dll和.node文件位数一致 父主题： Electron SDK

90.12.5更新内容 废弃接口getVmrList，新增接口getVmrInfoList，具体请见云会议室列表 新增共享vmr信息通知OnShareVmrInfoNotify，具体请见共享vmr信息 新增获取错误提示接口getErrorMessage，文案可用于提示，具体请见获取错误提示 新增设置(会控)保底ip地址接口setGuaranteedIpAddresses，支持下沉企业数据不上云或断网逃生，具体请见设置会控保底ip地址 HWMUISDKErrorDefine.h更名为HWMErrorDefine.h，如有使用需要做相关调整 问题修复，体验更稳定。 父主题： 版本更新内容

参数描述 表1 HWMP2PConfRecordInfoModel 参数说明 参数 类型 描述 callerInfo HWMUISDKCallMemberInfoModel 主叫方信息。 calleeInfo HWMUISDKCallMemberInfoModel 被叫方信息。 startTime NSInteger 呼叫开始时间。 endTime NSInteger 呼叫结束时间。 isCallOut BOOL 是否为主动呼出。 mediaType HWMUISDKMediaType 媒体类型。 resultCode HWMUISDKSDKERR 呼叫结束原因。 resultMsg NSString 呼叫结束描述。 isCallEstablished BOOL 呼叫是否建立。 表2 HWMUISDKCallMemberInfoModel参数说明 参数 类型 描述 number NSString 号码。 nickName NSString 成员名称。 thirdUserId NSString 第三方账号。 表3 枚举HWMUISDKMediaType说明 枚举值 描述 HWMUISDKMediaTypeAudio 音频类型。 HWMUISDKMediaTypeVideo 视频类型。

设置会控保底ip地址 接口描述 该接口用于设置会控保底ip地址。 注意事项 该接口非必需调用，若不设置，则使用默认保底ip。 多个地址中间用分号隔开，最多支持4个地址。 方法定义 SDKERR setGuaranteedIpAddresses(String addresses); 示例代码 SDKERR sdkerr = HWMBizSdk.getBizOpenApi().setGuaranteedIpAddresses(ip); DemoUtil.showToast("设置结果： " + sdkerr.getValue() + " " + sdkerr.getDescription()); 父主题： 基础配置

录制会议权限更新 接口描述 收到该通知时，表示是否有录制会议权限。 方法定义 1 2 3 4 5 6 /** * 录制会议权限更新通知 * * @param hasPermission */ void onRecordPermissionChanged(boolean hasPermission); 参数描述 表1 参数说明 参数 类型 描述 hasPermission boolean 是否有录制会议权限 返回值 无。 父主题： 业务 消息通知

会议弱网提示通知 接口描述 收到该通知时，表示当前会议网络不稳定。 方法定义 /** * 弱网信息的上报 * * @param poorNetWorkInfo */ void onPoorNetworkQualityInfoNotify(PoorNetWorkQualityInfo poorNetWorkInfo); 参数描述 表1 参数说明 参数 是否必须 类型 描述 poorNetWorkInfo 是 PoorNetWorkQualityInfo 弱网信息 返回值 无。 参数拓展 表2 PoorNetWorkQualityInfo 参数说明 参数 是否必须 类型 描述 userId 是 int 用户id nickName 是 String 会中昵称 thirdUserId 是 String 三方账号 accountId 是 String 账号信息 number 否 String sip号码 isLocal 是 boolean 是否本端 audioStatus 否 LowNetWorkStatusInfo 音频网络状态 videoStatus 否 LowNetWorkStatusInfo 视频网络状态 shareStatus 否 LowNetWorkStatusInfo 共享网络状态 表3 LowNetWorkStatusInfo参数说明 参数 是否必须 类型 描述 packetLoss 是 int 丢包率 delay 是 int 时延 jitter 是 int 抖动 status 否 LowNetWorkStatusInfo 状态 表4 枚举LowNetWorkStatus说明 值 描述 LOW_NET_WORK_STATUS_NORMAL 网络正常 LOW_NET_WORK_STATUS_BAD 网络差 LOW_NET_WORK_STATUS_VERY_BAD 网络非常差 父主题： 会议状态变更通知

预约会议发送短信权限更新 接口描述 收到该通知时，表示预约会议发送短信权限更新，是否可以发送短息。 方法定义 1 2 3 4 5 6 /** * 预约会议发送短信权限更新通知 * * @param hasPermission */ void onBookConfSmsPermissionChanged(boolean hasPermission); 参数描述 表1 参数说明 参数 类型 描述 hasPermission boolean 预约会议是否有发送短信通知权限 返回值 无。 父主题： 业务消息通知

会议详情通知 接口描述 收到该通知时，表示会议中的信息发生变更。 方法定义 1 2 3 4 5 6 /** * 会议详情的上报 * * @param meetingInfo */ void onMeetingInfoChanged(MeetingInfo meetingInfo); 参数描述 表1 参数说明 参数 类型 描述 meetingInfo MeetingInfo 会议信息 返回值 无。 参数拓展 表2 MeetingInfo参数说明 参数 类型 描述 confSubject String 会议主题 confId String 会议ID vmrConfId String 个人会议ID selfConfRole ConfRole 本人在会议中的角色，详见表3 hostPwd String 主持人入会密码 guestPwd String 来宾入会密码 audiencePwd String 观众入会密码 accessNumber String 会议接入码 hostJoinUri String 主持人入会链接 guestJoinUri String 来宾入会链接 audienceJoinUri String 观众入会链接 timeZone String 时区 startTimeStamp long 会议开始时间，UTC时间戳，精度秒 endTimeStamp long 会议结束时间，UTC时间戳，精度秒 serverCurrentTime long 当前服务器时间 scheduserUuid String 预订者uuid scheduserName String 预订者姓名 orgId String 企业id，可以用作判断是否外部用户 isWebinar boolean 是否是网络研讨会 isCreator boolean 是否是会议预订者 conferenceType ConferenceType 会议类型，详见表4 confUuid String 会议uuid openCustomPara String 自定义扩展信息 liveRoomAddress String 直播地址 isHighResolution boolean 是否为超高清(1080p)会议 isP2PConf boolean 是否立即会议 supportSummary boolean 是否支持会议纪要 defaultSummaryState SummaryState 会议纪要开启状态，详见表5 recordMode ConfRecordMode 会议媒体录制模式 supportBreakoutConf boolean 是否支持分组会议 isBreakoutSubConf boolean 是否是分组会议，详见表6 supportGuestInviteAttendee boolean 普通与会者是否支持邀请与会者 表3 枚举ConfRole说明 枚举值 描述 ROLE_ATTENDEE 普通与会者 ROLE_HOST 会议主持人 ROLE_AUDIENCE 观众 ROLE_COHOST 联席主持人 ROLE_WAITING 等候室成员 表4 枚举ConferenceType说明 枚举值 描述 CONF_TYPE_COMMON 普通会议 CONF_TYPE_CYCLE 周期会议 表5 枚举SummaryState说明 枚举值 描述 SUMMARY_STATE_CLOSE 会议纪要关闭 SUMMARY_STATE_OPEN 会议纪要开启 表6 枚举ConfRecordMode说明 枚举值 描述 CONF_RECORD_DISABLE 禁止录制 CONF_RECORD_LIVE 直播模式 CONF_RECORD_RECORD 录播模式 CONF_RECORD_LIVE_AND_RECORD 直播 + 录播模式 父主题： 会议状态变更通知

方法定义 - (void)onShareVmrInfoNotify:(HWMSDKShareVmrInfoModel *)shareVmrInfo; 示例代码 - (void)onShareVmrInfoNotify:(HWMSDKShareVmrInfoModel *)shareVmrInfo{ NSLog(@"%@", [shareVmrInfo yy_modelDescription]); }

getMainWindowInfo 接口描述 该接口用于获取主窗口信息。 方法定义 1 - (HWMUISDKMainWindowInfoModel *)getMainWindowInfo; 参数描述 无 返回值 表1 HWMUISDKMainWindowInfoModel参数说明 参数 类型 描述 x NSInteger 窗口相对于屏幕左侧的偏移量。 y NSInteger 窗口相对于屏幕顶端的偏移量。 width NSInteger 窗口的宽度。 height NSInteger 窗口的高度。 handle NSUInteger 窗口句柄。 示例代码 1 HWMUISDKMainWindowInfoModel * info = [[HWMBizSdk getBizOpenApi] getMainWindowInfo];

setGuaranteedIpAddresses: 接口描述 该接口用于设置会控保底ip地址。 注意事项 多个地址中间用分号隔开，最多支持4个地址。 返回值只代表接口是否调用成功。 方法定义 1 - (HWMSDKERR)setGuaranteedIpAddresses:(NSString *)pAddresses; 参数描述 表1 参数说明 参数 是否必须 类型 描述 pAddresses 是 NSString * 保底ip地址信息 返回值 接口是否调用成功 示例代码 1 [[HWMBizSdk getBizOpenApi] setGuaranteedIpAddresses:guaranteeIpAddrs];

ShowToast 接口描述 该接口用于显示toast。 注意事项 该接口为异步接口，返回值只代表接口是否调用成功，实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode ShowToast(const HwmToastInfo* toastInfo); 回调函数 1 virtual void OnShowToastResult(hwmsdk::HwmErrCode ret, const char* reason) {}; 参数描述 表1 参数说明 参数 是否必须 类型 描述 toastInfo 是 HwmToastInfo toast提示信息。 表2 结构体HwmToastInfo参数说明 参数 类型 描述 content char[] 提示内容。 duration int 提示持续时间（单位：秒）。 表3 返回值 类型 描述 HwmErrCode 成功返回0，其他值表示失败。失败返回值见错误码参考。 示例代码 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 /** * 显示toast提示 */ void demoShowToastDlg::OnBnClickedOk() { hwmsdkagent::HwmToastInfo toastInfo{ 0 }; std::string toastContent = "toastContent"; strcpy_s(toastInfo.content, HWM_MAX_TOAST_CONTENT_LEN, toastContent.c_str()); toastInfo.duration = 5; int ret = hwmsdkagent::ShowToast(&toastInfo); if (hwmsdk::HWM_COMMON_SUC CES S != ret) { AfxMessageBox(_T("show toast error")); return; } }

90.12.5更新内容 1.新增显示提示信息接口ShowToast，详见显示提示信息 2.新增获取主窗口信息接口GetMainWindowInfo，详见获取主窗口信息 3.废弃通知OnGetVmrListResult、新增Vmr列表结果通知OnGetVmrInfoListResult，详见获取VMR列表 4.新增参数会议资源类型confResType，涉及创会信息HwmCreateConfInfo、预约会议参数HwmBookConfParam，详见表1、表1 5.新增共享vmr信息通知OnShareVmrInfoNotify，详见共享vmr信息通知 6.被叫信息HwmCalleeInfo新增参数与会者uuid，详见表3 7.新增获取错误提示接口GetErrorMessage，文案可用于提示，详见获取错误提示 8.新增设置(会控)保底ip地址接口SetGuaranteedIpAddresses，支持下沉企业数据不上云或断网逃生，详见设置会控保底ip地址 9.会议结束原因HwmConfEndReason新增错误码 HWM_CONF_END_REASON_OVER_MAX_PARTICIPANT_NUMBER 超过设置的会议方数，HWM_CONF_END_MANAGER_SHARE_VMR_NOT_ENOUGH 无共享云会议室资源，HWM_CONF_END_MANAGER_NO_UPSCALE_VMR 无高档可用的VMR资源，详见表3 10.新增立即会议记录通知OnP2PConfRecordNotify，详见立即会议记录 11.config接口新增配置字段copy_audience_conf_info，支持网络研讨会中观众链接的复制按钮可注入，详见表3 父主题： 版本更新内容

mac平台集成ElectronSDK后，本地编译启动后应用能正常入会，但是打包后应用出现入会闪退问题 客户案例： mac平台，在集成Electron SDK后，本地编译应用启动后能正常入会，但是打包后应用出现入会闪退。 原因分析： 打包的过程没有对electronSDK的库进行签名。 解决方案： 参考demo里的签名脚本进行签名： 文件路径：hwmsdk-electron\packages\hwmsdk-electron-demo\package.json 注意：需要将脚本里面的证书替换成自己应用的证书。 父主题： Electron SDK

接口功能 通过邮件会议通知中的会议链接入会时（会议链接如：https://bmeeting.huaweicloud.com/#/j/981924330/e11ddec62ee760734fcf2ba55b79937eac2aa68677caf659）， 链接里面的是会议ID（即举例中的981924330）和会议的Random码（即举例中的e11ddec62ee760734fcf2ba55b79937eac2aa68677caf659）。第三方App需要调用本接口加入会议。

共享vmr信息变化 接口描述 收到该通知时，表示共享vmr信息发生变化。 方法定义 1 2 3 4 5 6 /** * 共享云会议室刷新 * * @param shareVmrInfo 共享云会议室信息 */ void onShareVmrInfoNotify(ShareVmrInfo shareVmrInfo); 参数描述 表1 参数说明 参数 类型 描述 shareVmrInfo ShareVmrInfo 共享云会议室信息 表2 ShareVmrInfo说明 参数 类型 描述 isEnableShareVmr boolean 共享vmr是否可用 返回值 无。 父主题： 业务消息通知

showToast 接口描述 该接口用于显示toast提示。 方法定义 1 - (void)showToast:(HWMUISDKToastInfoModel *)info; 参数描述 表1 参数说明 参数 是否必须 类型 描述 info 是 HWMUISDKToastInfoModel 提示信息 表2 结构体HWMUISDKToastInfoModel 参数说明 参数 类型 描述 content NSString * 提示内容。 duration NSInteger 提示持续时间（单位：秒）。 返回值 无 示例代码 1 2 3 4 5 HWMUISDKToastInfoModel * info = [[HWMUISDKToastInfoModel alloc] init]; // 从输入框获取提示内容和提示持续时间 info.content = self.toastContentView.textField.stringValue; info.duration = self.toastDurationInfoView.textField.intValue; [[HWMBizSdk getBizOpenApi] showToast:info];

90.12.5更新内容 1. 新增显示提示信息接口showToast，具体详见显示提示信息。 2. 新增获取主窗口信息接口getMainWindowInfo，具体详见获取主窗口信息。 3. 创建会议、预约会议新增参数会议资源类型confResType，具体详见创建会议、预约会议。 4. 新增共享vmr信息通知onShareVmrInfoNotify，具体详见共享vmr信息通知。 5. 新增获取错误提示接口getErrorMessage，文案可用于提示，具体详见获取错误提示。 6. 新增设置(会控)保底ip地址接口setGuaranteedIpAddresses，支持下沉企业数据不上云或断网逃生，具体详见设置会控保底ip地址。 7. config接口新增配置字段copy_audience_conf_info，支持网络研讨会中观众链接的复制按钮可注入，具体详见界面配置json说明。 父主题： 版本更新内容

getErrorMessage 接口描述 该接口用于获取错误提示。 注意事项 该接口为同步接口，返回值代表接口是否调用成功。 方法定义 1 - (NSString *)getErrorMessage:(NSUInteger)code; 参数描述 表1 参数说明 参数 是否必须 类型 描述 code 是 NSUInteger 错误码 返回值 无 示例代码 1 NSString *msg = [[HWMBizSdk getBizOpenApi] getErrorMessage:errorCode];

getErrorMessage 接口描述 该接口可根据错误码获取错误提示。 方法定义 1 - (NSString *)getErrorMessage:(NSUInteger)code; 参数描述 表1 参数说明 参数 类型 描述 code NSUInteger 错误码。 返回值 表2 参数说明 类型 描述 NSString * 错误提示。 示例代码 1 2 3 - (void)setError:(NSError *)error { NSString *errorTips = [[HWMBizSdk getBizOpenApi] getErrorMessage:error.code]; }

90.12.5更新内容 1. 新增显示提示信息接口ShowToast，具体请见显示提示信息。 2. 新增获取主窗口信息接口GetMainWindowInfo，具体请见获取主窗口信息。 3. getVmrList接口废弃、新增getVmrInfoList接口，具体请见云会议室列表。 4. 创建会议参数HWMCreateConfParam、预约会议参数HWMOrderConfParam新增字段HWMConfResType会议资源类型，具体请见HWMCreateConfParam参数说明、HWMOrderConfParam参数说明。 5. 新增共享vmr信息通知OnShareVmrInfoNotify，具体请见共享vmr信息变更通知。 6. 新增获取错误提示接口GetErrorMessage，文案可用于提示，具体请见获取错误提示。 7. 新增设置(会控)保底ip地址接口SetGuaranteedIpAddresses，支持下沉企业数据不上云或断网逃生，具体请见设置会控保底ip地址。 8. 新增立即会议记录通知OnP2PConfRecordNotify，具体请见立即会议记录通知。 父主题： 版本更新内容

90.12.5更新内容 废弃接口getVmrList，新增接口getVmrInfoList，具体请见云会议室列表 新增共享vmr信息通知OnShareVmrInfoNotify，具体请见共享vmr信息变化 新增参数会议资源类型confResType，涉及创会信息CreateConfInfo、预约会议参数BookConfParam，详见预约会议、创建会议 新增立即会议记录通知OnP2PConfRecordNotify，详见会议状态变更通知 新增获取错误提示接口GetErrorMessage，文案可用于提示，详见获取错误提示 新增设置(会控)保底ip地址接口SetGuaranteedIpAddresses，支持下沉企业数据不上云或断网逃生，详见设置会控保底ip地址 问题修复，体验更稳定。 父主题： 版本更新内容

GetErrorMessage 接口描述 该接口用于获取错误提示。 注意事项 该接口为同步接口，返回值代表接口是否调用成功。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetErrorMessage(int errorCode, OUT HwmErrorMessageInfo *errorMessageInfo); 参数描述 表1 参数说明 参数 类型 描述 errorCode int 错误码。 表2 结构体HwmErrorMessageInfo参数说明 参数 类型 描述 errorMessage char[] 错误提示，注：UTF8编码。 表3 返回值 类型 描述 HwmErrCode 成功返回0，其他值表示失败。失败返回值见错误码参考。 HwmErrorMessageInfo 错误提示。 示例代码 1 2 3 4 5 6 7 8 9 10 11 12 13 /** * 获取错误提示 */ void demoGetErrorMessageDlg::OnBnClickedOk() { hwmsdkagent::HwmErrorMessageInfo info{}; int ret = hwmsdkagent::GetErrorMessage(hwmsdk::HWM_AGENT_ERR_IN_PROCESS, &info); if (hwmsdk::HWM_COMMON_SUCCESS != ret) { AfxMessageBox(_T("get error message error")); return; } }

参数描述 表1 结构体HwmP2PConfRecordInfo参数说明 参数 类型 描述 callerInfo HwmCallMemberInfo 主叫方信息。 calleeInfo HwmCallMemberInfo 被叫方信息。 startTimeStamp int 会议开始时间，UTC时间戳，精度秒。 endTimeStamp int 会议结束时间，UTC时间戳，精度秒。 isCallOut bool 是否为主动呼出。 mediaType HwmMediaType 媒体类型。 resultCode HwmErrCode 错误码。 resultMsg char[] 错误描述。 isCallEstablished bool 呼叫是否建立。 表2 结构体HwmCallMemberInfo参数说明 参数 类型 描述 number char[] 号码。 nickName char[] 成员名称。 thirdUserId char[] 第三方账号。

GetMainWindowInfo 接口描述 该接口用于获取主窗口信息。 注意事项 该接口为异步接口，返回值只代表接口是否调用成功，实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetMainWindowInfo(); 回调函数 1 virtual void OnGetMainWindowInfoResult(hwmsdk::HwmErrCode ret, const char* reason, const HwmMainWindowInfo *mainWindowInfo) {}; 参数描述 表1 结构体HwmMainWindowInfo参数说明 参数 类型 描述 x int 窗口相对于屏幕左侧的偏移量。 y int 窗口相对于屏幕顶端的偏移量。 width int 窗口的宽度。 height int 窗口的高度。 handle HWND 窗口句柄。 表2 返回值 类型 描述 HwmErrCode 成功返回0，其他值表示失败。失败返回值见错误码参考。 HwmMainWindowInfo 主窗口信息。 示例代码 1 2 3 4 5 6 7 8 9 10 11 12 /** * 获取主窗口信息 */ void demoGetMainWindowInfoDlg::OnBnClickedOk() { int ret = hwmsdkagent::GetMainWindowInfo(); if (hwmsdk::HWM_COMMON_SUCCESS != ret) { AfxMessageBox(_T("get mainwindow info error")); return; } }

90.9.5更新内容 1. 创建会议参数HWMCreateConfParam、预约会议参数HWMOrderConfParam、会议详细信息HWMConfDetail新增字段concurrentParticipants会议最大与会人数，具体请见HWMCreateConfParam参数说明、HWMOrderConfParam参数说明、HWMConfDetail参数说明。 2. 会议来电信息HWMConfIncomingInfo新增字段vmrConfId VMR会议ID，具体请见HWMConfIncomingInfo参数说明。 3. 新增设置日志保存路径接口SetLogPath，具体请见设置日志路径。 父主题： 版本更新内容

90.9.5更新内容 新增会议最大与会人数concurrentParticipants，涉及创会信息HWMCreateConfParam、预约会议参数HWMOrderConfParam、会议详细信息HWMConfDetail，具体请见HWMCreateConfParam参数说明、HWMOrderConfParam参数说明、HWMConfDetail参数说明。 会议来电信息HWMSDKConfIncomingInfoModel新增VMR会议ID参数vmrConfId，具体请见HWMSDKConfIncomingInfoModel参数说明。 问题修复，体验更稳定。 父主题： 版本更新内容

mac平台集成ElectronSDK后，运行报错需要arm64架构的错误提示 客户案例： mac平台，在集成Electron SDK后，运行工程，报错架构不符：have(x86_64)，need(arm64)。 原因分析： 当前mac端UISDK原生部分仅支持x86_64，无arm64版本的库； 解决方案： 1. 设置export npm_config_arch=x64，指定node采用x64平台； 2. 删除以前下载的node_modules文件夹（一定要把之前的删掉）； 3. 重新运行工程，如调试demo可运行run_demo_mac.sh脚本； 父主题： Electron SDK