Loitering guard

Description

AXIS Loitering Guard is an AXIS Camera Application Platform (ACAP) product for AXIS network cameras. Loitering Guard supports fixed cameras, PTZ cameras and encoders. The ACAP makes it possible for the user to define a guarded zone by setting up one or more areas in which loitering should be detected.

The ACAP makes it possible for the user to:

configure three loitering detection zones per channel for multichannel devices and up to ten in fixed mode and PTZ mode.
configure a set of rules for the chosen areas.
configure so that an event is only triggered if the object adheres to certain dimensional constraints or if it is not classified as a swaying object.

The Loitering Guard API is used for configuring the behavior of the ACAP. It is possible to configure where and if a detected object should trigger an alarm.

There is support for ONVIF motion alarm event.

Methods

The API consists of five methods:

getConfiguration - Get the complete ACAP configuration.
setConfiguration - Upload a complete ACAP configuration.
getSupportedVersions - Get the supported API versions.
sendAlarmEvent - Send a stateful alarm event for VMS testing purposes.
getConfigurationCapabilities - Get the boundaries and default values for the ACAP.

Identification

Software: EmbeddedDevelopment version 2.13 or higher is required for the ACAP to work.

Property: Properties.EmbeddedDevelopment.Version=2.13

In order to check if the ACAP is installed, use /axis-cgi/applications/list.cgi, which shows the status of all installed ACAPs. It also lists the url to the configuration page and the license state of the ACAP.

Common examples

Backup and restore configuration

Use this example to backup the configurations in the camera, but also restore them without having to set each parameter individually.

1. Request the current configuration of the application:

[POST] http://myserver/local/loiteringguard/control.cgi

JSON input parameters

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration"
}

2. Parse the JSON response.

a. Success response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "data": {...}
}

b. Failure response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message"
  }
}

3. Validate current license state of the ACAP.

In order to post configurations to the ACAP the license key must be valid.

[GET] http://myserver/axis-cgi/applications/list.cgi

4. Restore settings:

Post the configuration as params using the same JSON structure from data received from previous a call.

[POST] http://myserver/local/loiteringguard/control.cgi

Request

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {...}
}

Configure all settings

Use this example to retrieve the most current configuration of the parameters, update their values and upload them to the application.

1. Request the current configuration of the application:

[POST] http://myserver/local/loiteringguard/control.cgi

JSON input parameters

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration"
}

2. Parse the JSON response.

a. Success response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "data": {...}
}

b. Failure response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message"
  }
}

3. Parse the JSON response:

The configured JSON object is modified according to setConfiguration.

4. Validate current license state of the ACAP.

In order to post configurations to the ACAP the licensekey must be valid.

[GET] http://myserver/axis-cgi/applications/list.cgi

5. Upload new settings:

Post the configuration as params using the same JSON structure from data received from the previous call.

[POST] http://myserver/local/loiteringguard/control.cgi

JSON input parameters

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {...}
}

a. Success response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "data": {...}
}

b. Failure response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message"
  }
}

Visual feedback

Visualize alarming objects in live view and recorded video

Use this example to see all alarming objects in order to know what causes alarms in both the live view video as wall as in the recorded video.

1. Configure with overlayResolution and alarmOverlayEnabled.

[POST] http://myserver/local/motionguard/control.cgi

Request

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "params": {
    "cameras": [
      {
        "active": true,
        "id": 1,
        "rotation": r,
        "overlayResolution": "1280x720"
      }
    ],
    "profiles": [
      {
        "name": "Profile 1",
        "alarmOverlayEnabled": true,
        ...
      }
    ]
  }
}

Response

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "data": {...}
}

2. Validate the streams.

All video streams use the chosen resolution (e.g. 1280x720) and the specified rotation will have alarming objects with burnt in bounding boxes.

note

It is possible to request a video stream that ignores the alarm overlay despite using the chosen resolution. If the stream parameter overlays is set to either none or dynamic the overlay from the application is not shown.

rtsp://<IP-ADRESS>/axis-media/media.amp?resolution=1280x720&overlays=off

Read the configuration capabilities

Use this example to retrieve the boundaries and default values of all the parameters that are needed to create a flexible and useful user interface.

1. Request the configuration capabilities of the application:

[POST] http://myserver/local/loiteringguard/control.cgi

JSON input parameters

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

2. Parse the JSON response.

a. Success response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "data": {...}
}

b. Failure response example.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message"
  }
}

The configured JSON object is modified according to getConfigurationCapabilities.

Changes between apiVersion 1.2 to 1.3

Adds support for alarm overlays, which includes two new optional fields in the configuration of the application.

API specification

All APIs uses the same CGI-call, using the method property to decide the operation to perform on the data.

The different APIs uses the same error code patterns.

Error codes from 1000 to 1999 are reserved for camera application (server) errors, e.g. could not read configuration from file. The actual cause can be seen in the server-log, and the problem could in some cases be solved by restarting the camera.

Error codes from 2000 to 2999 are reserved for client errors, e.g. wrong format on the configuration file or an invalid parameter. These errors should be possible to solve by changing the input data to the API.

Error code 8000 indicates that the camera is not supported by this version of the application. This should be possible to solve by downloading the version of the application designed for the camera type.

Error codes from 9000 to 9999 are reserved for license related errors, e.g the current license is invalid or missing. These errors should be possible to solve by uploading a new license file for the ACAP.

getConfiguration

Request the current configuration of the ACAP.

Request

http://<servername>/local/loiteringguard/control.cgi

Security level: Administrator
Method: POST

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration"
}

Parameter	Description
`apiVersion`	The API version that the response should use.
`context`	Optional The client sets this value and the server copies it into the response. It is present regardless of whether the request succeeded or failed.
`method`	Specifies that the `getConfiguration` operation is performed.

