Page History

To get the camera events using WebSocket, do the following:

Connect to ws://[user_name]:[password]@[IP address]:[port]/[prefix]/events.
Send a JSON command to subscribe to event notification from the specified cameras (see Get list of telemetry devices for specified video source). This subscription allows you to receive all events listed in the table below.
Code Block
language xml
{ "include": ["hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", "hosts/Server1/DeviceIpint.6/SourceEndpoint.video:0:0"], "exclude":[] }
- include

—

subscribe

- —subscribe to event notification;
- exclude

—

disable

- —disable the events notification.

The response will contain the following JSON:

Code Block

language	xml

   {
    objecs: [
    {type: "devicestatechanged", name: "hosts/Server1/DeviceIpint.1", state: "signal restored"}
    ]
    }

List of event types and camera states:

Event type	Description	States
devicestatechanged	Camera state	signal restored

—connected

—connected, signal restored
signal lost

—signal

—signal lost
alert	Alarm	No states
alert_state	Alarm state	processing

—the

—the alarm is being processed
closed

—alarm

—alarm is processed
reaction

—alarm

—alarm is initiated
detector_event	Event from a detection tool	No states
camera_record_state	State of recording to archive	on

—the

—the camera is recording to the archive
off

—the

—the camera isn't linked to the archive
gray

—the

—the camera is linked to the archive, but isn't recording

Info

title	Note

If the camera is disabled in Axxon One, no events are received from it using WebSocket, including the signal lost event.

Example of a message:

Code Block

language	xml

