终端轮询
功能说明
用户使用终端时，期望在某个终端轮询播放特定的参会者画面
默认接口请求频率限制：20次/秒。
实现方法
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/polling?enterpriseId=XXX&signature=XXX&conferenceNumber=xxx
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权1.0（旧）：是 签名鉴权2.0：否 | 无 | API签名，参考 签名鉴权 | |
conferenceNumber | String | Query | 是 | 无 | 当前会议的云会议号 | 3.9(2022-0916版本) |
deviceId | long | Body | 是 | 无 | 需要轮询的设备Id（可在查看全体成员会议状态API获取） | 3.9(2022-0916版本) |
type | int | Body | 是 | 无 | 需要轮询的设备类型（可在查看全体成员会议状态API获取） | 3.9(2022-0916版本) |
participantNumber | String | Body | 是 | 无 | 对于硬件设备为终端号（可在查看全体成员会议状态API获取） | 3.9(2022-0916版本) |
pollingState | String | Body | 是 | 无 | 轮询状态（ 运行RUNNING，暂停PAUSED， 停止STOPPED， 必须为三种状态其一） | 3.9(2022-0916版本) |
pollingPattern | String | Body | 是 | 无 | 轮询模式（ 自动AUTO，手动MANUAL，混合MIX 必须为三种模式其一 ） | 3.9(2022-0916版本) |
pollingInterval | Long | Body | 是 | 无 | 轮询间隔（单位：秒，必须大于等于5，最大1天） | 3.9(2022-0916版本) |
layoutModel | String | Body | 是 | 无 | 轮询布局模型（详见如下）,分区云最大支持16画面 | 3.9(2022-0916版本) |
autoPollingList | List | Body | 否 | 无 | 自动轮询列表（可在查看全体成员会议状态中获取，list具体参数详见下） | 3.9(2022-0916版本) |
└name | String | Body | 否 | 无 | device显示名称 | |
└device | Object | Body | 否 | 无 | 格式请参考样例，可在查看全体成员会议状态API获取 | |
manualPollingList | List | Body | 否 | 无 | 手动轮询列表, 具体参数如下 | 3.9(2022-0916版本) |
└imagePattern | String | Body | 否 | 无 | 手动轮询列表模式参数(自动轮询auto, 明确指定specified, 语音激励speaker) | 3.9(2022-0916版本) |
└pollingList | List | Body | 否 | 无 | 手动轮询列表中指定位置的设备轮询列表（可在查看全体成员会议状态API获取） | 3.9(2022-0916版本) |
└name | String | Body | 否 | 无 | device显示名称 | |
└device | Object | Body | 否 | 无 | 格式请参考样例，可在查看全体成员会议状态API获取 | |
skipUnjoined | boolean | Body | 否 | false | 是否跳过不在会成员，pollingPattern为AUTO时此配置必须为true | 3.9(2022-0916版本) |
skipMuteVideo | boolean | Body | 否 | false | 是否跳过未开启摄像头成员 | 3.9(2022-0916版本) |
broadcast | boolean | Body | 否 | false | 是否开启轮询广播 | 3.9(2022-0916版本) |
参数使用说明:
1、轮询模式pollingPattern为AUTO时，手动轮询列表manualPollingList参数不生效（可以省略），autoPollingList可以为null（轮询所有），但是 autoPollingList中的元素不能为null。
2、轮询模式pollingPattern为MANUAL时，自动轮询列表autoPollingList参数不生效（可以省略）；manualPollingList中的imagePattern也不生效（可以省略），imagePattern会被强制指定为specified。
3、轮询模式pollingPattern为MANUAL时，manualPollingList中的顺序即对相应layoutModel布局中的顺序，可将manualPollingList中的某个元素置为null，manualPollingList超过layoutModel大小的元素会被丢弃。
4、轮询模式pollingPattern为MIX时，自动轮询列表autoPollingList和手动轮询列表manualPollingList都会生效，具体效果依赖于imagePattern参数。
5、若当前云会议室号没有开启会议会报错（no meeting），若设备不支持轮询也会报错（operation unsupported）
mode效果示例如下图：
示例代码
请求消息体示例（Json）
{
"deviceId": "xxxxxx",
"type": "7",
"participantNumber": "xxxxxx",
"pollingState": "RUNNING",
"pollingPattern": "MANUAL",
"pollingInterval": 3,
"layoutModel": "2-1",
"skipMuteVideo": true,
"autoPollingList": [
{
"name": "xxxx",
"device": {
"id": xxxx,
"type": 7,
"participantId": "xxxx",
"participantNumber": "xxx"
}
}
],
"manualPollingList": [
{
"imagePattern": "specified",
"pollingList":[
{
"name": "xxx",
"device": {
"id": xxx,
"type": 5,
"participantId": "xxx",
"participantNumber": "xxx"
}
}
]
}
]
}
返回结果示例：
成功时返回200，失败时返回小鱼RESTAPI错误码