检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
典型场景接口调用概览 2类接口描述 Web SDK的接口分为主动调用接口、消息通知接口。 主动调用接口:用户主动调用SDK的接口,用于完成某项任务。接口调用返回Promise对象,用户可以通过链式调用,得到成功和失败结果。 消息通知接口:由华为云会议服务端触发或SDK内部触发的事
当需要退出当前的华为云会议账号的登录时,可以调用该接口完成已登录华为云账号退出。 业务流程 使用SDK退出登录时,先调用Logout接口,然后处理回调函数OnLogoutResult。 接口调用 调用Logout进行退出登录。 处理回调函数 处理回调函数OnLogoutResult。 示例代码
显示设置窗口 ShowSettingWindow 接口描述 该接口显示设置窗口,会前会中都可以调用。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
当需要退出当前的华为云会议账号的登录时,可以调用该接口完成已登录华为云账号退出。 业务流程 使用SDK退出登录时,先调用logout接口,然后处理接口回调函数onLogoutResult。 接口调用 组装接口回调函数onLogoutResult。 调用Logout进行退出登录,第1步中的数据作为参数。
DisableVoicePrompts 接口描述 禁用提示音。 注意事项 该接口非必需调用,如不调用,则默认播放会中提示音。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
描述 在会议中,可以调用添加与会人的接口把与会人加入到会议中。 业务流程 使用SDK添加与会人时,先调用addAttendee接口,然后处理接口回调函数onAddAttendeeResult。 接口调用 组装数据结构AddAttendeeInfo和接口回调函数onAddAttendeeResult。
场景9:添加与会人 描述 在会议中,可以调用添加与会人的接口把与会人加入到会议中。 业务流程 使用SDK添加与会人时,先调用AddAttendee接口,然后处理回调函数OnAddAttendeeResult。 接口调用 组装数据结构HwmConfAttendee。 调用AddAttendee开始创建,第1步中的数据作为参数。
该接口清除所有会议界面相关的配置,恢复默认状态。 注意事项 有调用Config接口并且希望清除Config接口所做的配置时,才需要调用该接口。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
用于退出SDK。 注意事项 该接口用于退出SDK,调用该接口之后SDK不可使用。 应用退出时请调用该接口,若不调用该接口,则SDK无法退出,应用退出后SDK进程将继续存在。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API
SetProxyInfo 接口描述 该接口用于设置代理信息。 注意事项 该接口非必需调用,若不设置,则默认不使用代理。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
预约会议成功后,可以取消会议接口来取消会议。 业务流程 若要取消会议,可以调用CancelConf接口,并处理回调函数OnCancelConfResult和消息通知OnConfList。 接口调用 调用CancelConf取消会议。 处理回调函数 处理回调函数OnCancelConfResult。 处理消息通知
LeaveConf 接口描述 该接口用于离开会议。 注意事项 不在会议中不应调用此接口。 调用该接口离开会议,会议不会结束,在会议存在期间可以再次入会。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
该接口用于获取会议中各会场混音后的音频数据流。只支持32位库。 注意事项 该接口为异步接口,回调函数返回值只代表接口是否调用成功,实际业务处理结果在对应的通知函数中返回。 在进入会议前就可以调用此接口,创建或加入会议后就会有通知。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
SetCAVerifyInfo 接口描述 该接口用于设置证书校验信息。 注意事项 该接口非必需调用,若不设置,则默认不开启证书校验。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
若要取消会议,可以调用cancelConf接口,并处理回调函数onCancelConfResult和订阅的onConfListChanged通知。。 接口调用 组装数据结构CancelConfParam和接口回调函数onCancelConfResult。 调用cancelConf取消会议,第1步中的数据作为参数。
SetLogPath 接口描述 该接口用于设置日志保存路径。 注意事项 该接口非必需调用,若不设置,则使用默认路径。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
AddAttendee 接口描述 该接口用于在会议中添加与会者。 注意事项 不在会议中,调用该接口将返回失败。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
SetServerAddress 接口描述 该接口用于设置登录服务器信息。 注意事项 该接口非必需调用,若不设置,则使用默认登录服务器地址和端口。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
接口描述 该接口用于取消未开始的周期子会议。 注意事项 该接口在登录状态下才能调用。 子会议未开始前可以调用接口,开始后调用则无效。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
EndConf 接口描述 该接口用于结束会议。 注意事项 不在会议中不应调用此接口。 调用该接口,会议将结束,无法再次加入该会议。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode