*getLayoutStatus
- Tom Polman
- Martijn Friggen
Configuration Article | CA-20220907-TP-32 VDG Sense | API | Functions | Layouts  |  |
Note: This function requires an API license.
Obtains a list with the current layout status for the requested server. This list includes the monitors, the name of the layout that is selected on the monitor, and the devices that are visible on Live or Playback panels.
Request
Note: divaid is optional.
command=getLayoutStatus&divaid=[UID] |
Response
<result errorcode="0">
  <layoutstatus>
    <divas count="[number]">
      <diva>
        <divaid>[UID]</divaid>
        <name>[string]</name>
        <addresses>[number]</addresses>
        <monitors count="[number]">
          <monitor>
            <index>[number]</index>
            <monitorid>[UID]</monitorid>
            <name>[string]</name>
            <active>[boolean]</active>
            <layout>
              <layoutid>[UID]</layoutid>
              <name>[string]</name>
              <panels count="[number]">
                <panel>
                  <panelid>[UID]</panelid>
                  <name>[string]</name>
                  <serverid>[UID]</serverid>
                  <deviceid>[UID]</deviceid>
                  <status>
                    <video>[string]</video>
                  </status>
                </panel>
                ...
              </panels>
            </layout>
          </monitor>
          ...
        </monitors>
      </diva>
      ...
    </divas>
  </layoutstatus>
 </result> |
node | value | remarks |
|---|---|---|
/result | ||
@errorcode | [number] | See error codes here |
/result/layoutstatus | ||
/result/layoutstatus/divas | ||
@count | [number] | the number of viewers in the list. |
/result/layoutstatus/divas/diva | ||
divaid | [UID] | unique id (What is DIVA?) |
name | [string] | name/description |
addresses | [number] | the address of the server |
/result/layoutstatus/divas/diva/monitors/monitor | ||
index | [number] | index number of the monitor |
monitorid | [UID] | unique id of the monitor |
name | [string] | name of the monitor |
active | [boolean] | True or false indicating if the monitor is active |
/result/layoutstatus/divas/diva/monitors/monitor/layout | ||
layoutid | [UID] | unique id of the layout |
name | [string] | the name of the layout |
/result/layoutstatus/divas/diva/monitors/monitor/layout/panels | ||
@count | [number] | the number of panels in this list |
/result/layoutstatus/divas/diva/monitors/monitor/layout/panels/panel | ||
panelid | [UID] | unique id of the panel |
name | [string] | the name of the panel |
serverid | [UID] | the unique 64 bit server id of the camera displayed on this panel (empty or 0) if no device is selected on this panel |
deviceid | [UID] | the unique 32 bit device id of the camera displayed on this panel (empty or 0) if no device is selected on this panel. |
/result/layoutstatus/divas/diva/monitors/monitor/layout/panels/panel/status | ||
video | [string] | The status for the video stream (i.e. Ok, NoVideo, ConnectionLost, ServerLost, NotActive) |
error code | description | remarks |
|---|---|---|
0 | Ok | Ok, no error |
Changelog
2.2.1 – added