Get camera switching configuration

📘

This feature is supported by HDL410 and HDX systems.

This tutorial shows how to get camera switching configuration for the room where Nureva® audio devices are located.

What information is available?

• cameraSwitcherDefaults:
  • defaultCameraInputPort: The default camera to be used when no audio has been detected in the camera zones. Possible values are "USB1", "USB2", and "HDMI".
  • zonesTriggerWaitTime: Minimum duration of time that sound is required in a zone to trigger a camera switch in milliseconds.
  • switchToDefaultWaitTime: Maximum duration of time when no sound is detected to trigger a switch back to the default camera in milliseconds.
• cameraSwitcherZoneInputMaps: An array of mappings of a zone to the camera that should be used when audio is detected within the zone.
  • zoneId: The id of the camera zone.
  • inputPort: The camera to be used. Possible values are "USB1", "USB2", and "HDMI".

The Get zones tutorial can be used to retrieve camera zones information.
The Set zones tutorial can be used to configure the camera zones.

Minimum role required: general

The Get Room Layout endpoint can be accessed with the general role or any role of a higher level.

Overview

1. Use the Get Room Layout endpoint to get the camera switching configuration.
2. Check that the request was successful and parse the response.

Instructions

Step 1 - Send a request to get the camera switching configuration

Use the Get Room Layout Information endpoint to a make a request to get the camera switching configuration for the room where the Nureva® audio conferencing system is connected:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/room/layout.
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 camera switching configuration for the room of the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/room/layout \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 2 - Parse the response

The example response below indicates that:

• The default camera for when no audio has triggered a camera zone is the camera plugged into the USB1 port.

• The minimum duration of time for a sound to trigger a camera switch is 1000 ms.

• If 5000 ms has passed without a sound triggering a camera zone, the camera will switch to the default camera.

• There are three camera zones with ids "c2c4ac7a-e153-419d-bc5c-95b3190e62d7", "898f31e7-f72c-478f-ba62-4c7a058e7081", and "2dcd4c2c-1460-4c25-8f26-960ed802ac84".

• The zone with id "c2c4ac7a-e153-419d-bc5c-95b3190e62d7" maps to the camera plugged into the USB1 port.

• The zone with id "898f31e7-f72c-478f-ba62-4c7a058e7081" maps to the camera plugged into the USB2 port.

• The zone with id "2dcd4c2c-1460-4c25-8f26-960ed802ac84" maps to the camera plugged into the HDMI port.

{
  "cameraSwitcherDefaults": {
    "defaultCameraInputPort": "USB1",
    "zonesTriggerWaitTime": 1000,
    "switchToDefaultWaitTime": 5000
  },
  "cameraSwitcherZoneInputMaps": [
    {
      "zoneId": "c2c4ac7a-e153-419d-bc5c-95b3190e62d7",
      "inputPort": "USB1"
    },
    {
      "zoneId": "898f31e7-f72c-478f-ba62-4c7a058e7081",
      "inputPort": "USB2"
    },
    {
      "zoneId": "2dcd4c2c-1460-4c25-8f26-960ed802ac84",
      "inputPort": "HDMI"
    }
  ]
}

✅

Tutorial complete!

You now know how to get the camera switching configuration.