Standard Topics

To read about the topic and source see Terminology

The currently available default topics are described below.

com.axis.analytics_scene_description.v0.beta

A frame-based description of what the camera sees. One message will contain all objects with attributes observed at a single point in time. Multichannel cameras with support for analytics will have multiple sources. Separate subscriptions with the video_channel_number as source can then be used.

To include a cropped image of detected objects in the metadata output see Enabling Best Snapshot feature.

Example data

Note: This is a beta format and will change in future releases.

{
  "frame": {
    "timestamp": "2023-03-08T09:00:19.320111Z",
    "observations": [
      {
        "track_id": "1",
        "bounding_box": {
          "bottom": 0.89332,
          "left": 0.13332,
          "right": 0.80004,
          "top": 0.59942
        },
        "class": {
          "type": "Human",
          "score": 0.6,
          "upper_clothing_colors": [
            {
              "name": "White",
              "score": 0.78
            }
          ],
          "lower_clothing_colors": [
            {
              "name": "Blue",
              "score": 0.59
            }
          ]
        },
        "image": {
          "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD",
          "bounding_box": {
            "bottom": 0.937405,
            "left": 0.033312,
            "right": 0.900048,
            "top": 0.555335
          }
        }
      },
      {
        "track_id": "2",
        "bounding_box": {
          "bottom": 0.49932,
          "left": 0.23135,
          "right": 0.55192,
          "top": 0.19399
        },
        "class": {
          "type": "Bus",
          "score": 0.7,
          "colors": [
            {
              "name": "Yellow",
              "score": 0.78
            }
          ]
        },
        "image": {
          "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD",
          "bounding_box": {
            "bottom": 0.5451195,
            "left": 0.1832645,
            "right": 0.6000055,
            "top": 0.1481905
          }
        }
      }
    ],
    "operations": [
      {
        "type": "DeleteOperation",
        "id": "3"
      }
    ]
  }
}

com.axis.consolidated_track.v1.beta

An object-based description of what the camera has seen over time. One message will contain a single object with consolidation of attributes over the frames it was observed. Multichannel cameras with support for analytics will have multiple sources. Separate subscriptions with the video_channel_number as source can then be used.

To include a cropped image of detected objects in the metadata output see Enabling Best Snapshot feature.

Example data

Note: This is a beta format and will change in future releases.

{
    "classes": [
        {
            "lower_clothing_colors": [
                {
                    "name": "Blue",
                    "score": 0.388
                },
                {
                    "name": "Black",
                    "score": 0.376
                }
            ],
            "score": 0.744,
            "type": "Human",
            "upper_clothing_colors": [
                {
                    "name": "Black",
                    "score": 0.57
                },
                {
                    "name": "Gray",
                    "score": 0.305
                },
                {
                    "name": "White",
                    "score": 0.293
                }
            ]
        }
    ],
    "duration": 0.9981,
    "end_time": "2024-05-13T15:21:40.319053Z",
    "id": "5b8b4da4-bd35-41e6-b4d3-564b761727d7",
    "image": {
        "bounding_box": {
            "bottom": 1.0,
            "left": 0.5146,
            "right": 0.5495,
            "top": 0.8789
        },
        "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD",
        "timestamp": "2024-05-13T15:21:40.319053Z"
    },
    "observations": [
        {
            "bounding_box": {
                "bottom": 0.9983,
                "left": 0.5255,
                "right": 0.5482,
                "top": 0.8974
            },
            "timestamp": "2024-05-13T15:21:39.889602Z"
        },
        {
            "bounding_box": {
                "bottom": 0.9983,
                "left": 0.5249,
                "right": 0.5469,
                "top": 0.8954
            },
            "timestamp": "2024-05-13T15:21:39.986261Z"
        },
        {
            "bounding_box": {
                "bottom": 0.9968,
                "left": 0.5239,
                "right": 0.5457,
                "top": 0.8924
            },
            "timestamp": "2024-05-13T15:21:40.087491Z"
        },
        {
            "bounding_box": {
                "bottom": 0.9951,
                "left": 0.522,
                "right": 0.5442,
                "top": 0.8899
            },
            "timestamp": "2024-05-13T15:21:40.185881Z"
        },
        {
            "bounding_box": {
                "bottom": 0.9935,
                "left": 0.5211,
                "right": 0.543,
                "top": 0.8854
            },
            "timestamp": "2024-05-13T15:21:40.319053Z"
        }
    ],
    "start_time": "2024-05-13T15:21:39.320982Z"
}

Enabling Best Snapshot feature in the metadata output

The Best Snapshot feature is enabled by sending the following command to the camera:

curl --noproxy '*' --digest --user <user>:<password> "http://<camera-ip>/config/rest/best-snapshot/v1/enabled" -H "Content-Type: application/json" -X PUT --data "{\"data\":true}"

Or use the Swagger UI:

http://<camera-ip>/config/web-ui/swagger-ui/?url=/config/discover/apis/best-snapshot/v1/openapi.json#/best-snapshot.v1beta/patch_best_snapshot_v1beta_enabled

to set the /best-snapshot/v1beta/enabled to true.