Return value - Success

Returns the current configuration of the ACAP in a JSON formatted response. In the following examples the values d, w, h, t, x, y, p and r are numbers. For a complete description of each field in the configuration see Configuration parameter description.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "data":
  {
    "cameras":
    [
      {"active": true, "id": 1, "rotation": r, "overlayResolution": resolution}
    ],
    "profiles":
    [
      {
        "name": "Profile 1",
        "uid": 1,
        "camera": 1,
        "alarmOverlayEnabled": true,
        "filters":
        [
          {"type": "sizePerspective", "data": [w,h], "active": true},
          {"type": "sizePercentage", "data": [w,h], "active": false},
          {"type": "distanceSwayingObject", "data": d, "active": true},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]}
        ],
        "triggers": [
          {"type": "loiteringArea",
          "data": [[x,y], ..., [x,y]],
          "conditions": [
            {"type": "individual", "data": 20, "active": true},
            {"type": "group", "data": 20, "active": false}
          ]
        }
      ],
      "presets": [p],
      "perspective":
        [
          {"type": "bar", "data": [ [x,y], [x,y] ], "height": h},
          {"type": "bar", "data": [ [x,y], [x,y] ], "height": h},
          {"type": "bar", "data": [ [x,y], [x,y] ], "height": h}
        ]
      },
      {...},
      {...},
      {...}
    ],
  "configurationStatus": 0
  }
}

note

Channel specific properties are set in data.cameras. However, each profile has its individual settings, and also refers to a camera id property with the data.profiles[j].camera property. The parameter "presets" is not present however, as it is only supported for mechanical PTZ-cameras.

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "data":
  {
    "cameras":
    [
      {"active": true, "id": 1, "rotation": r, "overlayResolution": resolution1},
      {"active": false, "id": 2, "rotation": r, "overlayResolution": resolution2},
      {"active": false, "id": 3, "rotation": r, "overlayResolution": resolution3},
      {"active": false, "id": 4, "rotation": r, "overlayResolution": resolution4}
    ],
    "profiles":
    [
      {
        "name": "Profile 1 (Video 1)",
        "uid": 1,
        "camera": 1,
        "alarmOverlayEnabled": true,
        "filters":
        [
          {"type": "sizePerspective", "data": [w,h], "active": true},
          {"type": "sizePercentage", "data": [w,h], "active": false},
          {"type": "distanceSwayingObject", "data": d, "active": true},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]}
        ],
        "triggers": [
          {"type": "loiteringArea", "data": [[x,y], ..., [x,y]],
            "conditions": [
              {"type": "individual", "data": 20, "active": true},
              {"type": "group", "data": 20, "active": false}
            ]
          }
        ],
        "perspective":
        [
          {"type": "bar": "data": [[x,y], [x,y]], "height": h},
          {"type": "bar": "data": [[x,y], [x,y]], "height": h},
          {"type": "bar": "data": [[x,y], [x,y]], "height": h}
        ]
      },
      {
        "name": "Profile 2 (Video 3)",
        "uid": 2,
        "camera": 3,
        "alarmOverlayEnabled": false,
        "filters": {...},
        "triggers": {...},
        "perspective": {...}
      },
      {...},
      {...},
      {...}
    ],
    "configurationStatus": 0
  }
}

Return value - Error

Return value XXXX is a number.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfiguration",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message."
  }
}

Error	Code	Description
`Application Error`	1000	The application failed to return a configuration.
`Unsupported Version`	2000	The major version number isn’t supported.
`Invalid Format`	2001	The request was not correctly formatted, i.e. it does not follow the JSON-schema.
`Unsupported Product`	8000	The product is not supported by this application.

setConfiguration

Sets the configuration of the application. The application is not restarted, meaning that any ongoing event will be set as inactive when the new configuration is applied. This will cause ongoing recordings to stop, and for multichannel products, all cameras will be simultaneously affected.

There is a size limitation on POST transfer request which makes it suitable to send a minified JSON structure without white-spaces and new lines.

Modify specific properties

Below are some examples for how to change the values in the JSON file to perform specific actions. In the examples i is an index in the profile-array, not the uid of the profile.

Enable alarm overlay

In order to enable alarm overlay for a profile the resolution has to be specified for the camera in params.cameras[i].overlayResolution. Supported resolutions are listed by the getConfigurationCapabilities method. These resolution will change if the capture mode in the camera is changed.

Each profile connected to a camera can be specified to visualize its alarming objects in the video by activating params.profiles[i].alarmOverlayEnabled.

"cameras": [{
  "active": true,
  "id": 1,
  "rotation": r,
  "overlayResolution": "1280x720"
}],
  "profiles": [{
  "name": "Profile 1",
  "camera": 1,
  "alarmOverlayEnabled": true,
  ...
  }
]

Set image rotation

The image rotation for which the configuration is done should be specified in params.cameras[i].rotation. Valid values are (0, 90, 180, 270), which corresponds to the rotation of the camera.

Modify loitering area

To change the loitering area, i.e. the determined zone of detection, of a profile consisting of n connected straight lines the client must first connect the points [x0, y0], [...], [xn, yn]. Then, to trigger individual objects, the client must change the property params.profiles[i].triggers to:

"triggers": [
  {"type": "loiteringArea", "data": [[x,y], ..., [x,y]],
    "conditions": [
      {"type": "individual", "data": 20, "active": true}
    ]
  }
]

Note that the individual and group conditions cannot be active at the same time.

Modify exclude areas

To add an exclude area for a profile consisting of n connected straight lines, which in turn are connecting the points [x0, y0], ..., [xn,yn]. The property params.profiles[i].filters should then be changed to:

