检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建事件监听对象 接口描述 用于创建事件监听对象。 注意事项 该接口的返回对象可用于监听会议的事件,建议提前创建好并监听 调用on方法监听时,可监听的事件可使用获取事件列表获取 方法定义 1 createEventListener: EventEmitter 参数描述 无。 返回值
场景2:实名入会 描述 如果要实名入会,需要使用App ID鉴权,获取token,然后再调用SDK的joinConf接口,最后,监听join_conf_result事件。 实名入会:先鉴权登录,再加入会议。 匿名入会:不鉴权登录,就加入会议。 joinConf接口中的token字
自定义设置界面 ConfigSettingWindow 接口描述 该接口用于自定义设置界面中各标签页和功能区的显示隐藏,若未进行设置,则默认都显示 图1 设置界面 注意事项 该接口必须在设置界面打开前调用,设置界面打开时调用不会即时生效。 该接口为异步接口,返回值只代表接口是否调
会议信息 通知描述 收到该通知时,表示会议中的信息发生变更。 方法定义 1 virtual void OnConfInfo(HwmConfInfo *confInfo) {}; 注意事项 会议开始后,会议信息会上报多次,不是一次把HwmConfInfo中的信息全部上报上来的。 参数描述
初始化 初始化接口有主线程初始化、子线程初始化两种,必须先调用任意一个初始化接口后再调用其它接口。 initWithConfig 接口描述 用于启动并且初始化SDK。 注意事项 该接口用于启动并初始化SDK,在调用其他接口之前必须先调用初始化接口。 此初始化方法必须在主线程调用。
共享工具栏定制 screenShareToolBarItems 接口描述 该接口用于共享工具栏左侧区域按钮的定制。 下图中框选部分按钮最多可定制8个按钮,多余按钮将不会被展示。 图1 共享按钮定制位置 注意事项 传入的按钮如果当前场景不支持或当前角色不支持将不会被展示; 方法定义
典型场景接口调用概览 2类接口描述 Web SDK的接口分为主动调用接口、消息通知接口。 主动调用接口:用户主动调用SDK的接口,用于完成某项任务。接口调用返回Promise对象,用户可以通过链式调用,得到成功和失败结果。 消息通知接口:由华为云会议服务端触发或SDK内部触发的事
常见错误码 表1 SDKError枚举说明 变量 值 描述 UISDK_COMMON_ERROR 430100001 通用错误 UISDK_API_INVALID_PARAMETERS 430100002 参数错误 USG_ERR_PASSWORD 206010000 账号或密码错误
90.6.5更新内容 1.发起呼叫接口StartCall废弃 2.预约会议参数HwmBookConfParam、编辑会议参数HwmEditConfParam、创会信息HwmCreateConfInfo、会议信息HwmConfInfo、会议列表信息HwmConfListInfo增加
界面配置 Config 接口描述 Windows SDK中已经提供了会议中的界面,界面上的部分元素是可以自定义的。可以自定义的界面元素如下: 会议窗口名称 会议开始后,在Windows任务栏上会生成一个会议的图标,鼠标指向该图标时会显示会议的缩略窗口,该窗口的名称可以自定义。 图1
场景7:加入会议 描述 在华为云会议账号登录后或者登录前,都可以使用该接口通过会议ID和密码加入会议。 业务流程 使用SDK加入已经存在的会议时,先调用joinConfById接口,然后处理接口回调函数onJoinConfByIdResult和订阅的消息通知onConfState
会议结束通知 通知描述 收到该通知时,表示当前会议已结束。 方法定义 1 - (void)onConfEndedNotify:(HWMUISDKConfEndInfoModel *)confEndInfo; 示例代码 - (void)onConfEndedNotify:(HWM
场景2:登录 描述 可用App ID(App ID申请请参考“App ID鉴权介绍”)或华为云会议账号登录华为云会议。创建会议等接口不支持在未登录状态下调用,若要使用完整的会议功能,必须先登录华为云会议。 在未登录状态下,只能加入已经创建的会议。 业务流程 使用SDK登录时,以App
修订记录 表1 修订记录 日期 版本 修订内容 2025-1-2 100.12.5 1. 新增接受会议邀请接口(仅win支持)、拒绝会议邀请接口(仅win支持)。 2. 新增本地录制状态更新通知(仅Mac支持)。 3. 发起立即会议接口新增参数是否来宾免密isGuestJoinC
应用示例 应用场景 本小节介绍WebSocket建链、信息订阅、信息推送以及心跳保持的调用顺序。 业务流程 WebSocket建链、订阅、信息推送的流程图如下: 图1 Websocket消息推送流程图 根据会议ID及主持人密码获取会控Token和建链Websocket所需的服务端
加入会议 joinConf 接口描述 该接口用于通过会议ID和密码加入已经存在的会议。 注意事项 在登录后才可以调用该接口。 方法定义 1 joinConf(joinConfModel: HWMOpenJoinConfByIdParamModel): Promise<HWMJoinConfByIdResult>;
示例3:会议录播 应用场景 介绍会议录播接口调用的整个过程。 业务流程 图1 会议录播流程图 传入预约会议初始化参数,如会议类型,与会者信息,自动开启录制,录播类型等参数。 第三方向网关APIG发起预约会议请求,并传入预约会议初始化参数。 网关APIG接收请求后,向CloudPortal发起预约会议请求。
场景2:登录 描述 可用华为云会议账号或App ID或登录华为云会议。创建会议等接口不支持在未登录状态下调用,若要使用完整的会议功能,必须先登录华为云会议。 在未登录状态下,只能加入已经创建的会议。 业务流程 使用SDK登录时,先调用Login接口,然后处理回调函数OnLoginResult。
功能配置开关 接口功能 该接口用于修改会议相关功能配置开关。注意事项:1、枚举中的功能项均有默认值,若对开关状态不做要求,可以不必调用该接口。 函数原型 enableCapability(capabilityInfo: CapabilityInfo, onEnableCapabilityResult
订阅会议信息通知 接口功能 收到该通知时,表示会议中的信息发生变更。 函数原型 setOnConfInfoNotifyCB(onConfInfoNotify: (confInfo: ConfInfo) => void): void 请求参数 表1 入参说明 参数名称 是否必选 参数类型