Adjust speaker EQ

📘

Only the HDX system supports this feature.

This tutorial shows how to adjust the speaker EQ for the audio bars of a Nureva® HDX system over the local network.

What is speaker EQ?

The gain for audio bars frequency (Low, Mid and High) can be configured for greater contol over sound tuning, allowing adjustments tailored to the room environment and personal preference. By default, the gain for each frequency is 0 but each frequency can be independently adjusted to a value between -8 and 12 inclusive.

For more information about speaker EQ, see HDX Speaker EQ↗

What can be controlled with the API?

The "speakerEqModes" property consists of two lists configuring the gains of the audio bars, one for "Conference" mode and one for "Music" mode.

• "Conference" mode: Nureva microphones are in use
• "Music" mode: Nureva microphones are not in use

The gains for the audio bars frequency can be adjusted for both speaker EQ modes.

• speakerEq: The gains for each frequency for the audio bar. Possible values are:
  • "low": -8 to 12
  • "mid": -8 to 12
  • "high": -8 to 12

To update the speaker EQ, all "speakerEqModes" settings must be sent in the request payload along with the speaker EQ frequency and gain values for each mode.

Minimum role required: general

The Get audio settings endpoint and Set audio settings endpoint can be accessed with the general role or any role of a higher level.

Overview

1. Use the Get audio settings endpoint to get the speaker EQ gains for each frequency.

2. Use the Set audio settings endpoint to make a request to adjust the gains for each frequency.

3. Use the Get audio settings endpoint to check that the change has been applied successfully.

Set the speaker EQ for the audio bars

Step 1 - Make a request to get the speaker EQ

Use the Get audio settings endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/audio.
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 audio settings for the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/audio \
     --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.
7. Look for "speakerEqModes" in the response payload. The example response below indicates the frequency and gain for each speaker EQ mode:

• The speaker EQ is configured separately for the "Conference" mode and the "Music" mode however, they contain the same attributes.

{
  "speakerEqModes": [
    {
      "mode": "Conference",
      "speakerEq": {
        "low": 0,
        "mid": 0,
        "high": 0
      }
    },
    {
      "mode": "Music",
      "speakerEq": {
        "low": 0,
        "mid": 0,
        "high": 0
      }
    }
  ]
}

Step 2 - Make a request to update the speaker EQ

Use the Set audio settings endpoint:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/audio.
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 updated speaker EQ. In this example, we will adjust the gains for the "low" and "high" frequency for "Conference" mode. Give "low" and "high" a value of "10". The code sample below is a request to update the speaker EQ gain for low and high frequency in Conference mode.

curl --request PATCH \
     --url https://10.0.0.1/api/v1/audio \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'\
     --header 'Content-type: application/json' \
     --data '{"speakerEqModes": [{"mode": "Conference","speakerEq": {"low": 10,"mid": 0,"high": 10}},{"mode": "Music","speakerEq": {"low": 0,"mid": 0,"high": 0}}]}'

7. Send the PATCH request.
8. 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 audio settings endpoint:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/audio.
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 audio settings for the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/audio \
     --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.
7. Check that the value of "speakerEqModes" matches the "speakerEqModes" sent in step 2.

The example below indicates that the change was successfully applied, for the PATCH call in step 2.

{
  "speakerEqModes": [
    {
      "mode": "Conference",
      "speakerEq": {
        "low": 10,
        "mid": 0,
        "high": 10
      }
    },
    {
      "mode": "Music",
      "speakerEq": {
        "low": 0,
        "mid": 0,
        "high": 0
      }
    }
  ]
}

✅

Tutorial complete!

You now know how to set the speaker EQ for the audio bars.