检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开发前准备 前提条件 已提交工单获取SDK包。 环境要求 OHOS SDK需要集成到APP工程中,建议您在如下推荐环境中进行集成开发。 准备DevEco,推荐使用4.0.0(10) SDK及以上。 准备Android运行环境:API 21、Android 5.0以上设备。 支持的终端
事件回调(HWRtcEngine) 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
查询异常事件用户分布 功能介绍 查询指定APP下指定时间内的通话异常明细数据分布情况。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0:成功。 > 0:方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享,若需开启多辅流,请提交工单联系技术支持处理
查询实时规模分布 功能介绍 对规模相关的数据,根据指定维度按在线用户数排名,获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable:true
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式,即单流自动录制,具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶:创建用于存储SparkRTC录制文件的OBS桶,
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/rtc/data
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据,快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
常用概念 应用标识 应用标识或应用ID,简称appID,是SparkRTC用来区分不同应用的唯一标识,在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间,同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念,用于用户之间的相互隔离
配置录制规则 SparkRTC服务支持将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中,您可以在OBS服务中对录制的音视频文件进行下载、分享等处理。相关操作流程,如图1所示。 图1 录制流程图 创建桶:创建用于存储SparkRTC录制文件的OBS桶,若已有OBS桶,请直接执行
主入口(HRTC) 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知: 如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司(以下简称“我们”或“华为云”)面向华为云客户提供,方便用户接入实时音视频。华为云客户根据开发文档和用户指南,在其应用中集成SparkRTC SDK后,我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
事件回调(IHRTCEngine) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
合流录制 场景说明 将房间中的多路音视频进行云端混流,再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下,支持分屏九宫格模板和共享屏幕模板(主视窗居左/主视窗居右)两种预设合流布局。同时,也支持用户自定义合流布局样式(自定义视频窗格位置)。 九宫格模板 每个用户画面平铺在画布上
常见问题 加入房间时,userName必须填吗? 非必填。userName、userId由App自定义,但可以相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:YES表示开启,NO表示关闭。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。具体请参见
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
事件回调(IHRTCConnection) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调 接口 描述 onError 错误回调。 onWarning 警告回调。 onConnectionChangedNotify 连接状态改变回调