检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义会中水印 SetWaterMark 接口描述 该接口用于设置水印自定义内容注入,若未进行设置,将默认使用内部优先级来展示水印内容。 图1 自定义水印 注意事项 该接口必须在会前调用,会中调用不会即时生效。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
连接断开 通知描述 收到该通知时,表示与SDK的连接断开了。 方法定义 1 virtual void OnSdkDisconnected() {}; 注意事项 收到该通知,表明SDK发生异常断开,需要重新调用初始化接口,否则SDK无法使用。 参数描述 无。 父主题: 基础配置变更通知
thirdUserId 是 char[] 第三方用户ID。与number二选一,App ID鉴权时使用。 accountId 否 char[] 华为云会议账号。 返回值 表2 返回值 类型 描述 HwmErrCode 成功返回0,其他值表示失败。失败返回值见错误码参考。 示例代码 1 2
添加与会者 addAttendee 接口描述 该接口用于在会议中添加与会者。 注意事项 必须在会议中,并且只有主持人才可以加人; 方法定义 1 - (void)addAttendee:(NSArray<HWMContactSelectedModel *> *)params com
会议结束通知 通知描述 收到该通知时,表示当前会议已结束。 方法定义 1 - (void)onConfEndedNotify:(HWMSDKERR)confEndCode; 注意事项 SDK初始化时设置globalHandler代理对象或者在需要处理的界面设置代理对象。 参数描述
获取用户状态 1 HWMSdk.getOpenApi().getHWMUserState(); 接口描述 该接口用于获取用户当前的状态(是否在会议中)。 注意事项 无。 方法定义 1 2 3 4 /** * 获取用户当前的状态(是否在会议中) */ HWMUserState
显示会议主窗口 showMeetingWindow 接口描述 当会议主窗口处于最小化或者被其他窗口覆盖时,使用该接口将会议主窗口拉到最上层。 注意事项 无 方法定义 - (void)showMeetingWindow; 参数描述 无 返回值 无 示例代码 [[HWMBizSdk getBizOpenApi]
编辑周期会议 ModifyCycleConf 接口描述 该接口用于编辑周期会议。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 所有字段必填,编辑修改的字段可来源于用户输入,其他不想修改的属性一定要取会议详情对应字段来赋值。
共享工具栏定制 screenShareToolBarItems 接口描述 该接口用于共享工具栏左侧区域按钮的定制。 下图中框选部分按钮最多可定制8个按钮,多余按钮将不会被展示。 图1 共享按钮定制位置 注意事项 传入的按钮如果当前场景不支持或当前角色不支持将不会被展示; 方法定义
音视频数据流 获取音频流 父主题: 接口参考
音视频数据流 获取音频流 父主题: 接口参考
自定义会中水印 setWaterMark 接口描述 该接口用于自定义共享时的水印。 方法定义 1 - (void)setWaterMark:(nullable NSAttributedString *)waterMarkString; 参数描述 水印要展示的内容。 返回值 无 示例代码
编辑周期会议 editCycleConf 接口描述 该接口用于编辑周期会议。 注意事项 该接口在已登录状态下才能调用。 所有字段必填,编辑修改的字段可来源于用户输入,其他不想修改的属性一定要取会议详情对应字段来赋值。 方法定义 1 - (void)editCycleConf:(H
禁用提示音 disableVoicePrompts: 接口描述 禁用会议提示音。 注意事项 该接口非必需调用,若不设置,则使用默认模式,不禁用会议提示音。 返回值只代表接口是否调用成功。 方法定义 1 - (HWMSDKERR)disableVoicePrompts:(HWMSDKVoicePromptsModel
禁用提示音 DisableVoicePrompts 接口描述 禁用提示音。 注意事项 该接口非必需调用,如不调用,则默认播放会中提示音。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
异步初始化 InitAsync 初始化 1 HWMSdk.initAsync(Application,OpenSDKConfig, SdkCallback) 接口描述 该接口用于异步初始化SDK,进行一些环境准备工作,调用其他接口之前必须先完成异步初始化并收到onSuccess
上传个人头像 UploadSelfAvatar 接口描述 该接口用于上传当前自己的头像到会议服务器的通讯录。 注意事项 请在已登录状态下调用。 上传的图片文件格式仅支持jpg/png格式,大小需要限制在200KB以下。 为保证头像展示效果,建议图片宽高比为1:1 方法定义 1 HWM_SDK_AGENT_API
上传个人头像 uploadSelfAvatarWithFilePath:callback: 接口描述 该接口用于上传用户自己头像。 注意事项 文件路径为头像路径。 大小限制200k。 只支持jpg、png。 为了头像展示效果,建议图片宽高比为1:1。 回调error表示错误信息,nil表示成功。
联系人UI定制 openContactSelectPage:scene:completeHander: 接口描述 该接口用于定制打开联系人选择页面。 图1 生效后拦截SDK选择联系人界面 注意事项 如果自定义需要自己构建加人UI界面,组装添加人员数组。 方法定义 1 2 3 -
设置证书校验信息 setCAVerifyInfo 接口描述 该接口用于设置证书校验信息。 注意事项 1. 该接口非必需调用,若不设置,则默认不开启证书校验。 方法定义 1 - (HWMSDKERR)setCAVerifyInfo:(HWMUISDKCAVerifyInfoModel