直播合流
直播合流是指将房间内多路音视频流进行按需混合,控制输出的合流视频参数。
利用直播合流服务端 API,您可以进行以下配置:
- 选择主播视频流进行合流,即控制观众可以在合流后视频中看到或者听到的哪些主播
- 配置直播的布局,即观众端多视频画面的排版方案
- 管理直播合流输出的分辨率
- 管理(文字、图片)水印的效果和位置
请求方法
POST:http(s)://api.rong-api.com/rtc/mcu/config.json
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文中包含具有以下结构的 JSON 对象:
请求参数 | 类型 | 说明 |
---|---|---|
sessionId | String | (必传)需要配置合流的会话 ID,可通过服务端回调获取。详见房间状态同步。 |
config | Object | JSON 格式数据,包含所有布局相关参数。 |
config.mode | Number | 合流布局模式,用于控制即多视频画面的排版方式。可选模式如下:
|
config.version | Number | 配置版本号,默认为 1。 |
config.host_user_id | String | 主视频流发布者的用户 ID。使用自定义布局时(config.mode 为 1 )应留空,填 “”。
|
config.host_stream_id | String | 主视频流 ID。使用自定义布局时(config.mode 为 1 )应留空,填 “”。
|
config.output | Object | 指定合流之后的媒体输出参数,内部包含 JSON 格式的视频合流输出配置(video )和音频合流输出配置(audio )。详见下方 config.output 对象说明 |
config.customMode | Bool | (已废弃)请使用 inputFilterMode 字段。 |
config.inputFilterMode | Number | 控制 MCU 合流服务所使用的资源。
|
config.input | Object | 指定需要进行合流的子用户流输入配置,内部包含子视频流的数组(video )和子音频流数组(audio )。详见下方 config.input 对象说明 |
config.waterMark | Object | 指定视频水印配置,支持在合流后整个画布上添加水印;以及各个子视频流上添加水印。可添加图片、文字、时间戳水印。详见下方 config.waterMark 对象说明。 |
-
config.output 对象说明:该对象描述了合流的视频、音频输出参数。
参数 类型 说明 video Object 指定合流输出视频的配置,内部包含常规视频流(大流)配置对象( normal
)、小流配置对象(tiny
)、裁剪方式配置、背景颜色配置和背景图配置。video.normal Object 指定合流之后媒体服务输出的常规视频流(大流)的配置。 video.normal.width Number 合流之后媒体服务输出的常规尺寸视频的宽度。 video.normal.height Number