VideoOS.Platform.Data.AnalyticsEvent Class Reference

An implementation of the BaseEvent with more relevant information when an Analytics oriented event has occurred. More...

Inheritance diagram for VideoOS.Platform.Data.AnalyticsEvent:
VideoOS.Platform.Data.BaseEvent

Properties

uint Count [get, set]
 The count value, if the analytics event is a counting events. Default: 0 (no count).
 
string Description [get, set]
 The description of the analytics event.
 
System.DateTime EndTime [get, set]
 The end time of the analytics event, if it takes place over a period of time.
 
string Location [get, set]
 The location of the analytics event (this will typically be the same as the camera's location).
 
AnalyticsObjectList ObjectList [get, set]
 The ObjectList, containing information about the detected object(s) in the scene.
 
ReferenceList ReferenceList [get, set]
 The ReferenceList, containing any number of references to other entities in the system, e.g. cameras, by FQID.
 
RuleList RuleList [get, set]
 The RuleList, containing information contains information about the rule(s), which triggered the analytics event.
 
SnapshotList SnapshotList [get, set]
 The SnapshotList, containing any number of images related to the analytics event. If the Source is a camera, it is not neccesary to attach a snapshot from that camera at the time of the analytics event.
 
System.DateTime StartTime [get, set]
 The start time of the analytics event, if it takes place over a period of time.
 
Vendor Vendor [get, set]
 The Vendor, containing information about the analytics vendor including any custom data.
 
- Properties inherited from VideoOS.Platform.Data.BaseEvent
EventHeader EventHeader [get, set]
 The EventHeader describing the source, timestamp and much more for this event.
 
ExtensionDataObject ExtensionData [get, set]
 

Additional Inherited Members

- Public Member Functions inherited from VideoOS.Platform.Data.BaseEvent
 BaseEvent ()
 

Detailed Description

An implementation of the BaseEvent with more relevant information when an Analytics oriented event has occurred.

Property Documentation

◆ Count

uint VideoOS.Platform.Data.AnalyticsEvent.Count
getset

The count value, if the analytics event is a counting events. Default: 0 (no count).

◆ Description

string VideoOS.Platform.Data.AnalyticsEvent.Description
getset

The description of the analytics event.

◆ EndTime

System.DateTime VideoOS.Platform.Data.AnalyticsEvent.EndTime
getset

The end time of the analytics event, if it takes place over a period of time.

◆ Location

string VideoOS.Platform.Data.AnalyticsEvent.Location
getset

The location of the analytics event (this will typically be the same as the camera's location).

◆ ObjectList

AnalyticsObjectList VideoOS.Platform.Data.AnalyticsEvent.ObjectList
getset

The ObjectList, containing information about the detected object(s) in the scene.

◆ ReferenceList

ReferenceList VideoOS.Platform.Data.AnalyticsEvent.ReferenceList
getset

The ReferenceList, containing any number of references to other entities in the system, e.g. cameras, by FQID.

◆ RuleList

RuleList VideoOS.Platform.Data.AnalyticsEvent.RuleList
getset

The RuleList, containing information contains information about the rule(s), which triggered the analytics event.

◆ SnapshotList

SnapshotList VideoOS.Platform.Data.AnalyticsEvent.SnapshotList
getset

The SnapshotList, containing any number of images related to the analytics event. If the Source is a camera, it is not neccesary to attach a snapshot from that camera at the time of the analytics event.

◆ StartTime

System.DateTime VideoOS.Platform.Data.AnalyticsEvent.StartTime
getset

The start time of the analytics event, if it takes place over a period of time.

◆ Vendor

Vendor VideoOS.Platform.Data.AnalyticsEvent.Vendor
getset

The Vendor, containing information about the analytics vendor including any custom data.