objects: [{name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", state: "signal restored",…},…]
0: {name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", state: "signal restored",…}
name: "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0"
state: "signal restored"
type: "devicestatechanged"

Sample request to receive events via Web-Socket:

ws://root:root@localhost/events?schema=proto

Parameter	Description
schema	schema=proto means detailed response

Sample detailed response:

Expand

Code Block

language	xml

{
    "objects": [
        {
            "body": {
                "@type": "type.googleapis.com/axxonsoft.bl.events.DetectorEvent",
                "details": [
                    {
                        "autoRecognitionResultEx": {
                            "direction": {
                                "value": "Outgoing"
                            },
                            "headlightsStatus": {
                                "value": "Disabled"
                            },
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": {
                                "value": "EUnitedNations"
                            },
                            "timeBegin": "2023-06-23T12:48:16.295Z",
                            "timeEnd": "2023-06-23T12:48:16.295Z",
                            "vehicleBrand": {
                                "value": "Mercedes Benz"
                            },
                            "vehicleClass": {
                                "value": "Car"
                            },
                            "vehicleColor": {
                                "value": "Gray"
                            },
                            "vehicleModel": {
                                "value": "GLS Klasse"
                            }
                        }
                    },
                    {
                        "autoRecognitionResult": {
                            "direction": "Outgoing",
                            "headlightsStatus": "Disabled",
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": "EUnitedNations",
                            "timeBegin": "20230623T124816.295000",
                            "timeEnd": "20230623T124816.295000",
                            "vehicleBrand": "Mercedes Benz",
                            "vehicleClass": "Car",
                            "vehicleColor": "Gray",
                            "vehicleModel": "GLS Klasse"
                        }
                    }
                ],
                "detectorDeprecated": "hosts/TEST/AVDetector.1/EventSupplier",
                "detectorExt": {
                    "accessPoint": "hosts/TEST/AVDetector.1/EventSupplier",
                    "friendlyName": "1.\u0420u0031\u0430u002e\u0441u004c\u043fu0069\u043eu0063\u0437u0065\u043du006e\u0430u0073\u0432u0065\u0430u0020\u043du0050\u0438u006c\u0435 u0061\u043du0074\u043eu0065\u043cu0020\u0435u0052\u0440u0065\u043eu0063\u0432 u006f\u0430u0067\u0432u006e\u0442u0069\u043eu0074\u043cu0069\u043eu006f\u0431u006e\u0438u0020\u043b\u0435\u0439 (RR)u0052\u0052"
                },
                "detectorsGroup": [
                    "DG_LPR_DETECTOR"
                ],
                "eventType": "plateRecognized",
                "guid": "d6650759-e89b-43dd-a610-459a6e421ccc",
                "nodeInfo": {
                    "friendlyName": "TEST",
                    "name": "TEST"
                },
                "originDeprecated": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "originExt": {
                    "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                    "friendlyName": "1.\u041a\u0430\u043c\u0435\u0440\u0430\u0031\u002e\u0043\u0061\u006d\u0065\u0072\u0061"
                },
                "timestamp": "20230623T124816.295000"
            },
            "eventName": "axxonsoft.bl.events.DetectorEvent",
            "eventType": "ET_DetectorEvent",
            "localization": {
                "text": "\u041au0022\u0043\u0430u0061\u043cu006d\u0435u0065\u0440u0072\u0430 \"1.\u041a\u0430\u043c\u0435\u0440\u0430\". \u0421\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u043d\u0438\u0435 \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 \"1.\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u043d\u0438\u0435 \u043d\u043e\u043c\u0435\u0440\u043e\u0432 \u0430\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u0435\u0439 (RR)\", \u041d\u043e\u043c\u0435\u0440 \"CJ97139\", \u0441\u0442\u0440\u0430\u043d\u0430 \"Denmark\", \u043a\u043b\u0430\u0441\u0441 \"\u0410\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u044c\", \u0446\u0432\u0435\u0442 \"Gray\", \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u0434\u0438\u0442\u0435\u043b\u044c \"Mercedes Benz\", \u043c\u043e\u0434\u0435\u043b\u044c \"GLS Klasse\", \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0444\u0430\u0440 \"\u0412\u044b\u043a\u043b\u044e\u0447\u0435\u043d\u044b\" \u0420\u0430\u0441\u0448\u0438\u0440\u0435\u043d\u043d\u0430\u044f \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044f: \u0422\u0438\u043f \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 = \"\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u043d\u043d\u044b\u0439 \u043d\u043e\u043c\u0435\u0440\""u0061\u0020\u005c\u0022\u0031\u002e\u0043\u0061\u006d\u0065\u0072\u0061\u005c\u0022\u002e\u0020\u0044\u0065\u0074\u0065\u0063\u0074\u006f\u0072\u0020\u0061\u0063\u0074\u0069\u0076\u0061\u0074\u0069\u006f\u006e\u0020\u005c\u0022\u0031\u002e\u004c\u0069\u0063\u0065\u006e\u0073\u0065\u0020\u0050\u006c\u0061\u0074\u0065\u0020\u0052\u0065\u0063\u006f\u0067\u006e\u0069\u0074\u0069\u006f\u006e\u0020\u0052\u0052\u005c\u0022\u002c\u0020\u004e\u0075\u006d\u0062\u0065\u0072\u0020\u005c\u0022\u0043\u004a\u0039\u0037\u0031\u0033\u0039\u005c\u0022\u002c\u0020\u0063\u006f\u0075\u006e\u0074\u0072\u0079\u0020\u005c\u0022\u0044\u0065\u006e\u006d\u0061\u0072\u006b\u005c\u0022\u002c\u0020\u0063\u006c\u0061\u0073\u0073\u0020\u005c\u0022\u0043\u0061\u0072\u005c\u0022\u002c\u0020\u0063\u006f\u006c\u006f\u0072\u0020\u005c\u0022\u0047\u0072\u0061\u0079\u005c\u0022\u002c\u0020\u006d\u0061\u006e\u0075\u0066\u0061\u0063\u0074\u0075\u0072\u0065\u0072\u0020\u005c\u0022\u004d\u0065\u0072\u0063\u0065\u0064\u0065\u0073\u0020\u0042\u0065\u006e\u007a\u005c\u0022\u002c\u0020\u006d\u006f\u0064\u0065\u006c\u0020\u005c\u0022\u0047\u004c\u0053\u0020\u0043\u006c\u0061\u0073\u0073\u005c\u0022\u002c\u0020\u0068\u0065\u0061\u0064\u006c\u0069\u0067\u0068\u0074\u0020\u0073\u0074\u0061\u0074\u0075\u0073\u0020\u005c\u0022\u004f\u0066\u0066\u005c\u0022\u0020\u0045\u0078\u0074\u0065\u006e\u0064\u0065\u0064\u0020\u0069\u006e\u0066\u006f\u0072\u006d\u0061\u0074\u0069\u006f\u006e\u003a\u0020\u0044\u0065\u0074\u0065\u0063\u0074\u006f\u0072\u0020\u0074\u0079\u0070\u0065\u0020\u003d\u0020\u005c\u0022\u0052\u0065\u0063\u006f\u0067\u006e\u0069\u007a\u0065\u0064\u0020\u006e\u0075\u006d\u0062\u0065\u0072\u005c\u0022"
            },
            "requiredPermissions": {
                "requiredObjectPermissions": [
                    {
                        "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                        "cameraAccess": "CAMERA_ACCESS_ONLY_ARCHIVE"
                    }
                ]
            },
            "subjects": [
                "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "hosts/TEST/AVDetector.1/EventSupplier"
            ]
        }
    ]
}

Parameter	Description
vehicleBrand	Vehicle manufacturer
vehicleClass	Vehicle class
vehicleColor	Vehicle color
vehicleModel	Vehicle model

Managing the subscription to event notification about changes in camera configuration

Using WebSocket, you you can subscribe and unsubscribe to event notification about changes in camera configuration using the track and untrack commands.

Example of subscription to event notification about changes in camera configuration:

Code Block

language	xml

{
"track": ["hosts/Server/DeviceIpint.1"]
}

Example of a message after subscription:

Code Block

language	xml

{
   "objects" : [
      {
         "name" : "hosts/Server/DeviceIpint.1",
         "type" : "itemstatuschanged"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}
{
   "objects" : [
      {
         "name" : "hosts/Server/DeviceIpint.1",
         "type" : "itemstatuschanged"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}

where the type parameter displays the itemstatuschanged value when the configuration is changed.

Example of unsubscription to event notification about changes in camera configuration:
Code Block
language xml
{ "untrack": ["hosts/Server/DeviceIpint.1"] }
Example of a

response

message after unsubscription:

Code Block

language	xml

{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}
{
   "objects" : [
      {
         "source" : "hosts/Server/DeviceIpint.1/SourceEndpoint.video:0:0",
         "state" : "off",
         "type" : "camera_record_state"
      }
   ]
}

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Managing the subscription to event notification about changes in camera configuration