"filters":
[
  {"type": "excludeArea", "data": [[x0,y0], ..., [xn,yn]]},
  ...
]

Note that the exclude area object is removed if the exclude area is not in use.

Modify size perspective filter

In order to apply a size perspective filter with width w and height h and two perspective bars with height h1 and h2 that are located at [x11, y11], [x12, y12] and [x21, y21], [x22, y22] respectively, both the params.profiles[i].perspective and the size filter has to be modified.

The perspective bars are added by changing params.profiles[i].perspective to

"perspective":
[
  {"type": "bar", "data": [[x11, y11], [x12, y12]], "height": h1},
  {"type": "bar", "data": [[x21, y21], [x22, y22]], "height": h2},
]

The size filter in params.profiles[i].filters should then be modified to:

"filters":
[
  {"type": "sizePerspective", "data": [w,h], "active": true},
  ...
]

The filter values width w and height h as well as the heights of the perspective bars should be given in cm. Note that only one size filter can active at any given time, meaning that sizePercentage must be disabled if sizePerspective is used. It is also crucial that the camera rotation is the same as the rotation specified in the configuration. The filter will automatically be disabled when the camera rotation differs from the rotation in the configuration, however it will become active once again when they become equal. Hence, the order for uploading the configuration and setting the rotation parameter of the camera is not crucial.

Set percentage filter

To apply a percentage filter with height h and width w in percent of the image, params.profiles[i].filters should be modified to:

"filters":
[
  {"type": "sizePercentage", "data": [w,h], "active": true},
]

Note that only one size filter can be active, meaning that sizePerspective must be disabled if sizePercentage is used. The width and height of an object follows the camera rotation, and the direction used will change if the rotation parameter is changed. That is for a camera with a 640x360 resolution and a filter with width 10% and height 20% that corresponds to a box of 64x72 pixels if the camera rotation is 0 or 180 degrees. However, if the rotation is changed to 90 or 270 degrees, the same filter setting (width 10% and height 20%), corresponds to a box of 36x128 pixels.

Set swaying object filter

In order to set the swaying object filter value to d percent of the image params.profiles[i].filters should be modified to:

"filters":
[
  {"type": "distanceSwayingObject", "data": d, "active": true},
  ...
]

The filter value d determines how far an object has to move from its point of origin before it can trigger an alarm. It is given in percent of the image. Note that this is a global setting and will also delay alarms from all objects in the image with that distance, which could introduce missed alarms if the value is set too high.

Modify presets (only for PTZ cameras, PTZ encoders are not supported)

To change the presets of a profile change the property params.profiles[i].presets to:

"presets": [p]

where p is the id-number of the preset, the index value in the VAPIX-parameter PTZ.Preset.P0.Position.P<index>. The value can also be -1 for any-preset or -2 for anywhere.

Request

http://<servername>/local/loiteringguard/control.cgi

Security level: Administrator
Method: POST

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "params":
  {
    "cameras":
    [
      {"active": true, "id": 1, "rotation": r, "overlayResolution": resolution}
    ],
    "profiles":
    [
      {
        "name": "Profile 1",
        "uid": 1,
        "camera": 1,
        "alarmOverlayEnabled": true,
        "filters":
        [
          {"type": "sizePerspective", "data": [w,h], "active": true},
          {"type": "sizePercentage", "data": [w,h], "active": false},
          {"type": "distanceSwayingObject", "data": d, "active": true},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]},
          {"type": "excludeArea", "data": [[x,y], ..., [x,y]]}
        ],
        "triggers":[
          {"type": "loiteringArea", "data": [[x,y], ..., [x,y]],
            "conditions": [
              {"type": "individual", "data": 20, "active": true},
              {"type": "group", "data": 20, "active": false}
            ]
          }
        ],
        "presets": [p],
        "perspective":
        [
          { "type": "bar", "data": [ [x,y], [x,y] ], "height": h},
          { "type": "bar", "data": [ [x,y], [x,y] ], "height": h},
          { "type": "bar", "data": [ [x,y], [x,y] ], "height": h}
        ]
      },
      {...},
      {...},
      {...}
    ]
  }
}

Parameter	Description
`apiVersion`	The API version that the response should use.
`method`	Specifies that the `setConfiguration` operation is performed.
`context`	Optional Client sets this value and server echoes data back in the response. It is present regardless of whether the request succeeded or failed.
`params`	A complete application configuration. Note: To remove a profile, simply remove that profile object from the `params.profiles` array.

For a complete description of each field, see Configuration parameter description.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "data": {}
}

Note that successful calls contains en empty data object.

Return value - Error

Return value XXXX is a number.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "setConfiguration",
  "error":
  {
    "code":XXXX,
    "message": "A descriptive error message."
  }
}

Error	Code	Description
`Application Error`	1000	The application failed to set the configuration.
`Unsupported Version`	2000	The major version number isn’t supported.
`Invalid Format`	2001	The configuration was not formatted correctly, i.e. it does not follow the JSON-schema.
`Incoherent Format`	2002	Parts of the configuration contradicts each other, e.g. several profiles have the same `uid`.
`Missing Parameter`	2003	The request is missing a mandatory parameter.
`Invalid Parameter`	2004	The request has a parameter with an invalid value.
`Unsupported Product`	8000	The product is not supported.
`Invalid License`	9000	The license file is invalid or missing.

getConfigurationCapabilities

Request the boundaries and default values of the application.

Request

http://<servername>/local/loiteringguard/control.cgi

Security level: Administrator
Method: POST

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfigurationCapabilities"
}

