与会设备多屏设置

功能说明

会控中配置某个与会设备的多屏显示。

默认接口请求频率限制【相同云会议室】：20次/1秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{meetingRoomNumber}/splitScreen?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1	3.9无此接口
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2 (2024-0329版本）
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则	5.2 (2024-0329版本）
meetingRoomNumber	String	Body	是	无	云会议室号	5.2 (2024-0329版本）
deviceId	long	Body	是	无	要设置多屏显示的参会设备id 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	5.2 (2024-0329版本）
type	int	Body	是	无	要设置多屏显示的参会设备类型可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	5.2 (2024-0329版本）
noContent	Object	Body	是	无	无内容分享时多屏配置	5.2 (2024-0329版本）
hasContent	Object	Body	是	无	有内容分享时多屏配置	5.2 (2024-0329版本）
screenId	String	Body	是	无	屏幕id	5.2 (2024-0329版本）
role	String	Body	是	无	屏幕角色 multiImage（多画面）、local（本地视频）、content（内容分享）、polling（轮询）、speaker（发言者）	5.2 (2024-0329版本）
layout	String	Body	是	无	布局目前支持的布局有：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	5.2 (2024-0329版本）
pollingInterval	Integer	Body	否	10	轮询时间间隔：仅role为polling时生效	5.2 (2024-0329版本）
skipUnjoined	boolean	Body	否	无	轮询时是否跳过未入会终端	5.2 (2024-0329版本）
skipMuteVideo	boolean	Body	否	无	轮询时是否跳过未开启视频终端	5.2 (2024-0329版本）
pollingList	Array of Object	Body	是	无	轮询设备列表	5.2 (2024-0329版本）
multiImageList	Array of Object	Body	是	无	多画面设备列表	5.2 (2024-0329版本）
participantId	String	Body	否	无	参会者参会id	5.2 (2024-0329版本）
partiDeviceId	long	Body	是	无	参会者设备id	5.2 (2024-0329版本）
partiName	String	Body	否	无	参会者设备名称	5.2 (2024-0329版本）
partitype	Integer	Body	是	无	参会设备类型	5.2 (2024-0329版本）
participantNumber	String	Body	否	无	参会者设备号	5.2 (2024-0329版本）
particpantNumber	String	Body	是	无	参会设备号可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	5.2 (2024-0329版本）

终端多屏管理API使用流程：

通过【获取会中一个设备的多屏能力】API，获取终端是否支持多屏能力。API返回的消息体中multiScreenList字段内，依次为设备的屏幕id，称为【一屏、二屏、三屏】；
通过【设置设备多屏】API对支持多屏能力的终端进行设置，使用规范如下：
在同一请求消息体中，需要同时传noContent（无内容分享时的布局）、hasContent（有内容分享时的布局）
对于noContent，目前：

一屏仅支持speaker（发言人）、multiImage（多画面）模
二屏仅支持multiImage（多画面）、polling（轮询）模式
三屏仅支持multiImage（多画面）、local（本地视频）模式

对于hasContent，目前

一屏仅支持content（内容分享）
二屏支持multiImage（多画面）、polling（轮询）、speaker（发言人）、content（内容分享）
三屏支持multiImage（多画面）、polling（轮询）、local（本地视频）、content（内容分享）

注意事项：

对于multiImage（多画面）、polling（轮询）模式，暂不支持在同屏显示同一个参会者
轮询间隔，必须传大于等于5的正整数。
白板不属于content（内容分享），有独立的layout，不支持通过多屏管理API控制

示例代码

请求消息体示例（Json）

{
    "deviceId": 100766497,
    "type": 8,
    "noContent": [
        {
            "screenId": "master",
            "role": "speaker"
        },
        {
            "screenId": "slave_1",
            "role": "polling",
            "layout": "2-1",
            "pollingInterval": "10",
            "skipUnjoined": true,
            "skipMuteVideo": false,
            "pollingList": [
                {
                    "participantId": "66752",
                    "partiDeviceId": 101990776,
                    "partiName": "企业chao管",
                    "partitype": 5,
                    "participantNumber": "18899997777"
                },
                {
                    "participantId": "131392",
                    "partiDeviceId": 101762120,
                    "partiName": "高小林testdev",
                    "partitype": 5,
                    "participantNumber": "13303878299"
                }
            ]
        },
        {
            "screenId": "slave_2",
            "role": "local"
        }
    ],
    "hasContent": [
        {
            "screenId": "master",
            "role": "content"
        },
        {
            "screenId": "slave_1",
            "role": "multiImage",
            "layout": "1-1",
            "multiImageList": [
                {
                    "participantId": "66560",
                    "partiDeviceId": 100764766,
                    "partiName": "智能视频终端",
                    "partitype": 2,
                    "participantNumber": "293149"
                }
            ]
        },
        {
            "screenId": "slave_2",
            "role": "local"
        }
    ]
}

返回结果示例：

成功时返回httpcode为200，失败时返回小鱼RESTAPI错误码

请求失败结果示例

{
    "developerMessage": "ErrorStatus: POLLINGLIST_EMPTY pollingDeviceList is empty",
    "userMessage": "pollingList.is.empty",
    "errorCode": 4001039,
    "moreInfo": "http://www.com.ainemo.com/errors/4001039"
}

以下仅列出该接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码

错误码	描述
4001039	轮训列表为空
4001040	多屏layout设置错误
4001041	轮训时间设置错误
4001042	多画面设备设置错误
4001043	屏幕角色设置错误

2024-11-13 14:29:40

导出PDF文档