Get room layout

Allows clients to retrieve information about the room layout such as:

  • the preferred measurement system for displaying room dimensions
  • whether or not the room dimensions are verified
  • the room dimensions
  • the computed room dimensions
  • whether or not the audio component positions are verified
  • the audio component positions
  • the computed audio component positions

NOTE: Only supported for HDL410 and HDX devices.

Minimum role required: general

Example Response Body

{
  "uiMeasurementSystem": "IMPERIAL",
  "roomDimensionsVerified": false,
  "roomDimensions": {
      "xMin": -1000,
      "xMax": 4000,
      "yMin": 0,
      "yMax": 10800
  },
  "computedRoomDimensions": {
      "xMin": -8382,
      "xMax": 8382,
      "yMin": 0,
      "yMax": 10660
  },
  "audioComponentPositionsVerified": false,
  "audioComponentPositions": [
      {
          "id": "AUDIO_BAR_0",
          "hardwareId": "AA4111AB0000",
          "x": 0,
          "y": 0,
          "z": 0,
          "zAngle": 0
      },
      {
          "id": "AUDIO_BAR_1",
          "hardwareId": "AA4111AB0001",
          "x": -3000,
          "y": 9000,
          "z": 0,
          "zAngle": 90
      }
  ],
  "computedAudioComponentPositions": [
      {
          "id": "AUDIO_BAR_0",
          "hardwareId": "AA4111AB0000",
          "x": 0,
          "y": 0,
          "z": 0,
          "zAngle": 0
      },
      {
          "id": "AUDIO_BAR_1",
          "hardwareId": "AA4111AB0001",
          "x": -2000,
          "y": 9000,
          "z": 0,
          "zAngle": 180
      }
  ],
  "zones": [
      {
          "types": "Switching",
          "geometry": {
              "point1": {
                  "x": 1000,
                  "y": 1000
              },
              "point2": {
                  "x": 2000,
                  "y": 2000
              }
          },
          "zoneId": "2345313e-deb8-4cd4-a58a-2df031296958",
          "ZoneLabel": "Zone 1"
      },
      {
          "types": "Switching",
          "geometry": {
              "point1": {
                  "x": 3000,
                  "y": 3000
              },
              "point2": {
                  "x": 4000,
                  "y": 4000
              }
          },
          "zoneId": "9599a6a6-1603-4ceb-97f8-0008163ad88c",
          "ZoneLabel": "Zone 2"
      }
  ],
  "cameraSwitcherZoneInputMaps": [
      {
          "zoneId": "2345313e-deb8-4cd4-a58a-2df031296958",
          "inputPort": "HDMI"
      },
      {
          "zoneId": "9599a6a6-1603-4ceb-97f8-0008163ad88c",
          "inputPort": "USB1"
      }
  ],
  "cameraSwitcherDefaults": {
      "defaultCameraInputPort": "HDMI",
      "zonesTriggerWaitTime": 1000,
      "switchToDefaultWaitTime": 5000
  },
  "soundLocationAlgorithm": "BP"
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!