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

Adjust treble and bass

This tutorial shows how to adjust the treble and bass levels for Nureva® HDL200, HDL300, Dual HDL300, HDL310 and HDL410 devices over the local network. Adjusting treble and bass levels may affect speaker settings and audio conferencing presets.

For more information about speaker setting presets, see Adjusting speaker settings with the Nureva App↗

For more information about audio conferencing presets, see Using audio conferencing presets - Nureva App↗

What can be controlled with the API?

The local control API provides the ability to adjust the treble and bass levels, from 0 to 100, on a Nureva audio device. The Get Audio Settings endpoint is used to retrieve all the configurable audio settings. The Set Audio Settings endpoint is used to set one or more audio settings.

The examples below show how to adjust treble and bass using separate Set Audio Settings endpoint calls, but both settings can be set in one request (if attributes for both are added on the same request body).

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

Adjust treble

  1. Use Get Audio Settings to make a request to get the current treble setting on the audio device.

  2. Use Set Audio Settings to make a request to adjust the treble.

  3. Use Get Audio Settings to check that the change has been applied successfully.

Adjust bass

  1. Use Get Audio Settings to make a request to get the current bass setting on the audio device.

  2. Use Set Audio Settings to make a request to adjust the bass.

  3. Use Get Audio Settings to check that the change has been applied successfully.


Adjust treble

Step 1 - Make a request to get the current treble setting

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

The example response below indicates that the treble is currently set to 90.

{
  "microphoneMute": false,
  "microphonePickupState": "Mono",
  "microphoneGain": 3,
  "speakerTrebleLevel": 90,
  "speakerBassLevel": 16,
  "speakerVolume": 14,
  "echoReductionLevel": "Medium",
  "noiseReductionLevel": "Medium",
  "auxiliaryOutputState": "LineLevel",
  "voiceAmplificationEnabled": false,
  "voiceAmplificationLevel": 25,
  "voiceAmplificationAuxInLevel": "Line",
  "dynamicBoostEnabled": false,
  "microphoneDuckingEnabled": false
}

Step 2 - Make a request to adjust the treble

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. Add the property "speakerTrebleLevel" to the body property.
  7. Give "speakerTrebleLevel" a value of between 0 and 100. The code sample below is a request to set the treble level to 75.
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 '{"speakerTrebleLevel":75}'
  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 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 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'
  1. If the call is successful, an HTTP status code of 200 OK will be returned.
  2. Check the value of the speakerTrebleLevel attribute.

The example below indicates that the change (to adjust treble) was successfully applied.

{
  "microphoneMute": false,
  "microphonePickupState": "Mono",
  "microphoneGain": 3,
  "speakerTrebleLevel": 75,
  "speakerBassLevel": 16,
  "speakerVolume": 14,
  "echoReductionLevel": "Medium",
  "noiseReductionLevel": "Medium",
  "auxiliaryOutputState": "LineLevel",
  "voiceAmplificationEnabled": false,
  "voiceAmplificationLevel": 25,
  "voiceAmplificationAuxInLevel": "Line",
  "dynamicBoostEnabled": false,
  "microphoneDuckingEnabled": false
}

Adjust bass

Step 1 - Make a request to get the current bass setting

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

The example response below indicates that the bass is currently set to 16.

{
  "microphoneMute": false,
  "microphonePickupState": "Mono",
  "microphoneGain": 3,
  "speakerTrebleLevel": 90,
  "speakerBassLevel": 16,
  "speakerVolume": 14,
  "echoReductionLevel": "Medium",
  "noiseReductionLevel": "Medium",
  "auxiliaryOutputState": "LineLevel",
  "voiceAmplificationEnabled": false,
  "voiceAmplificationLevel": 25,
  "voiceAmplificationAuxInLevel": "Line",
  "dynamicBoostEnabled": false,
  "microphoneDuckingEnabled": false
}

Step 2 - Make a request to adjust the bass

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. Add the property "speakerBassLevel" to the body property.
  7. Give "speakerBassLevel" a value of between 0 and 100. The code sample below is a request to set the bass level to 80.
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 '{"speakerBassLevel":80}'
  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 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 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'
  1. If the call is successful, an HTTP status code of 200 OK will be returned.
  2. Check the value of the speakerBassLevel attribute.

The example below indicates that the change (to adjust bass) was successfully applied.

{
  "microphoneMute": false,
  "microphonePickupState": "Mono",
  "microphoneGain": 3,
  "speakerTrebleLevel": 90,
  "speakerBassLevel": 80,
  "speakerVolume": 14,
  "echoReductionLevel": "Medium",
  "noiseReductionLevel": "Medium",
  "auxiliaryOutputState": "LineLevel",
  "voiceAmplificationEnabled": false,
  "voiceAmplificationLevel": 25,
  "voiceAmplificationAuxInLevel": "Line",
  "dynamicBoostEnabled": false,
  "microphoneDuckingEnabled": false
}

✅

Tutorial complete! You now know how to view and make changes to the treble and bass settings.

Updated 8 days ago