Parameter	Description
`apiVersion`	The API version that the response should use.
`context`	Optional Client sets this value and server echoes data in the response. It is present regardless of whether the request succeeded or failed.
`method`	Specifies that the `getConfigurationCapabilities` operation is performed.

Return value - Success

Returns the boundaries and default values of the application in the form of a JSON formatted response. This CGI will always return the same result for one camera independent of when it is called, i.e. these values cannot be changed through a CGI. However, different cameras might return different result depending on their capabilities. In the following examples, the values p, q, r and z are numbers. For a complete description of each field in the configuration, see Configuration capabilities parameter description.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>"
  "method": "getConfigurationCapabilities",
  "data":
  {
    "filters":
    [
      {"type": "sizePercentage",
        "min": [width, height],
        "max": [width, height],
        "default": [width, height],
        "defaultActive": true
      },
      {"type": "distanceSwayingObject",
        "min": p,
        "max": q,
        "default": r,
        "defaultActive": true
      },
      {"type": "excludeArea",
        "min": [x,y],
        "max": [x,y],
        "minNbrVertices": p,
        "maxNbrVertices": q,
        "minNbrInstances": r,
        "maxNbrInstances": z,
        "defaultInstance": [[x,y], [x,y], [x,y], [x,y]]
      }
    ],
    "triggers":
    [
      {"type": "loiteringArea",
        "min": [x,y],
        "max": [x,y],
        "minNbrVertices": p,
        "maxNbrVertices": q,
        "minNbrInstances": r,
        "maxNbrInstances": z,
        "defaultInstance": [[x,y], [x,y], [x,y], [x,y]],
        "conditions": [
          {"type": "individual",
            "defaultActive": true,
            "default": p,
            "max": q,
            "min": r
          },
          {"type": "group",
            "defaultActive": false,
            "default": p,
            "max": q,
            "min": r
          }
        ]
      }
    ],
    "profiles":
    {
      "minNbrProfilesPerCamera": p,
      "maxNbrProfilesPerCamera": q,
      "minLengthName": r,
      "maxLengthName": z
    },
    "presets":
    {
      "maxNbrPresets": p,
      "defaultPreset": q
    }
  }
}

Return value - Error

Return value XXXX is a number.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "context": "<client context>",
  "method": "getConfigurationCapabilities",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message."
  }
}

Error	Code	Description
`Application Error`	1000	The application failed to return a configuration.
`Unsupported Version`	2000	The major version number isn’t supported.
`Invalid Format`	2001	The request was not formatted correctly, i.e. does not allow JSON-schema.
`Unsupported Product`	8000	The product is not supported by this application.

getSupportedVersions

Get a list of supported API versions for the application (one for each major version).

Request

http://<servername>/local/loiteringguard/control.cgi

Security level: Administrator
Method: POST

{
  "apiVersion": "1.3",
  "method": "getSupportedVersions",
  "context": "<client context>"
}

Parameter	Description
`apiVersion`	The API version that the response should use.
`method`	Specifies that the `getSupportedVersions` operation is performed.
`context`	Optional Client sets this value and the server echoes data back in the response. It is present regardless of whether the request succeeded or failed.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "method": "getSupportedVersions",
  "context": "<client context>",
  "data":
  {
    "apiVersions":["<Major1>.<Minor1>", "<Major2>.<Minor2>"]
  }
}

Parameter	Description
`apiVersion`	The API version that is used.
`apiVersion=<list of versions>`	List of supported versions, all major versions with highest supported minor version.
`<list of versions>`	List of "<Major>.<Minor>" versions, e.g. ["1.4", "2.5"].

Return value - Error

Return value XXXX is a number.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersions": "1.3",
  "method": "getSupportedVersions",
  "context": "<client context>",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message."
  }
}

Error	Code	Description
`Application Error`	1000	The application failed to return the supported versions.
`Unsupported Version`	2000	The major version number isn’t supported.
`Invalid Format`	2001	The request was not formatted correctly, i.e. does not follow the JSON-schema.
`Unsupported Product`	8000	The product is not supported by this application.

sendAlarmEvent

Introduction

By using this method, it is possible to send a stateful alarm event, both in the AXIS and ONVIF format, for the specific profile <uid>. The stateful alarm event is active for a few seconds. The response message will be returned immediately. This can be used by clients to check that the configuration is correct (e.g. that it starts recording). All events related to the profile will be sent, both in the AXIS and ONVIF format.

note

The profile will send events independent of its current state, i.e. in PTZ products, profiles that are connected to other than the current preset will also send events if triggered by the sendAlarmEvent method.

Request

http://<servername>/local/loiteringguard/control.cgi

Security level: Operator
Method: POST

{
  "apiVersion": "1.3",
  "method": "sendAlarmEvent",
  "context": "<client context>",
  "params"
  {
    "profile": <uid>
  }
}

Parameter	Description
`apiVersion`	The API version that is used.
`context`	Optional Client sets this value and the server echoes data in the response. It is present regardless of whether the request succeeded or failed.
`method`	Specifies that the `sendAlarmEvent` operation is performed.
`profile=<uid>`	Defines which profile that will send the loitering alarm event.
`<uid>`	The unique ID that each profile has. There must be a profile with the specified `uid`.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "method": "sendAlarmEvent",
  "context": "<client context>",
  "data": {}
}

Return value - Error

Return value XXXX is a number.

HTTP Code: 200 OK
Content-Type: application/json

{
  "apiVersion": "1.3",
  "method": "sendAlarmEvent",
  "context": "<client context>",
  "error":
  {
    "code": XXXX,
    "message": "A descriptive error message."
  }
}

