Set audio settings

patch

https://{nurevaDeviceIP}/api/v1/audio

Allows clients to set device audio settings, including the speaker treble level, the speaker bass level, and whether or not the microphone is muted. See the Audio Settings Details for more information on the attributes and expected values.

NOTE: The voiceAmplificationLevel attribute supports values ranging from 0 to 40. The recommended operating range is 0 dB to 20 dB, which corresponds to endpoint values between 10 and 30.

Set one or more audio setting attributes on the request body.

Minimum role required: general

Example Request Body

{
    "microphoneMute": true,
    "speakerBassLevel": 60,
    "speakerTrebleLevel": 70,
    "echoReductionLevel": "Low"
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

Nureva-Client-Id

string

required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

Nureva-Client-Version

string

required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Body Params

microphoneMute

boolean

True for mute or false for unmute on the device microphone.

microphonePickupState

string

enum

Configure the microphone system to be mono input or stereo input.

Allowed:

microphoneGain

integer

The microphone volume gain setting adjusts the volume of the processed microphone signal that is sent from the Nureva system to the connected meeting room computer. -6 to +12

speakerBassLevel

integer

Sets the speakerBassLevel for the device. 0 to 100

speakerTrebleLevel

integer

Sets the speakerTrebleLevel for the device. 0 to 100

echoReductionLevel

string

enum

Select a lower setting if remote users notice that voices in the room are cutting out. If remote users can hear their own voices echoing, select a higher setting.

Allowed:

noiseReductionLevel

string

enum

Select a lower setting if remote users notice that voices in the room are cutting out. If remote users hear background noises such as HVAC systems or fans, select a higher setting.

Allowed:

auxiliaryOutputState

string

enum

Select an auxiliary output mode for interoperability with other audio systems.

Allowed:

voiceAmplificationEnabled

boolean

Enable or disable Adaptive Voice Amplification.

voiceAmplificationLevel

integer

Adjust the Adaptive Voice Amplification Level. Supports values from 0 to 40. The recommended operating range is 0 dB to 20 dB, which corresponds to endpoint values between 10 and 30.

voiceAmplificationAuxInLevel

string

enum

The appropriate auxiliary level based on the wireless headset microphone manual. Mic or Line

Allowed:

dynamicBoostEnabled

boolean

Enable or disable Dynamic Boost.

microphoneDuckingEnabled

boolean

Enable or disable Microphone Ducking.

adaptiveSoundModes

array of objects

Adjust the balance control settings for Conference mode and Music mode

adaptiveSoundModes

speakerEqModes

array of objects

Defines the levels for the speaker equalizer settings for Conference mode and Music mode

speakerEqModes

noiseSuppressionEnabled

boolean

Enable or disable the noise suppression feature.

Responses

200

Success

400Bad request. The request body is invalid.

401Unauthorized. Invalid or missing credentials

409Conflict error. Current device is not supported for this endpoint

429Too many requests. Rate limit is exceeded

500Internal Server Error. Unexpected error has occurred.