智慧服务，成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 会议控制 > 接口参考 设置多画面

入门使用

设置多画面

更新时间：2019-11-19

描述

主席通过该接口提供多画面设置功能。

接口原型

表1 接口原型

请求方法

PUT

请求地址

/conferences/{conferenceid}/setMultiPicture

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Conference-Authorization

是

String

Header

会控授权令牌(通过会议ID/密码登录会议控制获取)，将响应的token进行Base64转码操作。

样例：Basic Base64(token)

conferenceid

是

String

URL

会议标识。

manualSet

是

Int

Body

是否为手工设置多画面。

  • 0： 系统自动多画面；
  • 1： 手工设置多画面。

imageType

是

String

Body
  • Single：单画面；
  • Two：二画面；
  • Three：三画面；
  • Four：四画面；
  • Six：六画面；
  • Nine：九画面；
  • Sixteen：十六画面。

只针对手工设置多画面有效。

subscriberInPics

是

SubscriberInPic[0..*]

Body

子画面列表。详见表3 SubscriberInPic数据结构。

switchTime

条件必选

Int

Body

表示轮询间隔。单位：秒。

当同一个子画面中包含有多个与会者视频源时，此参数有效。
表3 SubscriberInPic 数据结构

参数

是否必须

类型

描述

index

是

Int

多画面中每个画面的编号。编号从1开始。

默认值为“1”。

subscriber

是

String[0..*]

每个画面中会话标识。会话标识中的与会者标识participantID通过查询在会会场信息获取。

最大不超过255个字符。

isAssistStream

否

Int

是否为辅流。

  • 0： 不是辅流
  • 1： 是辅流

默认值：0

响应参数

表4 参数说明

参数

类型

描述

returnCode

Int

错误码。

returnDesc

String

错误描述。

请求消息示例

PUT /conferences/914055447/setMultiPicture
Connection: keep-alive
Conference-Authorization: Basic dG9rZW41Y2U5ZTkzMWZjMDEzMDM2YTk0NDdlY2FiMGVkYzcyM2U4OWU2NWYzODgzNzQ1Nzc=
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, 13 Mar 2019 02:15:34 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

{
    "returnCode": 0,
    "returnDesc": "Success"
}
 

CURL命令示例

curl -k -i -H 'content-type: application/json' -X PUT -H 'Conference-Authorization:Basic dG9rZW4wOTFiZmZkM2I5NDk5OWUzOTUwODUxNjJiNzViMDRhNTE1Nzc4ZTgwNjI3MDU4ODI=' -d '{"manualSet": 0}' 'https://api.meeting.huaweicloud.com/conferences/914010951/setMultiPicture'