Error	Code	Description
`Application Error`	1000	The application failed to handle the request.
`Unsupported Version`	2000	The major version number isn’t supported.
`Invalid Format`	2001	The request was not formatted correctly, i.e. invalid JSON-schema.
`Incoherent Format`	2002	Parts of the configuration contradicts each other, e.g. several profiles have the same `uid`.
`Missing Parameter`	2003	The request is missing a mandatory parameter.
`Invalid Parameter`	2004	The request has a parameter with an invalid value.
`Unsupported Product`	8000	The product is not supported by this application.
`Invalid License`	9000	The license file is invalid or missing.

Configuration parameter description

The structure of a configuration object is the same in both the data object in the response for getConfiguration and the params object in the request for setConfiguration. The structure is the same for single and multichannel products, where the cameras objects should mirror the different VAPIX camera properties. The only difference appears when PTZ cameras are used, in which case the parameter preset can be optionally included.

Example configuration

The following example configuration will be described in details in the table section below.

{
  "cameras":
  [
    {"active": bool, "id": 1, "rotation": r, "overlayResolution": resolution}
  ],
  "profiles":
  [
    {
      "name": "<client nice-name>",
      "uid": <uid>,
      "alarmOverlayEnabled": true,
      "camera": 1,
      "filters":
      [
        {"type": "sizePerspective", "data": [w,h], "active": true},
        {"type": "sizePercentage", "data": [w,h], "active": false},
        {"type": "distanceSwayingObject", "data": d, "active": true},
        {"type": "excludeArea", "data": [[x,y], ..., [x,y]]},
        {"type": "excludeArea", "data": [[x,y], ..., [x,y]]}
      ],
      "triggers":[
        {"type": "loiteringArea", "data": [[x,y], ..., [x,y]]},
          "conditions"[
            {"type": "individual", "data": 20, "active": true},
            {"type": "group": "data": 20, "active": false}
          ]
        }
      ],
      "presets": [1],
      "perspective":
      [
        {"type": "bar", "data": [[x,y], [x,y]], "height": h},
        {"type": "bar", "data": [[x,y], [x,y]], "height": h}
      ]
    },
    {...},
    {...},
    {...}
  ],
  "configurationStatus": 0
}

Parameter description table

All parameters and properties are considered mandatory unless otherwise specified. The default values for the filters and triggers are just recommended values. To get the values used by the application, see getConfigurationCapabilities.

The cameras objects contains general information that is the same for all of the profiles using that particular camera.

Property	Type	Default value	Valid values	Description
`cameras[i].active`	boolean	true	true, false	It is possible to have active profiles for the camera if set to `true`. All profiles for that camera are currently inactivated if set to `false`.
`cameras[i].id`	integer	1	1, ..., #Cameras	The corresponding camera value used when requesting a video using `media.amp`. Note that it starts at 1.
`cameras[i].rotation`	integer	0	0, 90, 180 or 270	The rotation of the camera in the plane of the camera, measured in degrees. Should match the property `Image.I<camera>.Appearance:Rotation`.
`cameras[i].overlayResolution`	string		<width>x<height>	The resolution of the video streams that will have the alarming objects burnt in as an alarm overlay. The parameter is optional if `profiles[j].alarmOverlayEnabled` is not active.

The profiles object information for each individual profile.

Property	Type	Default value	Valid values	Description
`profiles[j].name`	string	"Profile <uid>"		A unicode string that can be up to 15 characters long. It is part of the nice name of the event and is visible to the end user in the action rule list. Invalid character combinations are: [`&&`, `<`, `>`].
`profiles[j].camera`	int	1	1, 2, 3, ...,	Shall match the`id` of the corresponding camera in `cameras`.
`profiles[j].uid`	int	1	1, 2, 3, ...,	Shall be an unique ID for each profile.
`profiles[j].alarmOverlayEnabled`	int	false	true, false	`True` if the alarming objects of the profile is shown in alarm overlay video stream. The parameter is optional, and defaults to `false` if it is not present.
`profiles[j].filters`	array			An array of exclusion filters.
`profiles[j].triggers`	array			An array of triggers.
`profiles[j].presets`	array			An array with a single preset index number (optional). See Parameter presets Description below.
`profiles[j].perspective`	array	[]		An array of perspective objects.

The exclusion filters of profiles[j].filters have similar structures. The exclusion filters are all optional, and a filter is considered disabled if it is not present in the array profiles[].filters.

Property	Type	Valid values	Description
`profiles[j].filters[k].type`	string	see separate table	Specifies the type of exclusion filter.
`profiles[j].filters[k].data`			The data for the exclusion filters. The type differs for each exclusion filter.
`profiles[j].filters[k].active`	boolean	true, false	If the filter is active. Not applicable for exclude areas.

The data field for each exclusion filter.

Exclusion filter type	Type	Default value	Valid values	Description
`"sizePercentage"`	[int, int]	[5, 5]	[3..100, 3..100]	An array with width and height (`[w, h]`) in percent of the image. If the height and width of an object is measured as a percentage of the total camera view is lesser than, or equal, to the set values, it will not be able to raise an alarm.
`"sizePerspective"`	[int, int]			An array with width and height (`[w, h]`) in real-world size for an object in the scene. If the object’s width and height is below this value, it will not raise an alarm. The real-world height of the object is computed by comparing the pixel height of the object with the pixel height of the perspective bars. Since the perspective bars each have a real-world height assigned to them by the user, the corresponding height of the object can be computed using a linear equation. Two objects with the same height in pixel but at different horizontal positions will have different real-world heights.
`"distanceSwayingObject"`	int	5	3..10	Max distance object is allowed to sway without raising an alarm. The swaying distance is given in percent of the image.
`"excludeArea"`	[[float, float], ... [float, float]]		-1, .. 1	An exclude area is described as an array of points [[x0, y0], ..., [xn, yn]], where the unit are normalized to the size of the image, so that the visible view spans from -1 to 1 in both horizontal and vertical directions. Each profile can contain up to three exclude areas.

