*getLayoutList
- Tom Polman
Configuration Article | CA-20220907-TP-31 VDG Sense | API | Functions | Layouts  |  |
Note: This function requires an API license.
Obtains a list of all layouts. Layouts are used to display video on.
Request
command=getLayoutList |
Response
<result errorcode="0">
  <layouts count="[number]">
    <layout>
      <layoutid>[UID]</layoutid>
      <name>[string]</name>
      <panels count="[number]">
        <panel>
          <panelid>[UID]</panelid>
          <name>[string]</name>
          <deviceid>[UID]</deviceid>
          <serverid>[UID]</serverid>
          <type>[string]</type>
          <top>[number]</top>
          <left>[number]</left>
          <width>[number]</width>
          <height>[number]</height>
        </panel>
        ...
      </panels>
    </layout>
    ...
  </layouts>
 </result> |
node | value | remarks |
|---|---|---|
/result | ||
@errorcode | [number] | See error codes here |
/result/layouts | ||
@count | [number] | the number of layouts |
/result/layouts/layout | ||
layoutid | [UID] | unique id of the layout |
name | [string] | the user defined name of the layout |
/result/layouts/layout/panels | ||
count | [number] | the number of panels |
/result/layouts/layout/panels/panel | ||
panelid | [UID] | unique id of the panel |
name | [string] | the user defined name of the panel |
deviceid | [UID] | unique id of the device assinged to the panel (0 is no device assigned) |
serverid | [UID] | unique id of the server of the device assigned to the panel (0 is no device is assigned). |
type | [string] | description of the type of the panel |
top | [number] | top coordinate of the position of the panel |
left | [number] | left coordinate of the position of the panel |
width | [number] | width of the panel |
height | [number] | height of the panel |
error code | description | remarks |
|---|---|---|
0 | Ok | Ok, no error |
Changelog
2.3.1  – Changed panels tag from count to subtag with more information
1.10.1 – Added