检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设置会议来电应答 SetConfIncomingAnswerResult 接口描述 该接口用于收到会议来电时设置应答。一般用于设置会议来电的自动拒绝或者自动接听。 注意事项 只有在收到会议来电后才能调用该接口(在通知接口OnConfIncoming中调用),其他情况不应调用该接口。
设置日志保存路径 SetLogPath 接口描述 该接口用于设置日志保存路径。 注意事项 该接口非必需调用,若不设置,则使用默认路径。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 HWM_SDK_AGENT_API hwmsdk
ACCESS_TYPE_INNER 1 公司内网接入, 用于媒体和信令下沉场景,app从内网接入,信令/媒体消息走代理服务器才能访问云会议服务端 ACCESS_TYPE_OUTER 2 公司外网接入, 用于非媒体和信令下沉场景,互联网接入,信令/媒体消息可以直接访问云会议服务端 表
AppId登录 接口功能 该接口用于AppId登录。注意事项:1、创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 函数原型 loginByAppId(appIdAuthInfo: AppIdAuthInfo, onLoginResult?: (ret
编辑周期会议 modifyCycleConf 接口描述 该接口用于编辑周期会议。 注意事项 该接口在已登录状态下才能调用。 方法定义 1 modifyCycleConf(modifyCycleConfParam: HWMOpenModifyCycleConfParamModel):
设置代理信息 接口功能 设置代理信息 函数原型 setProxy(proxyInfo: ProxyInfo, onSetProxyResult?: (ret: SDKERR, reason: string) => void): void 请求参数 表1 入参说明 参数名称 是否必选
设置证书校验信息 setCaVerifyParam: 接口描述 该接口用于设置证书校验信息。 注意事项 该接口非必需调用,若不设置,则默认不开启证书校验。 方法定义 1 + (HWMSDKERR)setCaVerifyParam:(HWMCaVerifyParam *)param;
场景3:视图界面定制 描述 考虑到大部分使用SDK二次开发的场景下,视图可能有不同要求,SDK提供与会者窗口、聊天窗口、会控条、标题、弹幕等组件的显示与隐藏,通过setViewConfig接口可以个性化设置,通过getViewConfig接口,可以获取实时信息; 业务流程 本流程以设置聊天窗口显示
设置视图显示 注意事项 请在调用加入会议接口后再调用此接口。 接口描述 Web SDK中已经提供了会议中的界面,界面上的部分元素是否显示通过该接口配置。 图1 会议窗口的显示控制 如图上图所示,当前SDK支持的窗口显示控制包含: 1. 窗口标题栏 2. 聊天框 3. 与会者列表 4
显示会议主窗口 showMeetingWindow 接口描述 当会议主窗口处于最小化或者被其他窗口覆盖时,使用该接口将会议主窗口拉到最上层。一般用于从会议列表中拉起正在进行的会议窗口。 注意事项 无 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
编辑周期子会议 editSubCycleConf 接口描述 该接口用于编辑周期子会议。 注意事项 该接口在已登录状态下才能调用。 方法定义 1 - (void)editSubCycleConf:(HWMSDKModifySubCycleConfParamModel *_Nonnull
编辑周期子会议 接口描述 该接口用于编辑会议。 注意事项 会议未开始前可以调用接口,开始后调用则无效。 所有字段必填,编辑修改的字段可来源于用户输入,其他不想修改的属性一定要取会议详情对应字段来赋值。 方法定义 1 2 3 4 5 6 /** * 编辑周期子会议
取消周期子会议 接口描述 该接口用于取消未开始的周期子会议。 注意事项 周期子会议未开始前可以调用接口,开始后调用则无效。 方法定义 1 2 3 4 5 6 7 8 /** * 取消周期会议 * * @param cycleConfId 周期会议
取消周期会议 CancelCycleConf 接口描述 该接口用于取消至少还有一场子会议未开始的周期会议。 注意事项 该接口在登录状态下才能调用。 最后一场子会议未开始前可以调用接口,开始后调用则无效。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回
创建事件监听对象 接口描述 用于创建事件监听对象。 注意事项 该接口的返回对象可用于监听会议的事件,建议提前创建好并监听 调用on方法监听时,可监听的事件可使用获取事件列表获取 方法定义 1 createEventListener: EventEmitter 参数描述 无。 返回值
WebSocket心跳 描述 通过此接口,对已建立WebSocket消息通道保活。会议服务端如果180s内未收到心跳请求,则会关闭websocket链接。建议每一分钟发送一次。 表1 WebSocket心跳请求 参数 类型 描述 action String "HeartBeat"
API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
配置Ability事件 abilityEnterForeground 接口描述 该接口用于设置Ability切前台事件。 方法定义 abilityEnterForeground(context: Context): void; 参数描述 表1 参数说明 参数 是否必须 类型 描述
场景8:添加与会者 描述 在会议中,可以调用添加与会者的接口把用户加入到会议中。 业务流程 使用SDK添加与会者时,先调用addAttendee接口,然后处理返回结果。 接口调用 组装数据结构Array<HWMOpenAttendeeBaseInfoModel>。 调用addAttendee
预约周期会议 bookCycleConf 接口描述 该接口用于预约周期会议。 注意事项 该接口在已登录状态下才能调用。 会议开始时间必须晚于当前时间,会议时长应大于15分钟。 携带与会者入会的时候需要传入attendees。 周期会议最大跨度一年,会议数量不超过50,超过则只预约前