It is only possible to have the exclusion filter "sizePerspective" if there is a perspective. It is described by an array of perspective objects, that calibrates the view of the camera. The only type of perspective objects are bar.

The only type of trigger in Loitering Guard is loiteringArea. The array profiles[j].triggers should contain exactly one loitering area.

Property	Type	Valid values	Description
`profiles[j].triggers[0].type`	string	`"loiteringArea"`	Specifies that it is a Loitering area.
`profiles[j].triggers[0].data`	[[float, float], ..., [float, float]]	-1, ..., 1
`profiles[j].triggers[0].conditions`	[Condition]		An array of conditions that specifies when an alarm should be triggered.

Conditions

Condition type	Type	Default value	Valid values	Description
`individual`	int	120	10–360	Specifies that individual objects should trigger alarms, in seconds.
`group`	int	160	10–360	Specifies that an alarm should be triggered if any object is in the loitering area too long. This is measured in seconds.

Property	Type	Valid values	Description
`configurationStatus`	int	`INT_MAX`	This property is read-only and therefore ignored by `setConfiguration`. The initial value, 0, indicates a default configuration i.e. that no configuration has yet been set. Each time a configuration is set, the value is increased by one. Note that the value is reset to 1 after `INT_MAX` has been reached.
`profiles[j].perspective[k].type`	string	`bar`	Specifies that it is a perspective bar. Which is a vertical line in the rotation of the camera.
`profiles[j].perspective[k].data`	[[float, float], ..., [float, float]]	-1, ..., 1	Start and end points for a perspective bar. The start position should be the point that touches the ground-plane. The unit are normalized to the size of the image, so that the visible view spans from -1 to 1 in both the horizontal and vertical direction.
`profiles[j].perspective[k].height`	int		Real-world height of an object appearing at the same location and with the same perceived height in the camera view as the perspective bar.

Parameter presets Description

In apiVersion 1.1 the parameter profiles[j].presets is introduced as an array, which can contain at most one preset. The profile will not be connected to any presets if the presets array is empty, and will always be active, i.e. it is connected to "anywhere". The client is responsible for connecting a profile to an existing preset. Note that if the connected preset is deleted, there is no automatic handling for updating the configuration, and the parameter will cause an error in non PTZ-cameras.

The parameter is optional in PTZ-cameras, and if the parameter is omitted it is equivalent to an empty array, i.e. the profile is always active.

A parameter value for any-preset is -1 and for anywhere it is -2.

anywhere (value: -2): A profile that is connected to anywhere is always active, both if the PTZ-camera points at the preset or if it is manually moved away from it. Settings for such a general profile should be used with care to handle all different conditions, e.g. a large Loitering area and a small short-lived filter.
any-preset (value: -1): A profile that is connected to any-preset is active as long as the camera is at ANY preset, but not if it is manually moved away from the preset. This setting should also be used with care, however it is useful for connecting a general action rule, where false alarms are OK, e.g. turn on lights.

note

If all presets have a profile connected to them, one can use the event CameraXProfileANY to also capture triggers from all presets, where the settings can be adapted for each preset.

Property	Type	Default value	Valid values	Description
`profiles[j].presets`	array of int	[]	[-2], [-1], [], [1], [2], [3], ...	The index-number of the preset, e.g. 1 for parameter `PTZ.Preset.P0.Position.P1`. The value can be -1 for `any-preset` or -2 for `anywhere`.

Different apiVersion values foralarmOverlay parameters

apiVersion 1.3 introduced the parameters profiles[j].alarmOverlayEnabled and cameras[i].overlayResolution. They control if the alarms from a profile should be burnt into the video.

Worth noting is that the application should support clients using apiVersion 1.2 or older.

The values are enabled from a configuration using at least apiVersion 1.3. Later, if a client with apiVersion 1.2 or lower configures the application, the values for profiles[j].alarmOverlayEnabled and cameras[i].overlayResolution are ignored if present and the values from the existing configuration is used instead.

Configuration capabilities parameter description

The tables below describe the parameters in getConfigurationCapabilities.

AlarmOverlay

Introduced with apiVersion 1.3.

alarmOverlay

Property	Type	Description
`isSupported`	boolean	True, if the camera supports the burnt in alarm overlay feature.
`maxNbrActiveCameras`	int	The number of different cameras in a multichannel device that simultaneously can use the feature. The value is 0 if the feature is not supported.
`cameras`	[object, object]	A list of camera objects that describe the alarm overlay capabilities for each camera.

alarmOverlay.cameras[ ]

Property	Type	Description
`id`	int	Same as the parameter `cameras[i].id` in the configuration. The corresponding camera value used when requesting a video using `media.amp`. Note that it starts at 1.
`availableResolutions`	[string, string, ...]	A list of resolutions of the form `<width>x<height>` for which it is possible to use alarm overlay for the specific camera.

Filters

sizePercentage

Property	Type	Description
`min`	[int, int]	An array containing the minimum allowed width and height (`[w, h]`) in percent of the image.
`max`	[int, int]	An array containing the maximum allowed width and height (`[w, h]`) in percent of the image.
`default`	[int, int]	An array containing the default values of width and height (`[w, h]`) in percent of the image.
`defaultActive`	boolean	If the filter is active by default.

distanceSwayingObject

Property	Type	Description
`min`	int	The minimum allowed distance to sway.
`max`	int	The maximum allowed distance to sway.
`default`	int	The distance to sway.
`defaultActive`	boolean	If the filter is active by default.

