检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
房间管理 踢除在线用户 解散房间
数据统计分析 查询房间列表 查询用户列表 查询实时规模 查询实时规模分布 查询实时质量数据 查询实时网络 查询用量 查询历史规模 查询历史质量 查询用户通话指标 查询详情事件接口 查询指定项目用户异常体验事件 查询用户异常体验事件 查询异常事件用户分布
辅流管理 startRemoteAuxiliaryStreamView - (int)startRemoteAuxiliaryStreamView:(HWRtcVideoCanvas *)streamView streamType:(HWRtcStreamType)streamType
辅流管理 startRemoteAuxiliaryStreamView - (int)startRemoteAuxiliaryStreamView:(HWRtcVideoCanvas *)view; 【功能说明】 开启辅流渲染视图(发起辅流选看) 【请求参数】 view: 具体请参见
单流任务管理 启动单流任务 查询单流任务状态 停止单流任务 更新单流任务
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 图1 管理控制台
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。 图1 获取账号ID 父主题: 附录
SDK使用 移动端(Android/iOS)创建一个房间,是否支持PC端(MAC/Windows)接入? iOS平台如何缩减安装包体积? Android平台如何缩减安装包体积? iOS端是否可以监听远端离开房间? 背景音乐是否支持循环播放? SparkRTC是否支持调整背景音乐的播放进度
接收增值(录制)事件回调通知内容 SparkRTC服务回调用户提供的接口时,会附带以下信息。 表1 请求Body参数 参数 是否必选 参数类型 描述 job_id 否 String 任务编号,可以用于修改、查看和停止录制任务 stream_name 否 String 流名 app_id
查询详情事件接口 功能介绍 查询指定APP下通话的异常明细数据。 可查询5天内的数据。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
如何对录制回调进行鉴权? 为保证录制回调通信安全,租户可以配置录制回调参数“回调秘钥”,对录制回调消息进行鉴权。本章节介绍录制回调鉴权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳
合流录制 场景说明 将房间中的多路音视频进行云端混流,再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下,支持分屏九宫格模板和共享屏幕模板(主视窗居左/主视窗居右)两种预设合流布局。同时,也支持用户自定义合流布局样式(自定义视频窗格位置)。 九宫格模板 每个用户画面平铺在画布上
常见问题 加入房间时,userName必须填吗? 非必填。userName、userId由App自定义,但可以相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线
数据类型 本章节列出了iOS/macOS SDK的所有数据类型,您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
数据类型 本章节列出了Android SDK的所有数据类型,您可以结合HRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogInfo 日志信息 HRTCCameraConfig 相机配置 HRTCEncryptionConfig 端到端加密参数 HRTCUserInfo
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR
接口按功能说明 初始化等基础接口 表1 初始化等基础接口 接口 描述 windows是否支持 Mac是否支持 iOS是否支持 Android是否支持 createHRtcEngine 创建IHRTCEngine对象 √ √ √ √ getHRtcEngine 获取创建后的IHRTCEngine
iOS 前提条件 已提交工单获取SDK包。 环境要求 准备XCODE集成开发。 准备iOS 8.0及以上的iPhone真机。 支持的终端CPU架构:arm64,arm32。 SDK集成 解压iOS SDK包。 将iOS SDK包中的HWRTCEngine动态库和RTC.bundle
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
通话中质量监测 功能描述 加入频道后,SDK会每隔2秒自动触发通话质量相关的回调,上报当前本地和远端的音视频统计信息。 接口调用流程 实现通话中质量监测 通话质量上报 onNetworkQualityNotify,房间内客户端网络质量实时上报,默认开启,每2s上报一次,两人以上才会回调