检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
主入口（HRTC） 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知： 如果Web SDK版本在2.0.2到2.0.9.300之间，需要在2023年10月29日前更新至2
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第六次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay：停止所有跨房
主要功能 SparkRTC主要包含基本房间功能和跨房功能，各端主要功能框架，如图1所示。 说明：图1中仅展示各端的统一功能，独属功能详见各端SDK指导。 图1 功能框架 表1 功能说明 类别 功能分类 功能说明 基本功能 初始化等基础接口 主要功能包括创建/销毁RTC引擎、设置日志保存位置等。
接入鉴权 为保证SparkRTC的通信安全，当用户加入房间时，华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置
屏幕分享 功能描述 屏幕共享用于在音视频会议中，把一个与会者的屏幕内容，以视频的方式分享给其他与会者。屏幕共享可以共享整个桌面，也可以共享某一个程序窗口。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 创建并播放共享流 入会后调用isSc
示例1：创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制，可以在加入房间后，调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶，并完成OBS桶授权。您可以通过调用OBS
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行（播放） 上行（上麦） 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
接口参考 HRtcEngine 事件回调（IHRTCEngineEventHandler） HRTCConnection 事件回调(IHRTCConnectionEventHandler) 客户端错误码 服务端错误码 数据类型 媒体原始数据管理 父主题： Android SDK
常见问题 iOS平台如何缩减安装包体积？ 对于iPhone 5s及以上版本的手机支持只打包arm64架构，可以在XCode的Build Setting < Build Active Architecture Only设置为YES，并将Valid Architectures只写arm64，则SparkRTC
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下： 客户端对象（Client）新增旁路推流接口：startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
接收增值（录制）事件回调通知内容 SparkRTC服务回调用户提供的接口时，会附带以下信息。 表1 请求Body参数 参数 是否必选 参数类型 描述 job_id 否 String 任务编号，可以用于修改、查看和停止录制任务 stream_name 否 String 流名 app_id
通话质量监测 功能描述 加入频道后，SDK会每隔2秒自动触发通话质量相关的回调，上报当前通话的网络质量、本地和远端的音视频统计信息。 上报接口 通话质量上报 onNetworkQualityNotify回调上报当前通话中每个入会者的上下行网络质量。默认开启，每2s上报一次。 void
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离。
状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。
SDK使用 移动端（Android/iOS）创建一个房间，是否支持PC端（MAC/Windows）接入？ iOS平台如何缩减安装包体积？ Android平台如何缩减安装包体积？ iOS端是否可以监听远端离开房间？ 背景音乐是否支持循环播放？ SparkRTC是否支持调整背景音乐的播放进度？
屏幕分享 功能描述 屏幕共享用于在音视频会议中，把一个与会者的屏幕内容，以视频的方式分享给其他与会者。屏幕共享可以共享整个桌面，也可以共享某一个程序窗口。共享程序窗口的时候还可以指定共享该程序窗口的矩形区域。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。
屏幕分享 功能描述 屏幕共享用于在音视频会议中，把一个与会者的屏幕内容，以视频的方式分享给其他与会者。屏幕共享可以共享整个桌面，也可以共享某一个程序窗口。共享程序窗口的时候还可以指定共享该程序窗口的矩形区域。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合，一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放，也可以同时播放给其他与会者听。 支持播放本地或在线音乐文件，文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现过程 加入房间
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