excludeArea

Property	Type	Description
`min`	[int, int]	An array [xPos, yPos] with the minimum allowed values in the x- and y-direction to place the window.
`max`	[int, int]	An array [xPos, yPos] with the maximum allowed values in the x- and y-direction to place the window.
`minNbrVertices`	int	The minimum number of vertices the area may contain.
`maxNbrVertices`	int	The maximum number of vertices the area may contain.
`minNbrInstances`	int	The minimum allowed number of exclude areas.
`maxNbrInstances`	int	The maximum allowed number of exclude areas.
`defaultInstance`	[[x, y], [x, y], [x, y], [x, y]]	The default area, an array of arrays containing the default vertices.

Triggers

loiteringArea

Property	Type	Description
`min`	[int, int]	An array [xPos, yPos] with the minimum allowed values in the x- and y-direction to place the window.
`max`	[int, int]	An array [xPos, yPos] with the maximum allowed values in the x- and y-direction to place the window.
`minNbrVertices`	int	The minimum number of vertices the area may contain.
`maxNbrVertices`	int	The maximum number of vertices the area may contain.
`minNbrInstances`	int	The minimum allowed number of Loitering areas.
`maxNbrInstances`	int	The maximum allowed number of Loitering areas.
`defaultInstance`	[[x, y], [x, y], [x, y], [x, y]]	The default area, an array of arrays containing the default vertices.
`conditions`	[Condition]	An array of conditions to trigger alarms.

Conditions

individual

Property	Type	Value	Description
`type`	string	individual	A string that identifies the condition.
`max`	int	360	The maximum value for how many seconds an object can be inside the loitering area without triggering an alarm.
`min`	int	10	The minimum value for how many seconds an object can be inside the loitering area without triggering an alarm.
`default`	int	120	The default value for how many seconds an object can be inside the loitering area without triggering an alarm.
`defaultActive`	boolean	true	If the condition is default active or not.

group

Property	Type	Value	Description
`type`	string	group	A string that identifies the condition.
`max`	int	360	The maximum value for how many seconds any object can be inside the loitering area without triggering an alarm.
`min`	int	10	The minimum value for how many seconds any object can be inside the loitering area without triggering an alarm.
`default`	int	160	The default value for how many seconds any object can be inside the loitering area without triggering an alarm.
`defaultActive`	boolean	false	If the condition is default active or not.

Profiles

Property	Type	Description
`minNbrProfilesPerCamera`	int	The minimum number of profiles a configuration may contain.
`maxNbrProfilesPerCamera`	int	The maximum number of profiles a configuration may contain.
`minLengthName`	int	The minimum number of characters for a profile name.
`maxLengthName`	int	The maximum number of characters for a profile name.

Presets

Property	Type	Description
`maxNbrPresetsPerProfile`	int	The maximum number of presets a profile can be connected to.
`defaultPreset`	int	The preset that the profile is connected to by default.

Events

LoiteringGuard event

Declaration of the LoiteringGuard event

The declaration of the Loitering Guard event can be accessed through the VAPIX and ONVIF event web service API:s.

The declaration of the Loitering Guard event as received from the VAPIX API:

<tnsaxis:CameraApplicationPlatform aev:NiceName="Applications">
  <LoiteringGuard aev:NiceName="Loitering Guard">
    <CameraXProfileY wstop:topic"true" aev:NiceName="Loitering Guard: <profile.name>">
      <aev:MessageInstance aev:isProperty="true">
        <aev:DataInstance>
          <aev:SimpleItemInstance Type="xsd:boolean" Name="active" aev:isPropertyState="true"/>
        </aev:DataInstance>
      </aev:MessageInstance>
    </CameraXProfileY>
  </LoiteringGuard>
</tnsaxis:CameraApplicationPlatform>

The event in this example is named CameraXProfileY and is sent every time a condition has triggered an alarm. It is based on a profile with camera=X and uid=Y. If it is a multi-channel product the NiceName attribute is changed to:

aev:NiceName="Loitering Guard: <profile.name> (<Image.I<profile.camera>.Name>)"

The name of the camera is taken from the parhand using the Image.I<index>.Name parameter. Value <index> is the same as the camera source value camera=X minus one.

The properties can be used to match the criteria and trigger an action rule:

Property=<active>: Required. When movement is detected in the area the event is activated. When the movement disappears the event is inactivated.
<active>: A stateful event. An active event has the value "1", and the inactive event has the value "0".

Declaration of the LoiteringGuard events for multichannel product

The following example shows how an event declaration will look for a scenario with a multichannel product with two cameras, and each camera has two profiles. The Namespaces and unnecessary tags has been removed for readability.

<TopicSet>
  <CameraApplicationPlatform>
    <LoiteringGuard NiceName="Loitering Guard">
      <Camera1Profile1 topic="true" NiceName="Loitering Guard: Garden Left (Camera 1)">
        <MessageInstance isProperty="true">
        <DataInstance>
        <SimpleItemInstance Type="xsd:boolean">
        </DataInstance>
        </MessageInstance>
      </Camera1Profile1>
      <Camera1Profile2 topic="true" NiceName="Loitering Guard: Garden Right (Camera 1)">
        ...
      </Camera1Profile2>
      <Camera2Profile3 topic="true" NiceName="Loitering Guard: Parking Day (Camera 2)">
        ...
      </Camera2Profile3>
      <Camera2Profile4 topic="true" NiceName="Loitering Guard: Parking Night (Camera2)">
        ...
      </Camera2Profile4>
    </LoiteringGuard>
  </CameraApplicationPlatform>
  ...
</TopicSet>

CameraXProfileANY event

