Cloud APIsLocal APIs
Local Documentation
nureva.com

Voice Amplification Mode

Suggest Edits

This tutorial shows how to enable and use Voice Amplification Mode for Nureva® HDL310 and HDL410 devices over the local network. For devices with firmware version 1.9 or later, it is recommended the microphone ducking feature is used with Voice Amplification Mode for best performance.

As of firmware version 1.9, microphone ducking can be enabled through the API. Microphone ducking is a setting that prevents dual audio signals when a wireless headset is used to amplify a presenter’s voice, which elevates the experience for remote listeners. After a wireless headset is connected, this feature typically only needs to be set once.

Dynamic boost is also available with Voice Amplification Mode. For more information, see Learn more about using dynamic boost with voice amplification↗

For more information about voice amplification, see Voice Amplification Mode - HDL410 System↗

What can be controlled with the API?

The local control API provides the ability to enable Voice Amplification Mode and microphone ducking on the Nureva audio device.

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 Get Audio Settings to make a request to get the current voice amplification setting on the audio device.

  2. Use Set Audio Settings to make a request to turn on or turn off the Voice Amplification Mode.

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

  4. Use Set Audio Settings to make a request to turn on or turn off the microphone ducking feature.

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


Instructions

Step 1 - Make a request to get the current voice amplification 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 voiceAmplificationEnabled attribute.

The example response below indicates that Voice Amplification Mode is currently disabled.

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

Step 2 - Make a request to enable or disable Voice Amplification Mode

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 "voiceAmplificationEnabled" to the body property.
  7. Give "voiceAmplificationEnabled" a value of true to enable it and false to disable it. The code sample below is a request to enable voice amplification.
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 '{"voiceAmplificationEnabled":true}'
  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 voiceAmplificationEnabled attribute.

The example below indicates that the change (enable Voice Amplification Mode) was successfully applied.

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

Step 4 - Make a request to enable or disable microphone ducking

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 "microphoneDuckingEnabled" to the body property.
  7. Give "microphoneDuckingEnabled" a value of true to enable it and false to disable it. The code sample below is a request to enable microphone ducking.
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 '{"microphoneDuckingEnabled": true}'
  1. Send the PATCH request.
  2. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 5 - 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 microphoneDuckingEnabled attribute.

The example below indicates that the changes were successfully applied.

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

✅

Tutorial complete!

You now know how to view and make changes to the voice amplification settings.

Updated 12 days ago