Get room layout information

📘

Only HDL410 systems support this feature.

This tutorial shows how to get room layout information about the room where Nureva® audio devices are located.

What room layout information is available?

As shown in the image below, rooms are assumed to be rectangular, and each wall is identified by a cardinal direction: north, south, west and east.

When interpreting the microphone and speaker bar location coordinates, the origin (0,0) is the southwest corner of the room. Positive x values are in the east direction. Positive y values are in the north direction.

The microphone and speaker bar plugged into Port 1 on the connect module will always be situated on the south wall of the room layout.

Note that room dimensions are configurable by end users through Nureva Console software, whereas bar locations are detected through the calibration process during hardware installation. As a result, the bar locations are not guaranteed to align precisely with a wall.

Room layout coordinates vs. sound location data coordinates

⚠️

The room layout’s origin differs from the origin used in the sound location data stream.

The origin for the sound location data stream is the location of the Port 1 microphone and speaker bar, while the origin for the room layout is the southwest corner of the room.

To convert a sound location coordinate (x, y) to a room coordinate, use (x + x', y), where x' is the x value of the Port 1 bar's location in the response’s bars array.

Overview

Use Get room layout information to get the room layout information.

Instructions

⚠️

Before you begin

Learn how to add your IP address or hostname and make a WebSocket connection to the configured IP and port of the server.

Step 1 - Send the request

1. Use the Get room layout information endpoint to a make a request to get the layout information of the room where the Nureva audio conferencing system is connected:
2. Pass "v1/room/layout" in to the request property
3. Fill in requestId and clientId according to the request format guide
4. Send the request

The example request below will get the device information.

{
  "request": "v1/room/layout",
  "requestId": "94486c98-fd25-458e-84ae-df5376fab2a2",
  "clientId": "test"
}

Step 2 - Parse the response

The example response below indicates that:

1. The room dimensions are 5,866 mm by 7,345 mm
2. The microphone and speaker bar connected to Port 1 of the connect module is located on the south wall, and is at location (2324,5)
3. The microphone and speaker bar connected to Port 2 of the connect module is located on the north wall, and is at location (2876,6788)

{ 
  "request": "v1/room/layout",
  "requestId": "94486c98-fd25-458e-84ae-df5376fab2a2",
  "clientId": "test",
  "body": {
    "roomDimensions": {
      "x": 5866,
      "y": 7345
     },
    "bars": [
      {
        "wall": "South",
        "location": {
          "x": 2324,
          "y": 5
        }
      },
      {
        "wall": "North",
        "location": {
          "x": 2876,
          "y": 6788
        }
      }
    ]
  }
}

✅

Tutorial complete!

You now know how to get the room layout information.