检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式,即单流自动录制,具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶:创建用于存储SparkRTC录制文件的OBS桶,
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable:true
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/rtc/data
配置录制规则 SparkRTC服务支持将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中,您可以在OBS服务中对录制的音视频文件进行下载、分享等处理。相关操作流程,如图1所示。 图1 录制流程图 创建桶:创建用于存储SparkRTC录制文件的OBS桶,若已有OBS桶,请直接执行
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据,快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
常用概念 应用标识 应用标识或应用ID,简称appID,是SparkRTC用来区分不同应用的唯一标识,在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间,同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念,用于用户之间的相互隔离
数据类型 本章节列出了iOS/macOS SDK的所有数据类型,您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
事件回调(IHRTCEngine) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
常见问题 加入房间时,userName必须填吗? 非必填。userName、userId由App自定义,但可以相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线
合流录制 场景说明 将房间中的多路音视频进行云端混流,再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下,支持分屏九宫格模板和共享屏幕模板(主视窗居左/主视窗居右)两种预设合流布局。同时,也支持用户自定义合流布局样式(自定义视频窗格位置)。 九宫格模板 每个用户画面平铺在画布上
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK
通话调查 您可以查看各房间的用户通话质量指标详情,对通话体验和端到端数据进行问题定位和原因分析,有效解决通话质量问题。 注意事项 “通话调查”中的数据仅供数据分析和质量问题查询,计费数据请以账单为准。 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询的时间跨度最长为
事件回调(IHRTCConnection) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调 接口 描述 onError 错误回调。 onWarning 警告回调。 onConnectionChangedNotify 连接状态改变回调
本地流对象(LocalStream) 该对象继承自Stream对象,并有如下新增接口。 表1 LocalStream接口 接口 描述 initialize 本地流初始化。 setAudioProfile 设置音频流配置。 setVideoProfile 设置视频流配置。 setScreenProfile
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流