实时音视频 SparkRTC
实时音视频 SparkRTC
- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
-
客户端SDK参考
- 使用前必读
- SDK概述
- 隐私声明
- 合规使用指南
- Android SDK
- iOS/macOS SDK
- All Platform C++ SDK
- Web SDK
- 接入鉴权
- 附录
- 修订记录
-
常见问题
-
产品咨询
- SparkRTC支持哪些平台?
- SparkRTC Demo怎么体验?
- 在进行Windows的Demo使用或集成SDK时,提示微软C++标准库缺失,该如何获取?
- SparkRTC支持接入微信小程序吗?
- 实时音视频是什么?
- 实时音视频和直播有什么区别?
- SparkRTC是否支持在国外使用?
- SparkRTC RoomID是什么?取值区间值是多少?
- SparkRTC最多可以同时创建多少个房间?
- SparkRTC UserID是什么?取值范围是多少?
- 怎么理解SparkRTC的角色Role?
- SparkRTC最多可以支持多少个人同时视频通话?
- 实时音视频的时延是多少?
- SparkRTC是否支持连麦互动?
- SparkRTC是否支持双向的桌面推送?
- 实时音视频支持私有化部署吗?
- PC端实时音视频支持USB摄像头吗?
- 计费购买
- Signature相关
- 录制相关
-
SDK使用
- 移动端(Android/iOS)创建一个房间,是否支持PC端(MAC/Windows)接入?
- iOS平台如何缩减安装包体积?
- Android平台如何缩减安装包体积?
- iOS端是否可以监听远端离开房间?
- 背景音乐是否支持循环播放?
- SparkRTC是否支持调整背景音乐的播放进度?
- 支持监听房间成员进出房间吗?
- 如何监测断网和重连?
- 支持首帧渲染回调吗?能否监听画面开始渲染?
- 如何设置上行视频码率、分辨率和帧率?
- 有没有推荐的画面质量(码率、分辨率、帧率)相关参数配置?
- 如何实现横屏视频通话?
- 是否支持网络测速?如何操作?
- 是否支持音量大小提示?
- 自定义渲染支持哪些格式?
- SparkRTC支持iOS后台运行吗?
- 移动端如何实现录屏(屏幕分享)?
- 多人视频会议中,移动端和Web端可以进入同一房间吗?
- SparkRTC的Web端、移动端、PC端是不是同步的?
- Android SDK是否支持自定义采集数据?
- SparkRTC支持旁路推流吗?
- Windows端如何才能采集到被分享应用播放的声音?
- SDK是否支持断线重连机制?
- 如何创建房间?
- 两台手机同时运行SparkRTC APP,为什么无法互通?
- 鉴权是如何生成的?在什么时候生成?
- onVideoStats、onAudioStatus、onSubStreamStats回调触发时为什么程序会崩溃?
- 为什么本端听筒能听到自己的声音?
- setExternalAudioCapture(音频自采集)、setExternalVideoCapture(视频自采集)、setExternalMediaFrameOutput(视频自渲染)能在进入房间后开启吗?
- SparkRTC是否支持设置镜像画面?
- SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取?
- SparkRTC是否支持设置本地采集音量?是否支持设置每个远端用户的播放音量?
- enableLocalVideo和muteLocalVideo有什么区别?
- enableLocalAudioStream和muteLocalAudio有什么区别?
- SparkRTC是否支持对房间进行权限校验?
- 接入PC端是否支持屏幕分享功能?
- SparkRTC是否支持将本地视频文件分享到实时音视频中?
- SparkRTC是否支持单纯的实时音频?
- 一个房间里可以同时有多路屏幕分享吗?
- SparkRTC是否支持1080P?
- 是否支持视频画面截图功能?
- 播放背景音乐是否支持在线音乐?
- 同一个页面中,可以创建N个RTC对象,通过N个UserID,分别登录到N个房间吗?
- Web端用宽高设置的推流分辨率适用于所有浏览器吗?
- Web端SDK在使用过程中拔掉摄像头,摄像头列表里面的数据如何清除?
- Web端SDK可以获取当前音量大小吗?
- Web端支持监听远端离开房间吗?
- Web端通话过程中为什么会出现回声、杂音、噪声、声音小?
- Web端如何切换摄像头和麦克风?
- SparkRTC支持白板功能吗?
- 相同UserID支持同时进入多个房间吗?
- SparkRTC房间的生命周期是多久?
- SparkRTC多人视频通话支持蓝牙耳机吗?
- SparkRTC多人视频通话支持仅订阅2/3/4人音频吗?
- 指定窗口分享,当窗口大小变化时,视频流的分辨率会跟着变化吗?
- 视频通话支持悬浮窗、大小画面切换功能吗?
- 发送自定义消息接口能实现聊天室、弹幕等功能吗?
- 支持查询所有的UserID吗?
- Web SDK中的checkSystemRequirements接口为什么会调用异常?
- 问题排查
-
产品咨询
- 文档下载
- 通用参考
链接复制成功!
示例2:创建合流录制任务
场景描述
示例1:创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件,您可以参考此章节内容调用SparkRTC API进行合流录制。
前提条件
- 已获取需要使用的SparkRTC服务的终端节点:rtc-api.myhuaweicloud.com。
- 已创建用于存储录制文件的OBS桶,并完成OBS桶授权。您可以通过调用OBS 创建桶API进行创建,并在SparkRTC控制台中完成OBS桶授权。
操作步骤
- 获取用户Token,用于调用SparkRTC接口时进行认证鉴权。
在“我的凭证”页面获取username、password、domainname,调用如下接口获取Token。详细信息请参见构造请求。
POST https://iam.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名。 "password": "password", //用户登录密码。 "domain": { "name": "domainname" //用户所属的账号名。 } } } }, "scope": { "domain": { "name": "domainname" //用户所属的账号名。 } } } }
如图1所示,红框中的信息为获取用户Token。 - 调用创建应用接口创建SparkRTC应用。
- 选择POST请求方法并输入URI。
https://rtc-api.myhuaweicloud.com/v2/apps
- 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。
- Request Body中传入如下参数:
{ "app_name" : "rtctest" }
- 请求响应成功后,返回已创建应用的ID。
{ "app_id": "5ff9701f2346968bb306cb43", }
- 选择POST请求方法并输入URI。
- 调用创建或更新录制规则接口,创建录制规则。
- 选择POST请求方法并输入URI。
https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-rules
- 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。
- Request Body中传入如下参数:
{ "obs_addr": { "bucket": "obsName", "location": "cn-north-4", "object": "Record/", "project_id": "01234567890123456789012345678901" }, "record_formats": ["MP4"], "mp4_config": {} }
- 请求响应成功后,返回已创建的录制规则。
{ "app_id": "5ff9701f2346968bb306cb43", "rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab", "create_time": "2021-04-21T10:29:33Z", "hls_config": { "record_cycle": 0, "record_max_duration_to_merge_file": 0 }, "mp4_config": { "record_cycle": 7200, "record_max_duration_to_merge_file": 0, "record_prefix": "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time}" }, "obs_addr": { "bucket": "obsName", "location": "cn-north-4", "object": "Record/", "project_id": "01234567890123456789012345678901" }, "record_formats": [ "MP4" ], "update_time": "2021-04-21T10:29:33Z" }
- 选择POST请求方法并输入URI。
- 调用RTC增值(录制)事件回调配置接口,配置录制回调。
- 选择PUT请求方法并输入URI。
https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-callback
- 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。
- Request Body中传入如下参数:
{ "url": "http://mydomain.com/callback", "auth_key": "8923ab8c2dcef4538923ab8c2dcef453" }
- 请求响应成功后,返回已创建的回调信息。
{ "app_id": "5ff9701f2346968bb306cb43", "record_callback": { "auth_key": "8923ab8c2dcef4538923ab8c2dcef453", "update_time": "2021-04-07T12:05:18.0718Z", "url": "http://mydomain.com/callback", "notify_event_subscription": [ "RECORD_NEW_FILE_START", "RECORD_FILE_COMPLETE", "CLOUD_RECORD_OVER" ] } }
- 选择PUT请求方法并输入URI。
- 终端用户通过SparkRTC APP加入某个SparkRTC房间,SparkRTC APP的集成开发请参见客户端SDK。
- 调用启动合流任务接口,创建录制任务。
- 选择POST请求方法并输入URI。
https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/mix-stream-jobs
- 请求消息头中增加“X-Auth-Token”,值设置为步骤1中获取的用户Token。
- Request Body中传入如下参数:
{ "mix_param": { "room_id": "room001", "encode_template": "1920x1080_30_4620", "max_idle_time": 30, "layout_template": "nine_grids_view" //若视频布局为屏幕共享,则填写为screen_share_left或screen_share_right。 }, "record_param": { "record_rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab" } }
layout_template:视频布局模板编号。
- nine_grids_view:九宫格模板(自适应模板)。
每个用户画面平铺在画布上,大小一致。根据用户数量,动态调整每个画面的大小和位置,最多支持25个画面。不同人数的实际布局效果如下图所示:
- 如果实际视频流的宽高比与视窗的宽高比不一致,则视频画面会裁剪以适配视窗的大小。
- 如果中途有流退出房间,则该条流的画面会被后进入房间的流顶替。
- 如果房间内的人数不足,则剩余位置显示背景色。
- 如果用户只发送音频,仍然会占用画面位置。
- 支持背景图,如果房间内人数不足,则显示背景图。
- screen_share_left、screen_share_right:主视图在左边、右边的屏幕共享模板(自适应模板)。
屏幕分享(或者主讲人摄像头画面)始终占据屏幕左侧或者右侧大画面位置,其他用户依次垂直排列于旁边,最多支持17个画面。不同人数的实际布局效果如下图所示:
- 大视窗画面,可选择主讲摄像头流或共享屏幕流。
- 大视窗画面,显示指定的UID用户的视频,如果未指定或者指定用户未进入频道,则大视窗区域显示背景色。
- 左侧大视窗为了保持内容的完整性采用缩放方式处理,右侧小视窗采用裁剪方式适配视窗的大小。
- 右侧小视窗画面按照加入房间的时间先后顺序排列。
- 右侧小视窗有流退出房间,则该条流的画面会被后进入房间的流顶替。
- 如果房间内的人数不足,则剩余位置显示背景色。
- 如果用户只发送音频,仍然会占用画面位置。
- 支持背景图,如果房间内人数不足,则显示背景图。
- nine_grids_view:九宫格模板(自适应模板)。
- 请求响应成功后,返回合流录制任务信息。
{ "app_id": "5ff9701f2346968bb306cb43", "create_time": "2021-04-21T11:47:32Z", "job_id": "607f9fc100d861eeefff9b300b388dab", "job_unique_id": "87b1f2b8da9c44cd", "mix_param": { "room_id": "room001", "layout_template": "nine_grids_view", "encode_template": "1920x1080_30_4620", "max_idle_time": 30 }, "push_param": { "rtmp_urls": null }, "record_param": { "record_rule_id": "5d0ec2c53a2c15625017adb8bbbcd9ab" }, "room_id": "room001", "start_time": "2021-04-21T11:47:32Z", "state": "INIT", "stop_time": "0001-01-01T00:00:00Z", "stream_name": "m_607f9fc100d861eeefff9b300b388dab_room001", "update_time": "2021-04-21T11:47:32Z" }
- 选择POST请求方法并输入URI。
- SparkRTC房间结束音视频互动后,您可以在配置的OBS桶中获取录制文件。
父主题: 应用示例