Cloud APIsLocal APIs
Local Documentation
nureva.com
Start typing to search…

Set sound location algorithm

📘

Only HDL410 systems support this feature.

This tutorial shows how to set 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: integrator

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


Overview

  1. Use the Get Room Layout endpoint to get the current sound location algorithm.
  2. Use the Set Room Layout endpoint to make a request to change the active sound location algorithm.
  3. Use the Get Room Layout endpoint to check that the change has been applied successfully.

Instructions

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

Use the Get Room Layout Information endpoint:

  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 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'
  1. If the call is successful, an HTTP status code of 200 OK will be returned.
  2. Check the value of the soundLocationAlgorithm attribute. A value of "BP" means that the current active sound location algorithm is set to the default algorithm. A value of "TDOA" means that the alternate sound location algorithm is being used (requires accurate room layout information in order to function properly).

The example response below indicates that the current sound location algorithm is "BP".

{
  "soundLocationAlgorithm": "BP"
}

Step 2 - Make a request to update the active sound location algorithm

Use the Set Room Layout Information endpoint:

  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. Update the headers to include Content-type as key and application/json as value.
  6. Update the request body to send a JSON object with "soundLocationAlgorithm": "TDOA" to change the active sound location algorithm. NOTE: setting the sound location algorithm to "TDOA" requires accurate room layout information. Follow the Set room dimensions and Set audio component layout tutorials in order to configure room layout.
curl --request PATCH \
     --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' \
     --header 'Content-type: application/json' \
     --data '{"soundLocationAlgorithm":"TDOA"}'
  1. Send the PATCH request.
  2. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 3 - Check that the change has been applied successfully

Use the Get Room Layout Information endpoint:

  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 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'
  1. If the call is successful, an HTTP status code of 200 OK will be returned.
  2. Check the value of the soundLocationAlgorithm attribute.

The example response below indicates that the change of the sound location algorithm to "TDOA" was successfully applied.

{
  "soundLocationAlgorithm": "TDOA"
}

✅

Tutorial complete!

You now know how to set the sound location algorithm.

Updated about 3 hours ago