检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建会议 CreateConf 接口描述 该接口用于创建即时会议。 注意事项 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。若不需要,与会者信息和与会者个数可以为空。 该接口为
查询与会者的QoS数据 描述 该接口用于查询企业内在线会议或历史会议的与会者QoS数据。仅旗舰版企业的企业管理员有权限查询。 仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员,并提供华为云会议企业ID。 调试 您可以在API Explorer中调试该接口。 接口原型 表1
App ID方式登录 1 HWMSdk.getOpenApi.loginByAppId(AppIdAuthParam,HwmCallback) 接口描述 该接口用于通过App ID的方式登录和鉴权。 注意事项 除匿名入会外,在使用其他业务之前必须进行成功登录。 登录成功以后会发送登录成功事件onSuccess回调。
发起投屏 StartProjection 接口描述 该接口用于发起投屏。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
刷新Token 描述 该接口提供刷新Token功能,根据传入的Token,刷新Token失效时间并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/token 传输协议 HTTPS 请求参数
场景3:预约会议 描述 登录后,可以调用接口预约会议。 业务流程 使用SDK预约会议时,先调用bookConf接口,然后处理回调callback。 接口调用 调用bookConf预约会议。 处理回调 处理回调callback。 示例代码 1 2 3 4 5 6 7
开启第三方视频推流配置 在OpenSDKConfig中配置视频流的第三方采集,sdk自身不再采集视频流 共有三个回调方法 onSetLocalVideoMirrorTypeNotify:会议开始时回调,用户可以在此设置镜像 onStartPushExternalVideoFram
会议状态变更通知 在OpenSDKConfig中配置会议UI页面变更相关的通知监听 入会的时候UI创建,离会的时候销毁UI 使用场景 入会场景:onConfDetailNotify 离会场景:onConfEnded、onLeaveConf 弱网提示:onPoorNetworkQualityInfoNotify
场景3:预约会议 描述 登录后,可以调用接口预约会议。 业务流程 使用SDK预约会议时,先调用bookConf接口,然后处理回调callback。 接口调用 调用bookConf预约会议。 处理回调 处理回调callback。 示例代码 1 2 3 4 5 6 7
场景12:退出 描述 在第三方APP退出时,需要去初始化SDK,否则名称为HwmSdk.exe的进程(Electron SDK的windows 64位下的主进程)一直在后台运行,仅针对windows 64位平台。 业务流程 需要退出SDK时,调用Exit同步接口。 接口调用 调用Exit退出SDK。
SP管理员创建企业 描述 创建企业、默认管理员及分配资源。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/usg/dcs/sp/corp 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须 类型 位置
快速操作CloudLink Box/Bar 熟悉操作界面和唤醒终端 您可以使用Touch对CloudLink Box/Bar进行操控。 Touch连通电源后,将自动开机。 如果终端已休眠,滑动Touch界面即可唤醒。 如果终端已开启了语音助手,您也可以通过语音助手唤醒,例如“小微、小微”
登录 登录分为账号密码鉴权登录和App ID鉴权登录。 login:password: 接口描述 该接口用于通过账号密码鉴权登录。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 回调error表示错误信息,nil表示成功。 方法定义 1
取消周期会议 接口描述 该接口用于取消未开始的周期会议。 注意事项 周期会议未全部结束前可以调用接口,结束后调用则无效。 方法定义 1 2 3 4 5 6 7 /** * 取消周期会议 * * @param cycleConfId 周期会议Id
创建会议 createConf 接口描述 该接口用于创建即时会议。 注意事项 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。 开启自动录制会议时必须开启录制会议。 创会结果在callback中返回。
场景3: App ID方式登录 描述 在使用云会议服务之前,如果申请了App ID,可使用App ID的方式进行登录,不需要账号和密码 在未登录状态下,只能加入已经创建的会议。 业务流程 接口调用 创建登录参数AppIdAuthParam。 设置第三方账号的唯一标识。 设置随机字符串。
发起投屏 startProjectionWithParam 接口描述 该接口用于发起投屏。 注意事项 该接口在已登录状态下才能调用。 实际业务处理结果在对应的callback中返回。 方法定义 1 - (void)startProjectionWithParam:(HWMUISD
执行鉴权 描述 该接口使用华为云会议账号和密码鉴权,鉴权通过后生成一个Access Token。 当clientType取值为72时,同一个account,同时最多能创建64个Token。比如已经创建了64个Token,并且Token都在有效期内,再用同一个account创建一个
场景5:创建会议 描述 登录后,可以调用创建会议接口创建立即会议。创建会议时可以携带与会人信息,也可以不携带。 在登录状态下,才能创建会议。 业务流程 使用SDK创建立即会议时,先调用CreateConf接口,然后处理回调callback。 接口调用 组装模型HWMCreateConfParam。
常见错误码 表1 SDKError枚举说明 变量 值 描述 UISDK_COMMON_ERROR 430100001 通用错误 UISDK_API_INVALID_PARAMETERS 430100002 参数错误 USG_ERR_PASSWORD 206010000 账号或密码错误