Identify audio components

This tutorial shows how to identify the audio components of Nureva® devices over the local network.

What does audio component identification do?

Audio component identification helps users determine which component is which and understand their orientation within the room. In the Nureva app there are several places in which audio components are labelled according to the port they are plugged into. However, it can be challenging to remember which component is connected to which port, and users need to feel confident that they are adjusting the correct audio component in the room. The audio component identification endpoint provides an easy way to figure it out.

Audio component identification looks slightly different for different audio device types.

HDL310

Since HDL310 systems only have one audio component, this is the simplest scenario. When audio component identification takes place, the single microphone and speaker bar will have one LED turn on.

HDL410

For HDL410 devices, both microphone and speaker bars are identified with one request to the endpoint. When audio component identification takes place, the speaker bar plugged into port 1 will have one LED turn on, and the speaker bar plugged into port 2 will have two LEDs turn on.

For more information, see Identifying HDL410 microphone and speaker bars — Nureva App.

HDX

HDX systems can have up to six audio components, and is identified one component at a time. When the endpoint is called, a port number is required in the request body to select which audio component to identify. The selected audio component will then light up, and if it is an audio bar play a series of sounds

Minimum role required: integrator

The Identify Audio Components endpoint can be accessed with the integrator role or any role of a higher level.

Overview

1. Use Identify Audio Components to identify the audio components.
2. Check that the request was successful.

Instructions

Step 1 - Make a request to identify the audio components

Use the Identify Audio Components endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/audio/identify.
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. If the audio device is HDX, update the headers to include Content-type as key and application/json as value.
6. If the audio device is HDX, update the request body to send a JSON object with "port":1 to identify the audio component plugged into port 1. The value for port must be between 1 and 6. NOTE: For HDL310 and HDL410 systems, a port should not be provided.

HDL310 and HDL410

curl --request POST \
     --url https://10.0.0.1/api/v1/audio/identify \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

HDX

curl --request POST \
     --url https://10.0.0.1/api/v1/audio/identify \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1' \
     --header 'Content-type: application/json' \
     --data '{"port":1}'

7. Send the POST request.

Step 2 - Check that the request was successful

After sending a request to the Identify Audio Components endpoint, look at the returned HTTP status code. If the call is successful, an HTTP status code of 200 OK will be returned as a response, with an empty object response body ({}). In the case of HDL310 and HDL410 devices, all audio components would have lit up. In the case of HDX, for the example request above, the audio component plugged into port 1 would have lit up, and if it was an audio bar it would have made a series of sounds as well.

✅

Tutorial complete!

You now know how to identify the audio components of a Nureva audio device.