检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
显示会议主窗口 showMeetingWindow 接口描述 当会议主窗口处于最小化或者被其他窗口覆盖时,使用该接口将会议主窗口拉到最上层。一般用于从会议列表中拉起正在进行的会议窗口。 注意事项 无 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
开启共享 StartShare 接口描述 该接口用于开启会议共享。SDK的UI已经实现了“共享”功能,如果第三方App不需要通过程序控制开启共享,则不用调用该接口。 注意事项 不在会议中调用该接口将返回失败。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
WebSocket建链 描述 通过此接口,完成与会议服务器端会控WebSocket通道的建立。请求前缀通过会议控制中获取会控Token的接口可获取建链地址(wsURL)。请求鉴权处理失败时,会议服务器端会主动关闭WebSocket通道。 该Websocket的连接在会议结束后服务端会主动拆除。
底部工具栏定制 meetingToolBarItemsForScene 接口描述 该接口用于构建底部toolbar的会控全量菜单。 下图中1区域内支持调整按钮展示顺序或者隐藏按钮。 下图中2区域支持最多8个按钮,多余按钮将不会展示。 下图中3区域按钮仅支持隐藏/显示。 图1 视频会议会控菜单定制位置
修改云会议室信息 ChangeVmrInfo 接口描述 该接口用于修改云会议室信息。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 所有字段必填,调用该接口前需要获取VMR列表,不需要变更的数据
设置共享音频 SetShareAudio 接口描述 该接口用于设置共享时是否包含电脑声音开关。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode SetShareAudio(bool
退出登录 1 HWMSdk.getOpenApi.logout(HwmCallback<LogoutResult> hwmCallback) 接口描述 该接口用于退出已登录的账号。 注意事项 请在已登录状态下调用。 方法定义 1 2 3 4 5 /** * 退出登录接口
获取会议列表 接口描述 该接口用于获取会议列表。 注意事项 已登录状态,首次收到会议列表通知之后,调用才有效,否则返回为空的列表。 方法定义 1 2 3 4 5 /** * 获取会议列表 * @return */ List<ConfBaseInfo>
返回结构参考 表1 Result 对象参数说明 key 类型 描述 retCode string 返回码 retMsg string 返回消息 data object 具体返回的对象,详见各个函数返回值的参数描述 表2 通知对象参数说明 key 类型 描述 retCode string
等候室成员列表信息 描述 推送等候室成员列表信息。 参数 类型 描述 action String "WaitingListNotify" version Long 全量消息为:消息生成时的时间戳(毫秒)。 增量消息为:递增序列号。 createTime Long 消息生成时的时间戳(毫秒)。
登录异常通知 通知描述 收到该通知时,表示登录失败,但是非上述登录失败的场景。 方法定义 1 onLoginInvalidNotify?: (result: SDKERR, reasonDesc: string) => void; 注意事项 无。 参数描述 参数 类型 描述 result
获取与会者列表 getAttendeeList 接口描述 该接口用于获取会议中与会者列表。 注意事项 只能在会议中使用 方法定义 1 getAttendeeList(): Array<HWMAttendeeInfoModel>; 参数描述 无 返回值 表1 返回值 类型 描述
获取观众列表 GetAudienceList 接口描述 该接口用于获取会议中观众列表。 注意事项 只能在会议中使用 观众身份(可以通过会议详情消息推送获取)不能使用此接口 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetAudienceList();
删除个人头像 DeleteSelfAvatar 接口描述 该接口用于删除自定义的通讯录头像。 注意事项 请在已登录状态下调用。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode DeleteSelfAvatar(); 回调函数 1 virtual
会议结束通知 通知描述 收到该通知时,表示当前会议已结束。 方法定义 1 onConfEndedNotify?: (result: SDKERR, reasonDesc: string, confEndInfo: HWMConfEndInfoModel) => void; 注意事项
自定义指定场景图标 SetCustomUIImage 接口描述 该接口用于自定义指定场景图标。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
场景6:创建会议 描述 在使用华为云会议账号登录后,可以调用创建会议接口创建立即会议。创建会议时可以携带与会人信息,也可以不携带。 业务流程 若要创建个人会议ID的会议或者云会议室的会议,则需要先调用GetVmrList接口查询个人会议ID和云会议室信息,然后处理回调函数OnGe
获取与会者列表 getAttendeeList 接口描述 该接口用于获取会议中与会者列表。 注意事项 只能在会议中使用 方法定义 1 - (NSArray <HWMAttendeeInfo *> *)getAttendeeList; 参数描述 HWMAttendeeInfo参数说明
场景8: 退出登录 描述 在使用过程中,可以调用该接口完成已登录账号退出。 业务流程 接口调用 调用logout接口进行退出登录。 处理回调 处理回调中的结果。 示例代码 1 2 3 4 5 6 7 8 9 10 HWMSdk.getOpenApi(getActivity())
设置共享策略 SetShareStrategy 接口描述 该接口用于设置屏幕共享的策略是清晰度优先还是流畅度优先。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode