开始多画面配置及广播
功能说明
多画面配置及广播。
默认接口请求频率限制：20次/秒。
实现方法
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{callNumber}/meeting/startDeviceMultiImage?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0（旧）：是 签名鉴权2.0：否 | 无 | API签名，参见签名规则 | |
callNumber | String | Path | 是 | 无 | 当前会议的云会议号 | 3.9 |
deviceId | long | Body | 是 | 无 | 被开始多画面终端的设备Id，可以从“主持会议 - 查看全体成员的会议状态”API查询: id字段表示设备id | 3.9 |
type | int | Body | 是 | 无 | 被开始多画面终端的设备类型，可以从“主持会议 - 查看全体成员的会议状态”API查询：type字段表示设备类型， 目前仅部分终端支持配置多画面： ME/AE90（type：7 ME/AE 40/20 (type:8) | 3.9 |
participantNumber | String | Body | 是 | 无 | 参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号 | 3.9 |
broadcast | boolean | Body | 否 | false | 是否开启广播，默认值false。若开启广播，会议中其他支持多画面的终端，也会使用相同的画面布局 | 3.9 |
mode | String | Body | 是 | 无 | 多画面模式 （ 例如：4-2，4：代表共有四个画面窗口显示；2：代表在4画面情况下的第2种显示模式）。 目前支持的mode有：1-1，2-1，3-1，4-1，4-2，5-1，6-1，6-2，8-1，9-1, 12-1, 13-1, 16-1 | 3.9 |
participantId | String | Body | 是 | 无 | 参会者id。可以从“主持会议 - 查看全体成员的会议状态”API查询: participantId字段表示参会者id | 3.9 |
partiDeviceId | long | Body | 是 | 无 | 参会者设备id。可以从“主持会议 - 查看全体成员的会议状态”API查询: id字段表示设备id | 3.9 |
partiName | String | Body | 是 | 无 | 参会者设备名称。可以从“主持会议 - 查看全体成员的会议状态”API查询 | 3.9 |
partitype | int | Body | 是 | 无 | 参会者设备类型。可以从“主持会议 - 查看全体成员的会议状态”API查询：name字段表示设备名称 | 3.9 |
participantNumber | String | Body | 是 | 无 | 参会者设备号。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号 | 3.9 |
mode效果示例如下图：
示例代码
请求消息体示例（Json）
{
"deviceId": xxxxxx,
"type": xxxxxx,
"participantNumber": "xxxxxx",
"broadcast": false,
"mlayout": {
"mode": "2-1",
"detail": [
{
"items": [{
"participantId": "xxxxxx",
"partiDeviceId": xxxxxx,
"partiName": "xxxxxx",
"partitype": xxxxxx,
"participantNumber": "xxxxxx"
}]
},
{
"items": [{
"participantId": "xxxxxx",
"partiDeviceId": xxxxxx,
"partiName": "xxxxxx",
"partitype": xxxxxx,
"participantNumber": "xxxxxx"
}]
}
]
}
}返回结果示例：
成功时返回200，失败时返回小鱼RESTAPI错误码