检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义会中水印 screenShareCoverView 接口描述 该接口用于屏幕共享/白板共享设置水印。该水印是在接收端叠加到共享内容上的。服务器上配置后才会显示水印。 1、在桌面共享、程序共享、白板共享的接收端叠加水印图片,只有服务器上会中水印打开的情况下自定义水印才生效。如
获取会议列表 接口描述 该接口用于获取会议列表。 注意事项 已登录状态,首次收到会议列表通知之后,调用才有效,否则返回为空的列表。 方法定义 1 2 3 4 5 /** * 获取会议列表 * @return */ List<ConfBaseInfo>
账号密码登录 描述 该接口用于账号登录。创建会议等接口不支持在未登录状态下调用,若要使用完整的会议功能,必须先登录。 在未登录状态下,只能加入已经创建的会议。 业务流程 使用SDK登录时,先调用login接口,然后处理回调callback。 接口调用 获得登录使用的账号和密码。
音视频数据流 开启第三方视频推流配置 设置第三方推流视频镜像 第三方视频推流 父主题: 接口参考
自定义设置界面 buildSettingTabItems 接口描述 该接口用于自定义设置界面中各标签页和功能区的显示隐藏,若未进行设置,则默认都显示。 图1 自定义设置界面 方法定义 1 - (NSArray <HWMSettingTabItem *> *)buildSettingTabItems;
账号被踢出 通知描述 收到该通知时,表示当前使用的账号被其他终端踢出,退出登录状态,需要重新登录。如果需要继续操作,需要重新调用登录接口。 方法定义 1 - (void)onKickedOut; 示例代码 /// 被挤下线 - (void)onKickedOut { N
会控状态变更通知 会控状态变更通知 父主题: 事件通知参考
底部工具栏定制 此章节以视频会议为例(音频会议同理使用)。 buildToolBarMenuItems 接口描述 该接口用于构建视频会议底部toolbar的会控全量菜单。 图1 视频会议会控菜单定制位置 注意事项 此方法用于视频会议底部toolbar的定制。 方法定义 1 - (NSArray
会中水印定制 接口描述 该接口用于屏幕共享设置水印。该水印是在接收端叠加到共享内容上的。服务器上配置后才会显示水印。 1、在桌面共享的接收端叠加水印图片,只有服务器上会中水印打开的情况下自定义水印才生效。如果不自定义,默认按照手机号、邮箱、会议ID+昵称优先级顺序显示,字体透明度10%。
登录异常通知 通知描述 收到该通知时,表示登录失败,但是非上述登录失败的场景。 方法定义 1 onLoginInvalidNotify?: (result: SDKERR, reasonDesc: string) => void; 注意事项 无。 参数描述 参数 类型 描述 result
Token失效通知 通知描述 收到该通知时,需要进行重新登录(退出并登录),否则会影响创会预约会议等基本功能。 方法定义 1 onTokenInvalidNotify?: (tokenError: SDKERR) => void; 注意事项 无。 参数描述 参数 类型 描述 tokenError
邀请外部与会者 handleInviteUserResult 接口描述 该接口支持邀请软终端用户和宝利通设备 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 handleInviteUserResult(userInfo):Promise<Result> 参数描述 表1
退出 接口功能 该接口用于退出SDK。注意事项:1、该接口用于退出SDK,调用该接口之后SDK不可使用;2、应用退出时请调用该接口,若不调用该接口,则SDK无法退出,应用退出后SDK进程将继续存在;3、mac请在杀进程场景调用。 函数原型 exit(): SDKERR 返回值 SDKERR请参考错误码参考
共享vmr信息变化 接口描述 收到该通知时,表示共享vmr信息发生变化。 方法定义 1 2 3 4 5 6 /** * 共享云会议室刷新 * * @param shareVmrInfo 共享云会议室信息 */ void on
Random入会 接口功能 通过邮件会议通知中的会议链接入会时(会议链接如:https://bmeeting.huaweicloud.com/#/j/981924330/e11ddec62ee760734fcf2ba55b79937eac2aa68677caf659), 链接里面
结束会议 接口功能 该接口用于结束会议。注意事项:1、不在会议中不应调用此接口;2、调用该接口,会议将结束,无法再次加入该会议。 函数原型 endConf(onEndConfResult?: (ret: SDKERR, reason: string) => void): void
取消周期子会议 接口功能 该接口用于取消周期子会议。注意事项:1、该接口在已登录状态下才能调用。2、子会议未开始前可以调用接口,开始后调用则无效 3、该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 函数原型 cancelSubCycleC
个人角色变化通知 通知描述 收到该通知时,表示个人角色发生变化。 方法定义 1 - (void)onSelfRoleChanged:(HWMConfRoleType)confRole; 示例代码 - (void)onSelfRoleChanged:(HWMConfRoleType)confRole
示例1:App ID鉴权业务流程 应用场景 在使用华为云会议提供的各类REST API之前,需要向服务器完成鉴权登录;当不再使用业务时注销,确保业务接口使用的安全性。 业务流程 图1 普通鉴权登录流程图 初始化参数,填入App ID、User ID、Authorization等参数。App
WebSocket建链 描述 通过此接口,完成与会议服务器端会控WebSocket通道的建立。请求前缀通过会议控制中获取会控Token的接口可获取建链地址(wsURL)。请求鉴权处理失败时,会议服务器端会主动关闭WebSocket通道。 该Websocket的连接在会议结束后服务端会主动拆除。