实时音视频 SPARKRTC-启动合流任务:请求参数
下载实时音视频 SPARKRTC用户手册完整版
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
内容类型。 |
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
mix_param |
是 |
MixParam object |
合流参数 |
|
record_param |
否 |
RecordParam object |
录制参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
room_id |
是 |
String |
房间id |
|
encode_template |
是 |
String |
输出编码模板名称
|
|
max_idle_time |
否 |
Integer |
最长空闲频道时间。 取值范围：[5，43200]，默认值为30。 单位：秒。 如果频道内无连麦方的状态持续超过该时间，录制程序会自动退出。退出后，再次调用start请求，会产生新的录制任务。 连麦方指：joiner或者publisher的用户。 |
|
layout_template |
否 |
String |
视频布局模板编号，不混视频的时候，不需要带。
|
|
default_user_background_image |
否 |
String |
默认用户背景图地址，图片先上传obs，格式s3://bucket/object，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪，保证铺满。 |
|
screen_background_image |
否 |
String |
共享屏幕的背景图地址，图片先上传obs，格式s3://bucket/object，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下，无论大窗是显示非指定用户（屏幕共享人的桌面）还是指定用户的共享桌面，都通过该字段指定背景图。 |
|
background_image |
否 |
String |
画布背景图地址，使用背景图功能需先上传图片到obs，填写此字段要求格式为s3://bucket/object，其中bucket和object指图片所在的桶和路径，如：s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪，保证铺满。 |
|
layout_panes |
否 |
Array of MixLayoutPane objects |
需要混流的视频列表。若不需要混流视频，则可不传递该参数。 nine_grids_view模板不需要填写本字段。 |
|
user_background_images |
否 |
Array of MixUserBackgroundImage objects |
指定用户背景图，优先级大于default_user_background_image |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
Integer |
窗口id，从1开始编号 |
|
user_id |
否 |
String |
加入房间的用户id |
|
video_type |
否 |
String |
标识视频流的类型，可选摄像头流或者屏幕分享流。
默认为CAMERASTREAM。 |
|
x |
否 |
Float |
坐标x，归一化百分比，画布上该画面左上角的横坐标的相对值，范围是 [0.0,1.0]。从左到右布局，0.0在最左端，1.0在最右端，小数取值范围在float内，自定义布局场景下填写本字段。 |
|
y |
否 |
Float |
坐标y，归一化百分比，画布上该画面左上角的纵坐标的相对值，范围是 [0.0,1.0]。从上到下布局，0.0在最上端，1.0在最下端，小数取值范围在float内，自定义布局场景下填写本字段。 |
|
width |
否 |
Float |
窗格宽，归一化百分比，小数取值范围在float内，自定义布局场景下填写本字段。 |
|
height |
否 |
Float |
窗格高，归一化百分比，小数取值范围在float内，自定义布局场景下填写本字段。 |
|
zorder |
否 |
Integer |
叠放顺序，0为最底层，1层在0层之上，以此类推，最大支持25层，自定义布局场景下填写本字段。 |
|
crop_mode |
否 |
String |
裁剪模式，自定义布局场景下填写本字段，支持两种模式：
|
|
filling_policy |
否 |
String |
填充策略，仅限屏幕共享模板(包括screen_share_right、screen_share_left)场景下填写本字段，支持两种模式：
|
