检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务端错误码 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要APP干预或进行用户提示。该错误码由服务端产生,通过onError返回。 表1 服务端错误码 错误码 描述 错误原因 RTC.10000001 内部错误 程序或环境问题 RTC.31000000 节点不存在
查询用量 功能介绍 查询过去的某一时间段内各种业务的用量数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/history
查询实时网络 功能介绍 获取实时网络数据相关指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{
查询实时质量数据 功能介绍 获取实时质量数据的相关指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1
示例2:创建合流录制任务 场景描述 示例1:创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件,您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点
查询指定项目用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。可查询5天内的数据。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
屏幕共享 功能描述 基于苹果的Replaykit方案,支持用户分享整个系统的屏幕内容,但需要App额外提供一个Extension扩展组件,可实现跨应用屏幕共享。 创建App Group 由于华为云SparkRTC是通过App Goup进行进程间的数据通信的,所以需要创建一个App
自定义视频采集和渲染 setExternalVideoFrameOutputEnable public abstract int setExternalVideoFrameOutputEnable(boolean localEnable,boolean remoteEnable);
房间功能 joinRoom - (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam; 【功能说明】 加入房间。该方法让用户加入通话房间。如果已在通话中,用户必须调用leaveRoom退出当前通话,才能进入下一个房间。 【请求参数】
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
流对象(Stream) 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
查询历史质量 功能介绍 查询质量指标过去每天的体验数据,可查询最近31天的数据。当天未结束,无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
房间功能 joinRoom virtual int joinRoom(const HRTCJoinParam &joinParam) 【功能说明】 加入房间。该方法让用户加入通话房间。 【请求参数】 joinParam:加入房间信息。具体请参见HRTCJoinParam。 【返回参数
查询异常事件用户分布 功能介绍 查询指定APP下指定时间内的通话异常明细数据分布情况。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行(播放) 上行(上麦) 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
客户端事件通知(ClientEvent) 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
接口总览 本章节介绍了iOS/macOS SDK的HWRtcEngine接口详情。 HWRtcEngine按照其功能可分类为:初始化等基础接口、房间功能、视频管理、辅流管理、共享屏幕、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/rtc/data