保存多画面布局 - SaveLayout
功能介绍
该接口用于保存多画面布局。保存的多画面布局,只能在当前会议使用,会议结束后,保存的多画面布局就会释放。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/mmc/control/conferences/layOut
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| conferenceID | 是 | String | 会议ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Conference-Authorization | 是 | String | 会控Token,通过获取会控token接口获得。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| restPicLayout | 否 | RestPicLayout object | 会议多画面布局信息。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| switchTime | 否 | Integer | 多画面轮询时间,单位秒。 最小值:10 |
| picNum | 否 | Integer | 多画面画面数量。 最小值:1 |
| layOutName | 否 | String | 多画面布局名称。 |
| imageType | 否 | String | 画面类型。
|
| uuid | 否 | String | 布局UUID。 |
| subscriberInPics | 否 | Array of PicInfoNotify objects | 子画面列表。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| index | 否 | Integer | 多画面中每个画面的编号,编号从1开始。 |
| id | 否 | Array of strings | 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯获取。 |
| share | 否 | Integer | 是否为辅流。 |
响应参数
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误码描述。 |
请求示例
PUT https://{endpoint}/v1/mmc/control/conferences/layOut?conferenceID=914370850
{
"restPicLayout" : {
"imageType" : "Two",
"switchTime" : 10,
"layOutName" : "my_saved_layout",
"subscriberInPics" : [ {
"index" : 1,
"id" : [ "+99111221231895886" ],
"share" : 0
}, {
"index" : 2,
"id" : [ "+99111221231894887" ],
"share" : 0
} ]
}
} 响应示例
状态码: 400
参数异常。
{
"error_code" : "MMC.111072065",
"error_msg" : "CONF_NOT_FOUND_OR_AUTH_FAILED"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 参数异常。 |
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。