设置观众布局
请求方法
PUT
请求地址
/ctrl/meetings/{meetingNumber}/view/audienceLayout
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
meetingNumber |
path |
string |
是 |
会议号 |
mode |
body |
string |
是 |
布局模式,可选参数:basic、custom。当mode=basic时,终端入会默认显示服务器推送的布局类型,但允许主持人、与会者本地切换为其它布局,研讨会观众无法切换。当mode=custom时,终端都固定显示,无法本地切换布局 |
layout |
body |
当mode=basic时无需带;当mode=custom,采用customLayout结构体 |
否 |
布局结构体 |
customLayout 数据结构
参数 |
数据类型 |
是否必须 |
描述 |
name |
string |
是 |
布局名称 |
type |
string |
是 |
自定义布局类型,1+0, 1+1, 4*4等 |
pictures |
picture结构体数组 |
是 |
画面布局数组结构体 |
pollSeconds |
int |
否 |
轮询秒数 |
pollCount |
int |
否 |
最大轮询图数量,-1表示无上限,全屏轮询 |
picture 数据结构
参数 |
数据类型 |
是否必须 |
描述 |
index |
int |
是 |
画面编号 |
subscribeType |
string |
是 |
视频源类型,可选:speaker(语音激励)、poll(自动轮询)、users(选中user)、sharer(共享屏幕) |
subscribeToUsers |
subscribeToUser结构体数组 |
否 |
用户视频源列表数组结构体 |
subscribeToUser 数据结构
参数 |
数据类型 |
是否必须 |
描述 |
userID |
int |
是 |
会议内用户ID |
subjectID |
string |
是 |
用户企业账号ID |
HTTP状态码
返回值 |
描述 |
200 |
操作成功 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
404 |
找不到请求的资源 |
500 |
服务端异常 |
请求消息示例
PUT /ctrl/meetings/10000/view/audienceLayout HTTP/1.1
{
"mode":"custom",
"layout":{
"name":"自定义布局",
"type":"1+6",
"pollSeconds":15,
"pollCount":-1,
"pictures":[
{
"index":1,
"subscribeType":"users",
"subscribeToUsers":[
]
},
{
"index":2,
"subscribeType":"poll"
},
{
"index":3,
"subscribeType":"users",
"subscribeToUsers":[
{
"userID":10,
"subjectID":""
}
]
}
]
}
}
或
{
"mode":"basic",
"layout":{
"type":"speaker"
}
}
响应消息示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ret": 0,
"bizCode": 900200
}