# 协作模式下获取组合画面信息 #### 接口名称 WEB_GetMultiStreamLayoutInfoAPI #### 功能描述 终端支持协作的情况下，用该接口获取组合画面信息，注意与传统组合画面区别。 #### 应用场景 终端支持协作的情况下，用该接口获取组合画面信息，注意与传统组合画面区别。 #### URL https://ip/action.cgi?ActionID=WEB_GetMultiStreamLayoutInfoAPI #### 参数 无 #### 返回值 表1协作模式下获取组合画面信息返回值 | 参数 | 类型 | 取值范围 | 参数说明 | |:---|:---|:---|:---| | success | int | \[0, 1\] | 响应结果 0：失败 1：成功 | | data | Object | 可选 | 成功返回数据。详细参考[表2]。 例如： {"success":1,"data":"{ \\"layoutMode\\":12, \\"subPicCounts\\":2, \\"vipModeType\\":0, \\"subMode\\":0, \\"startId\\":0, \\"endId\\":4, \\"showSelf\\":1, \\"focus\\":0, \\"pageHome\\":0, \\"pageForward\\":0, \\"pageBackward\\":0, \\"highLight\\":{\\"M\\":0,\\"T\\":0}, \\"boardcastSite\\":{\\"M\\":0,\\"T\\":0}, \\"mainSite\\":{}, \\"siteList\\":\[ {\\"id\\":0,\\"streamType\\":0,\\"siteName\\":\\"site1\\",\\"M\\":1,\\"T\\":7}, {\\"id\\":1,\\"streamType\\":1,\\"siteName\\":\\"site2\\",\\"M\\":1,\\"T\\":15}\], \\"modeList\\":\[0,15,26,12,10\], \\"fullTypeList\\":\[0,1,3,255\], \\"subModeList\\":\[10,9,9,6,6,255,255,255,255,255,255,255,255,255,255,255,255,255,255,255\]}"} | | error | Object | 可选 | 失败返回错误信息。详细参考[表5]。 例如：{"success":0,"error":{"id":100666995,"code":33558532,"params":\[\]}} | 表2data | 参数 | 类型 | 取值范围 | 参数说明 | |:---|:---|:---|:---| | layoutMode | int | {0, 10, 12, 15, 25, 26, 28, 31} | layoutMode，表示当前的布局模式，取值如下： 0：全屏模式 10：PiP 12：二分屏 15：三分屏，左一右二 25：三分屏，等分 26：三分屏，上二下一 28：演讲者视图（多流支持） 31：画廊视图（多流支持） | | subPicCounts | int | 32位整数 | 当前模式下的画面个数 | | vipModeType | int | {0, 1} | VIP模式时，小画面位置。 0：小画面在下 1：小画面在上 | | subMode | int | {0, 1, 2, 3, 4, 5} | subMode，当layoutMode为10（PIP）时该字段有效，表示子画面位置。 0：隐藏 1：左上 2：右上 3：右下 4：左下 5：自动 | | startId | int | 32位整数 | startId、endId，多流时使用，演讲者视图下小画面为siteList数组下标 \[startId, endId\] 闭区间范围内的会场，画廊视图下，会场为siteList数组下标 \[startId, endId\] 闭区间范围内的会场。 | | endId | int | 32位整数 | startId、endId，多流时使用，演讲者视图下小画面为siteList数组下标 \[startId, endId\] 闭区间范围内的会场，画廊视图下，会场为siteList数组下标 \[startId, endId\] 闭区间范围内的会场。 | | showSelf | int | \[0, 1\] | 是否显示本地会场 0：不显示 1：显示 | | focus | int | \[0, 1\] | focus，多流时使用，是否处于选看锁定状态，演讲者视图下选看小画面时该值为1，否则为0。 | | pageHome | int | \[0, 1\] | pageHome，多流时使用，会场列表翻页时是否可以回到主页。 0：否 1：是 | | pageForward | int | \[0, 1\] | pageForward，多流时使用，会场列表翻页时是否可以切到下一页。 0：否 1：是 | | pageBackward | int | \[0, 1\] | pageBackward，多流时使用，会场列表翻页时是否可以切到上一页。 0：否 1：是 | | highLight | Object | highLight 对象 | highLight，多流时使用，高亮会场的MT号。highLight结构MT参考[表3]。 | | boardcastSite | Object | boardcastSite 对象 | boardcastSite，多流时使用，广播会场的MT号。boardcastSite结构MT参考[表3]。 | | mainSite | Object | mainSite 对象 | mainSite，多流时使用，PiP和演讲者视图下大画面信息。mainSite 的结构参考[表4]。 | | siteList | 画面会场信息的数组 | siteList 对象 | siteList，表示各个画面会场信息的数组，具体信息有： id: 会场id标识，该id用于放大、选看参数下发。 streamType：该画面的流类型，取值0：本地主流，1：远端主流，2：远端演示，3：本地演示，11：本地有线演示。streamType大于255时，表示当前处于二分屏状态，streamType右起低8位表示右分屏流类型，高8位表示左分屏类类型。 siteName：多流时使用，只有流类型为本主和远主时才使用该字段。 M：会场M号。 T：会场T号。 数组元素结构参考[表4] 。 | | modeList | 整型数组 | 整型 | modeList，表示当前支持的模式列表，在设置时只能设置该列表中的值。 | | fullTypeList | 整型数组 | {0, 1, 2, 3, 11} | fullTypeList，非多流时使用，表示当前支持的全屏模式。 0：本主 1：远主 2：远辅 3或者11：本辅 | | subModeList | 整型数组 | {4, 5, 6, 7, 8, 9} | subModeList，非多流时与modeList联合使用，用于区分二画面或者三画面的自画面内容。 4：远主+本主 5：本辅+本主 6：本辅+远主 7：远辅+远主 8：远辅+远主+本主 9：本辅+远主+本主 | 表3WEB_MT_STRU | 参数 | 类型 | 取值范围 | 参数说明 | |:---|:---|:---|:---| | ucM | int | \[0, 400\] | 会场M号 | | ucT | int | \[0, 400\] | 会场T号 | 表4WEB_MULTI_STREAM_SITE_INFO | 参数 | 类型 | 取值范围 | 参数说明 | |:---|:---|:---|:---| | id | int | 32位整数 | 会场 id | | ucStreamType | uint | 32位无符号整数 | 流类型 | | aszSiteName | String | \[1, 192\] | 会场名 | | ucM | int | \[0, 400\] | M号 | | ucT | int | \[0, 400\] | T号 | 表5error | 参数 | 类型 | 取值范围 | 参数说明 | |:---|:---|:---|:---| | id | int | 32位整数 | 错误id，用于转换。 | | code | int | 32位整数 | 错误码，跟错误id对应，具体含义参考[错误码](https://support.huaweicloud.com/ideahub-api/ideahub_05_0255.html#ZH-CN_TOPIC_0000001309671920)。 | | param | Object | param 对象 | 失败响应的附带参数。 |