When the ACAP detects an object entering a loitering area, it will be sent as an ANY event element for a specific camera.

The declaration of an ANY event as received from the VAPIX API:

<tnsaxis:CameraApplicationPlatform>
  <LoiteringGuard aev:NiceName="Loitering Guard">
    <CameraXProfileANY wstop:topic="true" aev:NiceName="Loitering Guard: Any Profile">
    .
    .
    .
    </CameraXProfileANY>
  </LoiteringGuard>
</tnsaxis:CameraApplicationPlatform>

The event in this example is named CameraXProfileANY and is sent every time an object has entered a specific Loitering area. It is based on a profile with camera=X. If it is a multi channel product the NiceName attribute is changed to:

aev:NiceName="Loitering Guard: Any Profile (<Image.I<profile.camera>.Name>)"

The name of the camera is taken from the parhand using the Image.I<index>.Name parameter. Value <index> is the same as the camera source value camera=X minus one.

CameraANY event

When the application detects an object entering an Loitering area, it will be sent as a global ANY event element. A global ANY event is an ANY event for ANY camera, which means an alarm on any of the channels will also trigger this event.

The declaration of such a global ANY event event as received from the VAPIX API:

<tnsaxis:CameraApplicationPlatform>
  <LoiteringGuard aev:NiceName="Loitering Guard">
    <CameraANY wstop:topic="true" aev:NiceName="Loitering Guard: Any Camera">
    .
    .
    .
    </CameraANY>
  </LoiteringGuard>
</tnsaxis:CameraApplicationPlatform>

The event stream

A client may subscribe to events from the VAPIX/ONVIF event stream. The format of the stream and its elements are described in http://www.onvif.org/onvif/ver10/schema/onvif.xsd and http://www.onvif.org/onvif/ver10/topics/topicns.xml.

Using Vapix, this stream can be retrieved over RTSP using the url:

rtsp://<servername>/axismedia/media.amp?event=on&eventtopic=tnsaxis:CameraApplicationPlatform/LoiteringGuard//.

It is also possible to listen for a specific profile as shown below:

rtsp://<servername>/axismedia/media.amp?event=on&eventtopic=tnsaxis:CameraApplicationPlatform/LoiteringGuard/CameraXProfileY/.

CameraXProfileY

When the ACAP detects an object entering a loitering area, it will be sent as an event element. An example of such an event is described below.

<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvig.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics">
      <wsnt:ProducerReference>
        <wsa5:Address>uri://2a513b80-8211-4034-82e7-e8d48792c845/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2016-05-23T06:21:10.290542Z"PropertyOperation="Changed">
          <tt:Source/>
          <tt:Key/>
          <tt:Data>
            <tt:SimpleItem Name="active"Value="1"/>
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

The UtcTime of the message refers to the time of the event, i.e. this should be in sync with time stamps in an image stream with images of the actual physical event that took place.

Synchronize metadata with video stream

Axis cameras uses the Real Time Streaming Protocol (RTSP) for controlling the media streaming between the camera and its clients. RTSP uses the Realtime Transport Protocol (RTP) for the packet format for the streaming of the meta/video data, and the RTP Control Protocol (RTCP) for the synchronization of the metadata and video data stream. The synchronized conversion from the absolute time (UTC timestamp) at the loitering detection to the relative time (RTP timestamp) for the video stream, can be found in the RTCP packets.

ONVIF MotionAlarm event

Declaration of the MotionAlarm event

The declaration of the ONVIF Motion Alarm event can be accessed through the VAPIX and ONVIF event web service API:s. ONVIF event corresponds to CameraXProfileANY event. An ONVIF event will be sent if there is an ANY event being sent for a specific camera.

The declaration of the ONVIF Motion Alarm event as received from the VAPIX API:

<tns1: VideoSource>
  <MotionAlarm wstop:topic="true">
    <tt:MessageDescription isProperty="true">
      <tt:Source>
        <tt:SimpleItemDescription Name="Source" Type="tt:ReferenceToken"/>
      </tt:Source>
      <tt:Data>
        <SimpleItemDescription Name="State" Type="xs:boolean"/>
      </tt:Data>
    </MessageDescription>
  </MotionAlarm>
</tns1:VideoSource>

Parameter	Description
`Property=<Source>`	Required. The Video source for ONVIF, which starts counting from 0.
`<Source>`	Reference counter starts from 0.
`Property=<Data>`	Required. The value for Motion Alarm State.
`<State>`	An active event has the value "1", and an inactive event has the value "0".

The event stream

A user may subscribe to events from the VAPIX/ONVIF event stream. The format of the stream and its elements are described in http://www.onvif.org/onvif/ver10/schema/onvif.xsd and http://www.onvif.org/onvif/ver10/topics/topicns.xml.

Using VAPIX, this stream can be retrieved over RTSP using:

rtsp://<servername>/axis-media/media.amp?event=on&eventtopic=onvif:VideoSource/MotionAlarm/.

Description​

Methods​

Identification​

Common examples​

Backup and restore configuration​

Configure all settings​

Visual feedback​

Read the configuration capabilities​

API specification​

getConfiguration​

setConfiguration​

getConfigurationCapabilities​

getSupportedVersions​

sendAlarmEvent​

Configuration parameter description​

Configuration capabilities parameter description​

Events​

LoiteringGuard event​

ONVIF MotionAlarm event​

Description

Methods

Identification

Common examples

Backup and restore configuration

Configure all settings

Visual feedback

Read the configuration capabilities

API specification

getConfiguration

setConfiguration

getConfigurationCapabilities

getSupportedVersions

sendAlarmEvent

Configuration parameter description

Configuration capabilities parameter description

Events

LoiteringGuard event

ONVIF MotionAlarm event