简体中文
设置个人布局
更新时间:2025-04-27 03:27:51

设置个人布局

当前会议允许的个人布局设置数量限制为10

  • 请求方法

PUT

  • 请求地址

/ctrl/meetings/{meetingNumber}/view/personalLayout

  • 请求参数
参数 参数类型 数据类型 是否必需 描述
meetingNumber path string 会议号
mode body string 布局模式,个人布局模式仅可选custom
layout body customLayout结构体 布局结构体
subscriber body subscriber结构体 个人布局订阅者参数
  • 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)
subscribeToUsers subscribeToUser结构体数组 用户视频源列表数组结构体
  • subscribeToUser 数据结构
参数 数据类型 描述
userID int 会议内用户ID
subjectID string 用户企业账号ID
  • subscriber 数据结构
参数 数据类型 描述
userID int 订阅者用户ID(可以通过会议信息查询-查询会议用户信息,获取想设置个人布局的用户的userID)
  • HTTP状态码
返回值 描述
200 操作成功
400 客户端传参异常
401 鉴权失败
404 找不到请求的资源
500 服务端异常
  • 请求消息示例
PUT /v2/ctrl/meetings/10000/view/personalLayout HTTP/1.1
{
    "mode":"custom",
    "layout":{
        "name":"自定义布局",
        "type":"1+6",
        "pollSeconds":15,
        "pollCount":-1,
        "pictures":[
            {
                "index":1,
                "subscribeType":"users",
                "subscribeToUsers":[
                    {
                        "userID":1,
                        "subjectID":""
                    }
                ]
            },
            {
                "index":2,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            },
            {
                "index":3,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            },
            {
                "index":4,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            },
            {
                "index":5,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            },
            {
                "index":6,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            },
            {
                "index":7,
                "subscribeType":"users",
                "subscribeToUsers":[

                ]
            }
        ]
    },
    "subscriber":{
        "userID":1
    }
}
  • 响应消息示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "ret": 0,
    "bizCode": 900200
}
本页目录