检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
界面配置管理对象 界面配置管理对象 订阅注入点击通知 订阅与会者列表子项注入点击通知 订阅全部呼叫注入点击通知 订阅窗口句柄通知 订阅查询外部通讯录头像通知 界面配置 自定义会中水印 获取窗口句柄列表 显示会议窗口 设置头像 自定义会议窗口任务栏图标 显示设置窗口接口 显示提示信息
创建事件监听对象 接口描述 用于创建事件监听对象。 注意事项 该接口的返回对象可用于监听会议的事件,建议提前创建好并监听 调用on方法监听时,可监听的事件可使用获取事件列表获取 方法定义 1 createEventListener: EventEmitter 参数描述 无。 返回值
获取登录服务对象 接口功能 获取登录服务对象 函数原型 getLoginApi(): ILogin 返回值 ILogin 父主题: UISDK接口管理对象
会议管理对象 会议管理对象 订阅会议来电通知 订阅会议列表通知 预定会议 取消会议 编辑会议 获取VMR列表 获取会议详情 修改云会议室信息 获取会议列表 预约周期会议 编辑周期会议 编辑周期子会议 取消周期会议 取消周期子会议 父主题: 接口参考
获取会议控制服务对象 接口功能 获取会议控制服务对象 函数原型 getConfCtrlApi(): IConfCtrl 返回值 IConfCtrl 父主题: UISDK接口管理对象
获取会议管理服务对象 接口功能 获取会议管理服务对象 函数原型 getConfMgrApi(): IConfMgr 返回值 IConfMgr 父主题: UISDK接口管理对象
登录管理对象 登录管理对象 订阅登录被踢通知 订阅企业配置通知 订阅登录错误通知 订阅共享vmr信息通知 账号密码登录 AppId登录 SSO登录 退出登录 设置网络模式 上传头像 设置(会控)保底ip地址 设置登录服务器信息 设置代理信息 设置证书校验信息 父主题: 接口参考
会议控制操作对象 会议控制操作对象 订阅会议状态通知 订阅会议结束通知 订阅立即会议记录回调 订阅会议信息通知 订阅共享状态通知 订阅个人角色变化通知 订阅弱网提示通知 订阅会中信息更新通知 订阅添加与会者结果通知 订阅本地录制状态通知 创建会议 发起立即会议 加入会议 Random
获取配置服务对象 接口功能 获取配置服务对象 函数原型 getConfigApi(): IConfig 返回值 IConfig 父主题: UISDK接口管理对象
通用配置管理对象 通用配置管理对象 订阅上报音频码流帧数据通知 订阅用户数据路径变化通知 功能配置开关 设置语言 设置用户保存路径 获取用户保存路径 设置开启或关闭音频码流 设置来电应答方式 会议来电时设备开关配置 获取会议pstn接入号码 禁用提示音 设置共享权限 设置日志保存路径
获取界面配置服务对象 接口功能 获取界面配置服务对象 函数原型 getUIConfigApi(): IUIConfig 返回值 IUIConfig 父主题: UISDK接口管理对象
账号相关名词 华为云账号 华为云上的租户身份标志,用于在华为云上购买华为云会议服务,或者使用华为云提供的工具(如API Explorer等)。账号鉴权在华为云的IAM上完成。 华为云会议账号 华为云会议上的用户身份标志。账号鉴权在华为云会议的USG上完成。
租户:负责云服务内部的安全,安全地使用云。
UISDK接口管理对象 UISDK接口管理对象 初始化 退出 获取登录服务对象 获取会议控制服务对象 获取会议管理服务对象 获取配置服务对象 获取界面配置服务对象 订阅连接断开通知 父主题: 接口参考
SSO登录 接口功能 该接口用于SSO登录。注意事项:1、创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 函数原型 loginBySSO(ssoAuthInfo: SSOAuthInfo, onLoginResult?: (ret: SDKERR,
多租户场景下,按SP注册回调时需要填写。 subscriberId 是 String Body 订阅者ID subscriberKey 是 String Body 订阅者秘钥 url 是 String Body 订阅url。 说明: 必须使用HTTPS。
多租户场景下,按SP注册回调时需要填写。 状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。
编辑会议 接口功能 该接口用于编辑已预约的会议。注意事项:1、该接口在已登录状态下才能调用;2、调用该接口时,仅能编辑尚未开始的会议,若会议已召开,接口将返回失败;3、所有字段必填,编辑会议前需要查询会议详情,不需要变更的数据请使用查询会议详情返回的数据赋值。 函数原型 editConf
退出登录 接口功能 该接口用于退出已登录的华为云会议账号。注意事项:1、请在已登录的场景下调用。 函数原型 logout(onLogoutResult?: (ret: SDKERR, reason: string, logoutResult: LogoutResult) => void
取消会议 接口功能 该接口用于取消已预约的会议。注意事项:1、该接口在登录状态下才能调用;2、调用该接口时,仅能取消尚未开始的会议,若会议已召开,则接口返回失败。 函数原型 cancelConf(cancelConfParam: CancelConfParam, onCancelConfResult