检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK概述 华为云会议服务为开发者提供Windows、Android、iOS、Mac、Electron、HarmonyOS、Web的客户端SDK,方便开发者将华为云会议的音频会议、视频会议、桌面共享能力快速集成到自己的应用中。 华为云会议的客户端SDK已经实现了会议中UI界面,包
获取配置服务对象 接口功能 获取配置服务对象 函数原型 getConfigApi(): IConfig 返回值 IConfig 父主题: UISDK接口管理对象
获取会议管理服务对象 接口功能 获取会议管理服务对象 函数原型 getConfMgrApi(): IConfMgr 返回值 IConfMgr 父主题: UISDK接口管理对象
创建事件监听对象 接口描述 用于创建事件监听对象。 注意事项 该接口的返回对象可用于监听会议的事件,建议提前创建好并监听 调用on方法监听时,可监听的事件可使用获取事件列表获取 方法定义 1 createEventListener: EventEmitter 参数描述 无。 返回值
终端Scheme应用集成概述 在已经安装华为云会议App的前提下,第三方Web应用或者第三方App,按照华为云会议App定义的URL Protocol,可以: 启动华为云会议App后进入待登录界面 启动华为云会议App并完成登录后进入主界面 以华为云会议App当前登录的账号(或者匿名)加入会议
UISDK接口管理对象 UISDK接口管理对象 初始化 退出 获取登录服务对象 获取会议控制服务对象 获取会议管理服务对象 获取配置服务对象 获取界面配置服务对象 订阅连接断开通知 父主题: 接口参考
DK,当前运行环境支持见9.1概述-表1 环境要求。 方法定义 1 checkSystemRequirements():Promise<Result> 参数描述 无。 返回值 Result的结构参考9.7.1返回结构参考-表1 Result 对象参数说明, Result中具体data说明见下表
退出登录 接口功能 该接口用于退出已登录的华为云会议账号。注意事项:1、请在已登录的场景下调用。 函数原型 logout(onLogoutResult?: (ret: SDKERR, reason: string, logoutResult: LogoutResult) => void):
会议详情中vmrConfId为空,填入HWM_VMR_CONF_ID_TYPE_RANDOM guestPwd N string 来宾密码,如果空则服务器随机生成(仅对随机会议ID生效)。 isOpenWaitingRoom N boolean 等候室开启开关。 说明:需要等候室功能开通后才能生效
code Y string 授权码 domain Y string 企业域名 authServerType Y AuthServerType 鉴权服务类型 表3 AuthServerType枚举说明 枚举名称 枚举值 枚举说明 AUTH_SERVER_TYPE_OAUTH2 0 单点登录
上传头像 接口功能 该接口用于上传当前自己的头像到会议服务器的通讯录。注意事项:1、请在已登录状态下调用;2、上传的图片文件格式仅支持jpg/png格式,大小需要限制在200KB以下;3、为了头像展示效果,建议图片宽高比为1:1 函数原型 uploadSelfAvatar(selfAvatarInfo:
入参说明 参数名称 参数类型 参数说明 ret SDKERR 请参考错误码参考 错误码 reason string 错误描述 父主题: 登录管理对象
用于媒体和信令下沉场景,app从内网接入,信令/媒体消息走代理服务器才能访问云会议服务端 ACCESS_TYPE_OUTER 2 公司外网接入, 用于非媒体和信令下沉场景,互联网接入,信令/媒体消息可以直接访问云会议服务端 表4 NetConnectType枚举说明 枚举名称 枚举值
致) signature Y string 从第三方服务端获取的鉴权签名 nonce Y string 从第三方服务端获取的Nonce值,用于华为云服务端验证鉴权签名有效性 expireTime Y number 从第三方服务端获取的鉴权签名有效期的时间戳(s),0表示永不超时 userEmail
会议详情中vmrConfId为空,填入HWM_VMR_CONF_ID_TYPE_RANDOM guestPwd N string 来宾密码,如果空则服务器随机生成(仅对随机会议ID生效)。 isOpenWaitingRoom N boolean 等候室开启开关。 说明:需要等候室功能开通后才能生效
3、mac请在杀进程场景调用。 函数原型 exit(): SDKERR 返回值 SDKERR请参考错误码参考 父主题: UISDK接口管理对象
参数名称 参数类型 参数说明 ret SDKERR 请参考错误码参考 错误码 reason string 错误描述 父主题: 会议控制操作对象
会议详情中vmrConfId为空,填入HWM_VMR_CONF_ID_TYPE_RANDOM guestPwd N string 来宾密码,如果空则服务器随机生成(仅对随机会议ID生效)。 isOpenWaitingRoom N boolean 等候室开启开关。 说明:需要等候室功能开通后才能生效
参数名称 参数类型 参数说明 ret SDKERR 请参考错误码参考 错误码 reason string 错误描述 父主题: 会议控制操作对象
入参说明 参数名称 参数类型 参数说明 ret SDKERR 请参考错误码参考 错误码 reason string 错误描述 父主题: 会议管理对象