会议中修改录制布局

功能说明

通过API开发者可在会议中实时调整录制布局。

开发者可根据云会议号码设置会议的当前录制布局，同时支持查询云会议室当前的录制布局。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

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

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1	3.9无此接口
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
meetingRoomNumber	String	Body	是	无	当前会议的云会议室号	5.2
recordExtras	String (json)	Body	否	无	录制附加配置	5.2
└ layout	--	Body	否	无	布局配置	5.2
└ screen	String	Body	否	无	横竖屏类型，可选值"landscape"（横屏），"portrait"（竖屏）	5.2
└ people	--	Body	否	无	只有 people 情况下的布局配置	5.2
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过 maxCells 时，只显示 maxCells 个人。如不传递值，则展示默认效果：maxCells=8	5.2
└ view	String	Body	否	无	布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）,"POP"。如不传递值，则展示默认效果：view=POP	5.2
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）。如不传递值，则展示默认效果：mode=auto	5.2
└ content	--	Body	否	无	只有 content 情况下的布局配置	5.2
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过 maxCells 时，只显示 maxCells 个人。如不传递值，则展示默认效果：maxCells=8	5.2
└ view	String	Body	否	无	布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）,"POP"。如不传递值，则展示默认效果：view=POP	5.2
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）。如不传递值，则展示默认效果：mode=auto	5.2
└ prefer	boolean	Body	否	false	指示是否 content（第一分屏）幕显示，可选值：true（#1 分屏）, false（#2 分屏）。如不传递值，则展示默认效果：prefer=false	5.2
└ OSD	--	Body	否	无	叠加在视频上的附属信息	5.2
└ nameplate	--	Body	否	无	叠加终端名称	5.2
└ enabled	boolean	Body	否	无	是否启动功能，可选值：true（叠加）, false（不叠加）。如不传递值，则展示默认效果：enabled=false	5.2

示例代码

请求消息体示例（Json）

{
  "meetingRoomNumber": "98798711111",
  "recordExtras": "{\"layout\":{\"screen\":\"landscape\",\"people\":{\"mode\":\"auto\",\"maxCells\":5,\"view\":\"symTiling\",\"specified\":[\"17610356832\"]},\"content\":{\"maxCells\":2,\"view\":\"symTiling\"}},\"OSD\":{\"nameplate\":{\"enabled\":true}}}"
}

常见录制布局示例：(详情请查看画面布局)

录制content大窗，主讲小窗："{\"layout\":{\"content\":{\"maxCells\":2,\"mode\":\"auto\",\"view\":\"POP\"}}}"
录制content小窗，主讲大窗："{\"layout\":{\"content\":{\"maxCells\":2,\"prefer\":false,\"mode\":\"auto\",\"view\":\"POP\"}}}"
录制content和主讲自动切换："{\"layout\":{\"content\":{\"maxCells\":2,\"smart\":true,\"mode\":\"auto\",\"view\":\"POP\"}}}"
只录制content："{\"layout\":{\"content\":{\"maxCells\":1,\"mode\":\"auto\",\"view\":\"POP\"}}}"
分享content和主讲对称分屏显示："{\"layout\":{\"content\":{\"maxCells\":2,\"mode\":\"auto\",\"view\":\"symTiling\"}}}"
content存在的情况下，仅录制主讲人："{\"layout\":{\"content\":{\"maxCells\":1,\"prefer\":false,\"mode\":\"auto\",\"view\":\"POP\"}}}"
content不存在的情况下，仅录制主讲人："{\"layout\":{\"people\":{\"maxCells\":1,\"mode\":\"auto\",\"view\":\"POP\"}}}

返回结果示例：

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

2024-11-13 14:29:40