检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取VMR列表 GetVmrList 接口描述 该接口用于获取VMR列表。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
上传个人头像 1 HWMBizSdk.getBizOpenApi().uploadSelfAvatar(String path, HwmCallback<Void> hwmCallback) 接口描述 该接口用于上传当前自己的头像到会议服务器的通讯录 注意事项 1. 请在已登录状态下调用
会议详情通知 通知描述 收到该通知时,会中时会收到会议详情通知,可用于做会中分享等。 方法定义 1 - (void)onConfDetailNotify:(HWMConfDetail *)confDetail; 注意事项 SDK初始化时设置globalHandler代理对象或者在需要处理的界面设置代理对象
获取用户状态 getUserState 接口描述 该接口用于获取用户当前的状态(是否在会议中)。 注意事项 无 方法定义 - (HWMUserState)getUserState; 参数描述 表1 枚举HWMUserState说明 参数 值 描述 HWMUserStateIdle
设置用户文件保存路径 SetUserSavePath 接口描述 该接口用于设置用户文件(包括本地录制文件)的保存路径。 注意事项 该接口非必需调用,若不设置,则使用默认路径。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API
获取用户状态 getIsInConfOrCall: 接口描述 该接口用于获取用户当前的状态(是否在会议中)。 注意事项 无 方法定义 1 - (HWMSDKConfOrCallStatus)getIsInConfOrCall; 参数描述 表1 参数说明 枚举值 描述 HWMSDKConfOrCallStatusIdle
底部工具栏定制 meetingToolBarItemsForScene 接口描述 该接口用于构建底部toolbar的会控全量菜单。 下图中1区域内支持调整按钮展示顺序或者隐藏按钮。 下图中2区域支持最多8个按钮,多余按钮将不会展示。 下图中3区域按钮仅支持隐藏/显示。 图1 视频会议会控菜单定制位置
邀请结果信息推送 该事件可以通知邀请会场的结果事件,或者会场离会的原因事件。 表1 邀请终端结果推送消息帧 参数 类型 描述 action String "InviteResultNotify" version Long 全量消息为:消息生成时的时间戳(毫秒)。 增量消息为:递增序列号
订阅会议来电通知 接口功能 收到该通知时,表示收到会议来电。 函数原型 setOnConfIncomingNotifyCB(onConfIncomingNotify: (confIncomingInfo: ConfIncomingInfo) => void): void 请求参数
取消周期会议 接口功能 该接口用于取消至少还有一场子会议未开始的周期会议。注意事项:1、该接口在登录状态下才能调用。2、最后一场子会议未开始前可以调用接口,开始后调用则无效。 3、该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 函数原型 cancelCycleConf
订阅登录错误通知 接口功能 收到该通知时,表示登录失败。 函数原型 setOnLoginErrorNotifyCB(onLoginErrorNotify: (ret: SDKERR, reason: string) => void): void 请求参数 表1 入参说明 参数名称
获取主窗口信息 getMainWindowInfo 接口描述 该接口用于获取主窗口信息。 方法定义 1 - (HWMUISDKMainWindowInfoModel *)getMainWindowInfo; 参数描述 无 返回值 表1 HWMUISDKMainWindowInfoModel
编辑周期子会议 接口功能 该接口用于编辑周期子会议。注意事项:1、该接口在已登录状态下才能调用。2、该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 函数原型 modifySubCycleConf(modifySubCycleConfParam
设置语言 接口功能 该接口用于设置语言,默认是中文。注意事项:1、实现自定义语言,windows平台要求在 \HwmSdk\sdkResources\language\ 目录下创建对应的国际化文件,如新增阿拉伯语则可以创建 \ar\temp.js;mac平台要求在 /HWMUISDK.framework
设置证书校验信息 接口功能 设置证书校验信息 函数原型 setCAVerifyInfo(CAVerifyInfo: CAVerifyInfo, onSetCAVerifyInfoResult?: (ret: SDKERR, reason: string) => void): void
设置自定义按钮 接口描述 调用此接口,可以自定义会中按钮。 注意事项 1)该接口需在收到入会结果通知事件后才能成功调用。 方法定义 setCustomerButton(customerButtonObj[])::Promise<Result> 参数描述 表1 参数说明 参数 是否必须
发起立即会议 startP2PConf 接口描述 该接口用于发起立即会议。 注意事项 1. 实际业务处理结果在对应的callback回调中。 方法定义 - (void)startP2PConf:(HWMUISDKStartCallInfoModel *)param callback
删除个人头像 DeleteSelfAvatar 接口描述 该接口用于删除自定义的通讯录头像。 注意事项 请在已登录状态下调用。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode DeleteSelfAvatar(); 回调函数 1 virtual
API时,如果遇到“WSS”开头的错误码,请参考华为云API错误中心。
accountId N string 华为云会议账号 email N string 电子邮箱地址,用于发送邮件通知。 sms N string 短信通知手机号码,用于发送短信通知。 isAutoInvite N boolean 是否自动外邀。