5.8.1 api camera caps

The /api/camera/caps function returns a list of available video sources and resolution options for JPEG snapshots to be downloaded via the /api/camera/snapshot function.

The function is part of the Camera service and the user must be assigned the Camera Monitoring privilege for authentication if required.

The GET or POST method can be used for this function.

The function has no parameters.

The reply is in the application/json format and includes a list of supported resolutions of JPEG snapshots (jpegResolution) and a list of available video sources (sources), which can be used in the /api/camera/snapshot parameters.

Parameter

Description

width, height

Snapshot resolution in pixels

source

Video source identifier

Example:

GET /api/camera/caps
{
  "success" : true,
  "result" : {
    "jpegResolution" : [
      {
        "width" : 160,
        "height" : 120
      },
      {
        "width" : 176,
        "height" : 144
      },
      {
        "width" : 320,
        "height" : 240
      },
      {
        "width" : 352,
        "height" : 272
      },
      {
        "width" : 352,
        "height" : 288
      },
      {
        "width" : 640,
        "height" : 480
      }
    ],
    "sources" : [
      {
        "source" : "internal"
      },
      {
        "source" : "external"
      }
    ]
  }
}