Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
PTZ

Retrieves the PTZ settings for the given camera.

get/cameras/{cameraId}/ptz/settings

Response

OK

homePresetstring nullable

Name of the default preset to which the camera will return if set to homeReturn after the specified auto start delay.

mode'homeReturn' | 'tour' | 'manualOnly'

The following modes are available:

  • manualOnly: The PTZ camera will only move when issued a direct command by the user.
  • homeReturn: After a specified amount of time without receiving a command, the PTZ camera will navigate back to the home preset position. If none is set, this will be the factory default position.
  • tour: After the specified auto start delay, the PTZ camera will tour through all presets in the order specified by the user. It will continue doing so until interrupted and will resume after the aforementioned auto start delay.
autoStartDelayinteger

The time in seconds after which the PTZ camera should resume Touring or return to Home when idling.

Example response

{
  "presets": [
    {
      "name": "Preset 1"
    }
  ],
  "homePreset": "Preset 1"
}