检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
场景6:加入会议 描述 在登录后或者登录前,都可以使用该接口通过会议ID和密码加入会议。 业务流程 使用SDK加入已经存在的会议时,先调用joinConf接口,然后处理回调callback。 接口调用 组装模型 会议id加入会议使用HWMJoinConfParam。 会议rand
企业管理员设置企业成员头像 描述 企业管理员通过该接口设置指定企业用户的头像。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/usg/abs/profile-images/{user_id} 传输协议 HTTPS
校验Token 描述 该接口提供校验token合法性功能。服务器收到请求后,验证token合法性并返回结果。如果参数needGenNewToken为true时,生成新的token并返回。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST
初始化 初始化接口有主线程初始化、子线程初始化两种,必须先调用任意一个初始化接口后再调用其它接口。 initWithConfig 接口描述 用于启动并且初始化SDK。 注意事项 该接口用于启动并初始化SDK,在调用其他接口之前必须先调用初始化接口。 此初始化方法必须在主线程调用。
添加与会者 AddAttendee 接口描述 该接口用于在会议中添加与会者。 注意事项 不在会议中,调用该接口将返回失败。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
删除与会者 描述 该接口用于删除与会者。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/mmc/control/conferences/attendees/delete 传输协议 HTTPS 请求参数 表2 参数说明
共享工具栏定制 screenShareToolBarItems 接口描述 该接口用于共享工具栏左侧区域按钮的定制。 下图中框选部分按钮最多可定制8个按钮,多余按钮将不会被展示。 图1 共享按钮定制位置 注意事项 传入的按钮如果当前场景不支持或当前角色不支持将不会被展示; 方法定义
修订记录 表1 修订记录 日期 版本 修订内容 2024-01-02 100.12.5 StartP2PConfParam新增是否来宾免密码入会isGuestJoinConfWithoutPwd、允许入会的用户类型confAllowJoinUser,具体请见HWMStartP2PConfParam说明
场景2:登录 描述 可用华为云会议账号或App ID或登录华为云会议。创建会议等接口不支持在未登录状态下调用,若要使用完整的会议功能,必须先登录华为云会议。 在未登录状态下,只能加入已经创建的会议。 业务流程 使用SDK登录时,先调用Login接口,然后处理回调函数OnLoginResult。
场景6: 创建会议 描述 创建会议功能会是指创建一个即时会议并立即加入会议,可以通过传参指定创建音频会议还是视频会议,可以指定会议是否需要密码。 业务流程 准备创建会议参数 准备创建会议参数,类型为CreateConfParam,定义详见CreateConfParam的接口定义,
场景4:编辑会议 描述 预约会议成功后,可以通过编辑会议接口来编辑会议信息,在编辑会议时可以添加与会者。 业务流程 得到会议列表以后,若要编辑会议,需要先通过getConfDetail接口查询会议详情,在接口回调onGetConfDetailResult中处理详情数据,再调用ed
快速入门 在将Electron SDK集成到第三方应用中前,请先按照“跑通Electron Demo”中的指导熟悉Electron客户端中集成华为云会议Electron SDK的基本流程。 将华为云会议Electron SDK集成到第三方的Electron客户端的步骤如下: 下载Electron
场景9:添加与会人 描述 在会议中,可以调用添加与会人的接口把与会人加入到会议中。 业务流程 使用SDK添加与会人时,先调用addAttendee接口,然后处理接口回调函数onAddAttendeeResult。 接口调用 组装数据结构AddAttendeeInfo和接口回调函数
会中邀请他人 会议中主持人和普通与会者可以通过会中邀请弹窗、分享会议详情、呼叫未入会成员的方式邀请他人入会。 注意事项 主持人可以锁定会议,锁定后仅可通过主持人邀请入会,未被邀请人员无法主动入会。 从通讯录邀请会议终端,需要企业管理员先添加会议终端到华为云会议管理平台。 通过会中邀请弹窗邀请与会者
取消会议 cancelConf 接口描述 该接口用于取消未开始的会议。 注意事项 只有主持人可以取消会议 方法定义 1 - (void)cancelConf:(NSString *_Nonnull)confId callback:(_Nonnull HWMSDKCompleteHandler)callback;
获取与会者列表 getAttendeeList 接口描述 该接口用于获取会议中与会者列表。 注意事项 只能在会议中使用 方法定义 1 getAttendeeList(): Array<HWMAttendeeInfoModel>; 参数描述 无 返回值 表1 返回值 类型 描述
常见错误码 表1 SDKError枚举说明 变量 值 描述 UISDK_COMMON_ERROR 430100001 通用错误 UISDK_API_INVALID_PARAMETERS 430100002 参数错误 USG_ERR_PASSWORD 206010000 账号或密码错误
创建会议 CreateConf 接口描述 该接口用于创建即时会议。 注意事项 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。若不需要,与会者信息和与会者个数可以为空。 该接口为
场景5:取消会议 描述 预约会议成功后,可以取消会议接口来取消会议。 业务流程 若要取消会议,可以调用cancelConf接口,并处理回调函数onCancelConfResult和订阅的onConfListChanged通知。。 接口调用 组装数据结构CancelConfPara
修改云会议室信息 changeVmrInfo 接口描述 该接口用于修改云会议室信息。 注意事项 尽量只修改来宾密码 方法定义 1 - (void)changeVmrInfo:(HWMModifyVMRParam *)info callback:(_Nonnull HWMSDKCo