Mute the microphone

This tutorial shows how to mute and unmute the microphone for Nureva® HDL310 and HDL410 devices over the local network.

📘

The microphoneMute attribute is a setting, not a toggle. Attempting to mute an already muted microphone or unmute a not-muted microphone will not change the setting.

Overview

1. Use getControlSettings to make a request to get the current microphone mute setting on the audio device

2. Use setControlSettings to make a request to mute or unmute the microphone

3. Check that the change has been applied successfully

Instructions

Step 1 - Create a command to get the current microphone setting

1. Pass "v1/devices/commands/getControlSettings" in to the "request" property
2. Fill in requestId and clientId according to the request format guide
3. Add the property "attributes" to the body property
   • The attribute property is a list of attributes that will be returned in the response
   • Add "microphoneMute" to the list
4. Send the request

The example request below will retrieve the current microphone mute setting.

{
  "request": "v1/devices/commands/getControlSettings",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
  "clientId": "Extron",
  "body": {
    "attributes": ["microphoneMute"]
  }
}

The example response below indicates that the microphone is not currently muted.

{
  "request": "v1/devices/commands/getControlSettings",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
  "clientId": "Extron",
  "body": {
    "microphoneMute": false
  }
}

Step 2 - Create a command to mute or unmute the microphone

1. Pass "v1/devices/commands/setControlSettings" in to the "request" property
2. Fill in requestId and clientId according to the request format guide
3. Add the property "microphoneMute" to the body property
4. Give "microphoneMute" a value of either true or false
   • Use 'true' to mute the microphone
   • Use 'false' to unmute the microphone
5. Send the request

The example below will mute the microphone.

{
  "request": "v1/devices/commands/setControlSettings",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
  "clientId": "test",
  "body": {
    "microphoneMute": true
  }
}

Step 3 - Check that the change has been applied successfully

• Use the requestId to identify the response associated with your request. The requestId in the request and response should match up.
• If the request was successful, the request, requestId and clientId will be echoed back as a response
• If the request was unsuccessful, the request, requestId and clientId will be echoed back along with an error property, which will include details about the error

The example below indicates that the change was successfully applied.

{
  "request": "v1/devices/commands/setControlSettings",
  "requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
  "clientId": "test"
}

✅

Tutorial complete!

You now know how to view and make changes to the microphone mute setting.