设置自定义多画面 - SetCustomMultiPicture

描述

该接口用于设置会中多画面。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1/mmc/control/conferences/display/customMultiPicture

请求参数

表1 参数说明
参数	是否必须	类型	位置	描述
conferenceID	是	String	Query	会议ID。
X-Conference-Authorization	是	String	Header	会控Token，通过获取会控token接口获得。
manualSet	是	Integer	Body	是否为手工设置多画面。 0：系统自动多画面 1：手工设置多画面
picLayoutInfo	否	PicLayoutInfo object	Body	会议自定义多画面布局信息。说明：预留参数，当前版本不可用。
imageType	否	String	Body	画面类型。手工设置多画面时有效。imageType取值和画面布局的对应关系详见图1。
subscriberInPics	否	Array of SubscriberInPic objects	Body	子画面列表（手工设置多画面时必填）。
switchTime	否	Integer	Body	表示轮询间隔,取值范围：10-120，默认10。单位：秒。当同一个子画面中包含有多个与会者时，此参数有效。说明：仅针对专业会议终端生效，对软终端不生效。
multiPicSaveOnly	否	Boolean	Body	多画面是否仅保存。 true：仅保存 false：保存并应用说明： ”仅保存“效果：仅保存当前画面布局，不进行广播等操作。 ”保存并应用“效果： 1、当会议状态为广播多画面、声控单画面、声控多画面、主持人观看多画面时，保存并应用后，改变画面布局，不改变状态。 2、当会议状态为非广播多画面、声控单画面、声控多画面、主持人观看多画面时，如自动多画面、广播与会者、点名与会者时，保存并应用后，变为广播多画面。当处于广播多画面、声控多画面、声控单画面状态下，无法设置主持人观看多画面。

图1 imageType（画面类型）参考

imageType取布局图下方的字符串。举例说明：如果需要设置多画面样式为均分四画面，则imageType设置为“Four”。

表2 PicLayoutInfo数据结构
参数	是否必须	类型	描述
x	否	Integer	多画面布局的宽度。
y	否	Integer	多画面布局的高度。
subPicLayoutInfoList	否	Array of SubPicLayoutInfo objects	子画面布局具体列表。

表3 SubPicLayoutInfo数据结构
参数	是否必须	类型	描述
id	否	Integer	画面索引号。
left	否	Integer	画面从左到右的坐标点。
top	否	Integer	画面从上到下的坐标点。
xSize	否	Integer	小画面的宽度。
ySize	否	Integer	小画面的高度。

表4 SubscriberInPic 数据结构
参数	是否必须	类型	描述
index	否	Integer	多画面中每个画面的编号。编号从1开始。默认值为“1”。
subscriber	否	Array of strings	每个画面中与会者号码，从查询会议实时信息接口返回participants中的phone中获取。
isAssistStream	否	Integer	是否为辅流。默认值为0。 0：不是辅流 1：是辅流

状态码

表5 状态码说明
HTTP状态码	描述
200	操作成功。
400	参数异常。
401	未鉴权或鉴权失败。
403	权限受限。
500	服务端异常。

响应参数

无

请求消息示例

PUT /v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789
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": 1,
    "subscriberInPics":[{
         "index": 2,
         "subscriber": ["+99111252010982686"]
	  }],
    "imageType":"Six",
    "multiPicSaveOnly": false
}

响应消息示例

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/customMultiPicture?conferenceID=900967789'

父主题： 接口参考

上一篇：设置多画面 - SetMultiPicture

下一篇：切换会议显示策略 - SwitchMode