设置多画面 - SetMultiPicture
描述
设置会议多画面。该接口废弃不用,请使用“设置自定义多画面”接口。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/mmc/control/conferences/display/multiPicture
请求参数
参数 | 是否必须 | 类型 | 位置 | 描述 |
|---|---|---|---|---|
conferenceID | 是 | String | Query | 会议ID。 |
X-Conference-Authorization | 是 | String | Header | 会控Token,通过获取会控token接口获得。 |
manualSet | 是 | Integer | Body | 是否为手工设置多画面。
|
imageType | 否 | String | Body | 多画面数目。手工设置多画面时有效。
|
subscriberInPics | 否 | Array of SubscriberInPic objects | Body | 子画面列表(手工设置多画面时必填)。 |
switchTime | 否 | Integer | Body | 表示轮询间隔,取值范围:10-120,默认10。单位:秒。 当同一个子画面中包含有多个与会者时,此参数有效。 |
参数 | 是否必须 | 类型 | 描述 |
|---|---|---|---|
index | 是 | Integer | 多画面中每个画面的编号。编号从1开始。 默认值为“1”。 |
subscriber | 否 | Array of strings | 每个画面中与会者标识列表,从查询会议实时信息接口返回的pid中获取。 |
isAssistStream | 否 | Integer | 是否为辅流。默认值为0。
|
状态码
HTTP状态码 | 描述 |
|---|---|
200 | 操作成功。 |
400 | 参数异常。 |
401 | 未鉴权或鉴权失败。 |
403 | 权限受限。 |
500 | 服务端异常。 |
响应参数
无
请求消息示例
PUT /v1/mmc/control/conferences/display/multiPicture?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
Content-Length: 27
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
{
"manualSet": 0
} 响应消息示例
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 6346df97898dcd1e9cb205b75f24fe65 Server: api-gateway X-Request-Id: 0294dd7aedd58db92a23de453cbcde0e
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"manualSet": 0}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/multiPicture?conferenceID=914083136' 
