修改客户端推流设置
请求地址
PUT /api/live/v1/room/{id}/push-stream-setting
字段 |
是否可选 |
类型 |
描述 |
Authorization |
否 |
string |
认证信息,格式:bearer ${token} |
Accept-Language |
是 |
string |
选择语言,(zh-CN)(zh-TW)(en-US) 默认值: zh-CN |
Content-Type |
否 |
string |
application/json |
请求参数
字段 |
是否可选 |
类型 |
描述 |
pushStreamType |
否 |
string |
推流方式,CLIENT:客户端推流,SERVER:服务端推流 |
videoLayoutConfig |
否 |
object |
视频布局,默认布局:2(画中画),默认布局位置:2(右下角) |
videoAndShareLayoutConfig |
否 |
object |
视频 + 共享布局,默认布局:2(画中画),默认布局位置:2(右下角) |
videoNicknameConfig |
否 |
object |
视频昵称设置 |
backgroundUrl |
是 |
string |
背景图url |
videoCount |
否 |
string |
视频路数 |
参数说明
字段 |
是否可选 |
类型 |
描述 |
layout |
是 |
int |
视频布局,1:演讲者 2:画中画(默认) 3:画廊。</br>视频+共享布局,1:平铺,2:画中画(默认) |
position |
是 |
int |
画中画布局位置,1:右上角。2:右下角(默认)。3:左下角。4:左上角 |
show |
是 |
int |
是否显示 0不显示 1显示 |
color |
是 |
int |
色彩编码 |
请求参数示例
{
"pushStreamType":"CLIENT",
"backgroundUrl":"http://www.xxx.com",
"videoCount":6,
"videoLayoutConfig":{
"layout":1,
"position":1
},
"videoAndShareLayoutConfig":{
"layout":1,
"position":1
},
"videoNicknameConfig":{
"show":1,
"position":1,
"color":"xxxxxx"
}
}
响应参数
字段 |
类型 |
描述 |
resCode |
int |
响应码 |
resMessage |
String |
提示消息(根据language参数,选择语言返回) |
data |
json |
响应数据 |
成功返回
http/1.1 200 OK
{
"resCode":1,
"resMessage":"success"
}
失败返回
http/1.1 200 OK
{
"resCode": -1,
"resMessage": "xxx",
}