Get sound location algorithm

📘

Only HDL410 systems support this feature.

This tutorial shows how to get the active sound location algorithm for the room where Nureva® audio devices are located.

What can be controlled with the API?

• soundLocationAlgorithm: The algorithm used for detecting sound locations in the room. Possible values are:
  • BP
  • TDOA

Minimum role required: general

The Get Room Layout endpoint can be accessed with the general role or any role of a higher level.

Overview

1. Use the Get Room Layout endpoint to get the active sound location algorithm.
2. Check that the request was successful and parse the response.

Instructions

Step 1 - Send a request to get the active sound location algorithm

Use the Get Room Layout Information endpoint to make a request to get the room layout information for the room where the Nureva® audio conferencing system is connected:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/room/layout.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the GET request. The code sample below is a request to retrieve the current sound location algorithm for the room of the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/room/layout \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 2 - Parse the response

The example response below indicates that the active sound location algorithm is set to the default algorithm.

{
  "soundLocationAlgorithm": "BP"
}

✅

Tutorial complete!

You now know how to get the sound location algorithm.