Set room layout

Allows clients to update properties of the room layout such as:

  • the preferred measurement system for displaying room dimensions
  • whether or not the room dimensions are verified
  • the room dimensions
  • whether or not the audio component positions are verified
  • the audio component positions
  • the zones configuration
  • the camera switching configuration and defaults

NOTE: Only supported for HDL300, Dual HDL300, HDL310, HDL410, and HDX devices.

admin role required

Example Request Body for HDL410 device

{
  "uiMeasurementSystem": "IMPERIAL",
  "roomDimensionsVerified": false,
  "roomDimensions": {
      "xMin": -1000,
      "xMax": 4000,
      "yMin": 0,
      "yMax": 10800
  },
  "audioComponentPositionsVerified": false,
  "audioComponentPositions": [
      {
          "id": "AUDIO_BAR_0",
          "x": 0,
          "y": 0,
          "z": 0,
          "zAngle": 0
      },
      {
          "id": "AUDIO_BAR_1",
          "x": -3000,
          "y": 9000,
          "z": 0,
          "zAngle": 90
      }
  ],
  "zones": [
      {
          "types": "Switching",
          "on": true,
          "geometry": {
              "point1": {
                  "x": 1000,
                  "y": 1000
              },
              "point2": {
                  "x": 2000,
                  "y": 2000
              }
          },
          "zoneId": "2345313e-deb8-4cd4-a58a-2df031296958",
          "ZoneLabel": "Zone 1"
      },
      {
          "types": "Switching",
          "on": true,
          "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"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

string
required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Body Params

The request body to update the room layout.

string
enum

The preferred measurement system for displaying room dimensions.

Allowed:
boolean

Whether or not the room dimensions are verified.

roomDimensions
object

The room dimensions in millimeters.

boolean

Whether or not the audio component positions are verified.

audioComponentPositions
array of objects

The positions of audio components, relative to the primary component. Coordinates are in millimeters and angles are in degrees.

audioComponentPositions
zones
array of objects

List of configured Coverage Map zones.

zones
cameraSwitcherZoneInputMap
array of objects

The list of zone-to-camera switcher input mappings. When a zone is triggered, the camera switcher will switch to the corresponding camera input port.

cameraSwitcherZoneInputMap
cameraSwitcherDefaults
object

Settings for controlling the camera switching behavior.

string
enum
Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json