更新时间:2022-08-25 GMT+08:00
分享

设置组合画面内容

接口名称

WEB_SetMultiStreamSiteListAPI

功能描述

终端支持协作的情况下,设置组合画面内容。

应用场景

终端支持协作,在不修改当前模式的情况下,修改组合画面内容。

URL

https://ip/action.cgi?ActionID=WEB_SetMultiStreamSiteListAPI

参数

表1 设置组合画面内容参数

参数

类型

取值范围

参数说明

layoutMode

int

32位整数

当前的布局模式。取值必须WEB_GetMultiStreamLayoutInfoAPI返回的当前模式一致,否则设置失败。

subMode

int

32位整数

子画面内容,当layoutMode为10(PiP)时,用于设置子画面位置。

siteList

list

siteList 对象

会场信息。详细参考表2

表2 siteList

参数

类型

取值范围

参数说明

streamType

int

{0, 1, 2, 3, 11}

流类型

0:本地主流

1:远端主流

2:远端演示

3:本地演示

11:本地有线演示

siteNum

int

32位整数

会场句柄

M

int

[0, 400]

M号

T

int

[0, 400]

T号

返回值

表3 设置组合画面内容返回值

参数

类型

取值范围

参数说明

success

int

[0, 1]

响应结果

0:失败

1:成功

data

Object

可选, 空对象

成功返回数据。这里返回空。

例如:{"success":1,"data":""}

error

Object

可选

失败返回错误信息。详细参考表4

例如:{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

表4 error

参数

类型

取值范围

参数说明

id

int

32位整数

错误id,用于转换。

code

int

32位整数

错误码,跟错误id对应,具体含义参考错误码

param

Object

param 对象

失败响应的附带参数。

相关文档