设置组合画面模式
接口名称
WEB_SetMultiStreamLayoutModeAPI
功能描述
终端支持协作的情况下,设置组合画面模式。
应用场景
终端支持协作的情况下,设置组合画面模式。
URL
https://ip/action.cgi?ActionID=WEB_SetMultiStreamLayoutModeAPI
参数
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
layoutMode |
int |
{0, 10, 11, 12, 13, 15, 25, 26, 27, 28, 31} |
layoutMode, 表示当前的布局模式。当前会议支持的所有模式由WEB_GetMultiStreamLayoutInfoAPI返回。 0:全屏 10:PIP 11:二分屏(上下不等比) 12:二分屏(左右等比) 13:二分屏(左右不等比) 15:三分屏,左一右二 25:三分屏,等分 26:三分屏,上二下一 27:演讲者模式(小画面在下,多流支持) 28:演讲者视图模式(小画面在上,多流支持) 31:画廊视图模式(多流支持) |
subMode |
int |
{0, 1, 2, 3, 4} |
subMode, 子画面内容,设置画中画及全屏时使用。根据不同的layoutMode, 取值如下: 当layoutMode为全屏时,subMode取值: 0:本主 1:远主 2:远辅 3:本辅 当layoutMode为PIP,subMode取值: 0:隐藏(多流支持) 1:左上角 2:右上角 3:右下角 4:左下角 |
返回值
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
success |
int |
[0, 1] |
响应结果 0:失败 1:成功 |
data |
Object |
可选, 空对象 |
成功返回数据。这里返回空。 例如:{"success":1,"data":""} |
error |
Object |
可选 |
失败返回错误信息。详细参考表3。 例如:{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}} |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
id |
int |
32位整数 |
错误id,用于转换。 |
code |
int |
32位整数 |
错误码,跟错误id对应,具体含义参考错误码。 |
param |
Object |
param 对象 |
失败响应的附带参数。 |