SAFR Windows SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
RealNetworks.ArgusKit.PersonEvent Class Reference

An event which represents a detected / recognized person. More...

Inheritance diagram for RealNetworks.ArgusKit.PersonEvent:
RealNetworks.ArgusKit.BadgeEvent RealNetworks.ArgusKit.RecognizedObjectEvent

Public Member Functions

override string ToString ()
 
virtual PersonEvent Copy ()
 Returns a copy of the person event. More...
 
virtual Dictionary< string, object > RequiredJson ()
 
virtual Dictionary< string, object > OptionalJson ()
 

Public Attributes

TimestampThumbnailTimestamp = null
 
TimestampDetailThumbnailTimestamp = null
 
BitmapSource CurrentHighestQualityThumbnail = null
 
BitmapSource CurrentHighestQualityDetailThumbnail = null
 
BitmapSource CurrentHighestQualitySceneThumbnail = null
 

Properties

string EventId = "" [get, set]
 Unique id for this event. More...
 
string SiteId = "" [get, set]
 The site id for where this event was generated. More...
 
string SourceId = "" [get, set]
 The source id for where this event was generated. More...
 
string SourceUserId = "" [get, set]
 Feed configurator user id. More...
 
string InputStreamName = "" [get, set]
 The camera name for where this event was generated. More...
 
PersonEventContext Context = PersonEventContext.Live [get, set]
 The context of the video source in which this event was generated. More...
 
PersonEventType Type = PersonEventType.Person [get, set]
 The type of object contained in this event. More...
 
Int64 StartTime = 0 [get, set]
 For live sources this is the time since January 1, 1970 UTC. For recorded sources this is the time since the start of the recording. This value is in milliseconds. More...
 
Int64 EndTime = 0 [get, set]
 For live sources this is the time since January 1, 1970 UTC. For recorded sources this is the time since the start of the recording. This value is in milliseconds. More...
 
double? MinSentiment = null [get, set]
 The minimum sentiment value for the event. This is continuously updated over the course of the event. More...
 
double? MaxSentiment = null [get, set]
 The maximum sentiment value for the event. This is continuously updated over the course of the event. More...
 
double? Sentiment = null [get, set]
 The sentiment value for the event. This is continuously updated over the course of the event and is typically the average. More...
 
Int64? SmileDuration = null [get, set]
 The smile duration value for the event. This will be 0 until the endTime because this is needed to calculate this duration. This value is in milliseconds. More...
 
Int64? DirectGazeDuration = null [get, set]
 The direct gaze duration value for the event. This will be 0 until the endTime because this is needed to calculate this duration. This value is in milliseconds. More...
 
double? SimilarityScore = null [get, set]
 The similarity score value for the event. This is continuously updated over the course of the event. More...
 
Int64 LocalId = 0 [get, set]
 The local id at that is being used to track this person at the time of identification. More...
 
bool? NewId = null [get, set]
 If the object identifier was created for the first time this is true otherwise it is false. More...
 
RectangleF? InitialNormalizedBounds = null [get, set]
 Normalized Bounds at time of appearance. More...
 
RectangleF? NormalizedBounds = null [get, set]
 Current Normalized Bounds. More...
 
string RootEventId = null [get, set]
 If this event is a sub-event then this is set to the root event.
An example is a face event is a sub-event of a person(body/object) event. More...
 
string PeerEventId = null [get, set]
 If this event is an object action event then this is set to the peer event of where this person is being tracked.
An example is an unauthorized direction movement event will point to the presense event that is ongoing. More...
 
bool? HasSubEvents = null [get, set]
 If this event has sub-events then this is set to true otherwise it is false.
An example is a person(body/object) event that has face events as sub-events. More...
 
bool? LivenessConfirmed = null [get, set]
 3D Liveness Confirmed. More...
 
double? MaxLiveness = null [get, set]
 Max 3D Liveness score. More...
 
double? Occlusion = null [get, set]
 The occlusion value for this event. This is updated only at specific times, such as when Thumbnail is updated. More...
 
bool? Mask = null [get, set]
 Is mask detected. More...
 
double? Pitch = null [get, set]
 The pitch value for this event. This is updated only at specific times, such as when Thumbnail is updated. More...
 
double? Roll = null [get, set]
 The roll value for this event. This is updated only at specific times, such as when Thumbnail is updated. More...
 
double? Yaw = null [get, set]
 The yaw value for this event. This is updated only at specific times, such as when Thumbnail is updated. More...
 
BitmapSource Thumbnail = null [get, set]
 The most recent thumbnail image. More...
 
Uri ThumbnailUrl = null [get, set]
 The thumbnail url if no thumbnail image is available. More...
 
BitmapSource DetailThumbnail = null [get, set]
 In root person events this thumbnail contains the highest quality face from all the sub-events. More...
 
Uri DetailThumbnailUrl = null [get, set]
 The detail thumbnail url if no scene detail image is available. More...
 
BitmapSource SceneThumbnail = null [get, set]
 The most recent scene thumbnail image. The thumbnail image was obtained from the scene in which this thumbnail represents. More...
 
Uri SceneThumbnailUrl = null [get, set]
 The scene thumbnail url if no scene thumbnail image is available. More...
 
Person RootPerson = null [get, set]
 The root person associated with this event if there is one. More...
 
Person Person = new Person() [get, set]
 The person associated with this event. More...
 
ObjectAction ObjectAction = null [get, set]
 
Int64? Duration [get]
 Returns the duration of this event. More...
 
bool IsSpeculated [get]
 
bool IsStranger [get]
 Returns true if the person is classified as a stranger. More...
 
bool IsThreat [get]
 Returns true if the person is classified as a threat. More...
 
bool IsConcern [get]
 Returns true if the person is classified as a concern. More...
 
string RegionName = null [get, set]
 Name of a region (from RegionMap) containing the face. More...
 
bool AutoEnded = false [get, set]
 
bool AllowReporting = true [get, set]
 Allows preventing the event from being reported / updated. More...
 

Detailed Description

An event which represents a detected / recognized person.

Member Function Documentation

◆ Copy()

virtual PersonEvent RealNetworks.ArgusKit.PersonEvent.Copy ( )
virtual

Returns a copy of the person event.

Returns
the copy

Reimplemented in RealNetworks.ArgusKit.BadgeEvent, and RealNetworks.ArgusKit.RecognizedObjectEvent.

◆ OptionalJson()

virtual Dictionary<string, object> RealNetworks.ArgusKit.PersonEvent.OptionalJson ( )
virtual

◆ RequiredJson()

virtual Dictionary<string, object> RealNetworks.ArgusKit.PersonEvent.RequiredJson ( )
virtual

◆ ToString()

override string RealNetworks.ArgusKit.PersonEvent.ToString ( )

Member Data Documentation

◆ CurrentHighestQualityDetailThumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.CurrentHighestQualityDetailThumbnail = null

◆ CurrentHighestQualitySceneThumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.CurrentHighestQualitySceneThumbnail = null

◆ CurrentHighestQualityThumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.CurrentHighestQualityThumbnail = null

◆ DetailThumbnailTimestamp

Timestamp? RealNetworks.ArgusKit.PersonEvent.DetailThumbnailTimestamp = null

◆ ThumbnailTimestamp

Timestamp? RealNetworks.ArgusKit.PersonEvent.ThumbnailTimestamp = null

Property Documentation

◆ AllowReporting

bool RealNetworks.ArgusKit.PersonEvent.AllowReporting = true
getset

Allows preventing the event from being reported / updated.

◆ AutoEnded

bool RealNetworks.ArgusKit.PersonEvent.AutoEnded = false
getset

◆ Context

PersonEventContext RealNetworks.ArgusKit.PersonEvent.Context = PersonEventContext.Live
getset

The context of the video source in which this event was generated.

◆ DetailThumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.DetailThumbnail = null
getset

In root person events this thumbnail contains the highest quality face from all the sub-events.

◆ DetailThumbnailUrl

Uri RealNetworks.ArgusKit.PersonEvent.DetailThumbnailUrl = null
getset

The detail thumbnail url if no scene detail image is available.

◆ DirectGazeDuration

Int64? RealNetworks.ArgusKit.PersonEvent.DirectGazeDuration = null
getset

The direct gaze duration value for the event. This will be 0 until the endTime because this is needed to calculate this duration. This value is in milliseconds.

◆ Duration

Int64? RealNetworks.ArgusKit.PersonEvent.Duration
get

Returns the duration of this event.

◆ EndTime

Int64 RealNetworks.ArgusKit.PersonEvent.EndTime = 0
getset

For live sources this is the time since January 1, 1970 UTC. For recorded sources this is the time since the start of the recording. This value is in milliseconds.

◆ EventId

string RealNetworks.ArgusKit.PersonEvent.EventId = ""
getset

Unique id for this event.

◆ HasSubEvents

bool? RealNetworks.ArgusKit.PersonEvent.HasSubEvents = null
getset

If this event has sub-events then this is set to true otherwise it is false.
An example is a person(body/object) event that has face events as sub-events.

◆ InitialNormalizedBounds

RectangleF? RealNetworks.ArgusKit.PersonEvent.InitialNormalizedBounds = null
getset

Normalized Bounds at time of appearance.

◆ InputStreamName

string RealNetworks.ArgusKit.PersonEvent.InputStreamName = ""
getset

The camera name for where this event was generated.

◆ IsConcern

bool RealNetworks.ArgusKit.PersonEvent.IsConcern
get

Returns true if the person is classified as a concern.

◆ IsSpeculated

bool RealNetworks.ArgusKit.PersonEvent.IsSpeculated
get

◆ IsStranger

bool RealNetworks.ArgusKit.PersonEvent.IsStranger
get

Returns true if the person is classified as a stranger.

◆ IsThreat

bool RealNetworks.ArgusKit.PersonEvent.IsThreat
get

Returns true if the person is classified as a threat.

◆ LivenessConfirmed

bool? RealNetworks.ArgusKit.PersonEvent.LivenessConfirmed = null
getset

3D Liveness Confirmed.

◆ LocalId

Int64 RealNetworks.ArgusKit.PersonEvent.LocalId = 0
getset

The local id at that is being used to track this person at the time of identification.

◆ Mask

bool? RealNetworks.ArgusKit.PersonEvent.Mask = null
getset

Is mask detected.

◆ MaxLiveness

double? RealNetworks.ArgusKit.PersonEvent.MaxLiveness = null
getset

Max 3D Liveness score.

◆ MaxSentiment

double? RealNetworks.ArgusKit.PersonEvent.MaxSentiment = null
getset

The maximum sentiment value for the event. This is continuously updated over the course of the event.

◆ MinSentiment

double? RealNetworks.ArgusKit.PersonEvent.MinSentiment = null
getset

The minimum sentiment value for the event. This is continuously updated over the course of the event.

◆ NewId

bool? RealNetworks.ArgusKit.PersonEvent.NewId = null
getset

If the object identifier was created for the first time this is true otherwise it is false.

◆ NormalizedBounds

RectangleF? RealNetworks.ArgusKit.PersonEvent.NormalizedBounds = null
getset

Current Normalized Bounds.

◆ ObjectAction

ObjectAction RealNetworks.ArgusKit.PersonEvent.ObjectAction = null
getset

◆ Occlusion

double? RealNetworks.ArgusKit.PersonEvent.Occlusion = null
getset

The occlusion value for this event. This is updated only at specific times, such as when Thumbnail is updated.

◆ PeerEventId

string RealNetworks.ArgusKit.PersonEvent.PeerEventId = null
getset

If this event is an object action event then this is set to the peer event of where this person is being tracked.
An example is an unauthorized direction movement event will point to the presense event that is ongoing.

◆ Person

Person RealNetworks.ArgusKit.PersonEvent.Person = new Person()
getset

The person associated with this event.

◆ Pitch

double? RealNetworks.ArgusKit.PersonEvent.Pitch = null
getset

The pitch value for this event. This is updated only at specific times, such as when Thumbnail is updated.

◆ RegionName

string RealNetworks.ArgusKit.PersonEvent.RegionName = null
getset

Name of a region (from RegionMap) containing the face.

◆ Roll

double? RealNetworks.ArgusKit.PersonEvent.Roll = null
getset

The roll value for this event. This is updated only at specific times, such as when Thumbnail is updated.

◆ RootEventId

string RealNetworks.ArgusKit.PersonEvent.RootEventId = null
getset

If this event is a sub-event then this is set to the root event.
An example is a face event is a sub-event of a person(body/object) event.

◆ RootPerson

Person RealNetworks.ArgusKit.PersonEvent.RootPerson = null
getset

The root person associated with this event if there is one.

◆ SceneThumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.SceneThumbnail = null
getset

The most recent scene thumbnail image. The thumbnail image was obtained from the scene in which this thumbnail represents.

◆ SceneThumbnailUrl

Uri RealNetworks.ArgusKit.PersonEvent.SceneThumbnailUrl = null
getset

The scene thumbnail url if no scene thumbnail image is available.

◆ Sentiment

double? RealNetworks.ArgusKit.PersonEvent.Sentiment = null
getset

The sentiment value for the event. This is continuously updated over the course of the event and is typically the average.

◆ SimilarityScore

double? RealNetworks.ArgusKit.PersonEvent.SimilarityScore = null
getset

The similarity score value for the event. This is continuously updated over the course of the event.

◆ SiteId

string RealNetworks.ArgusKit.PersonEvent.SiteId = ""
getset

The site id for where this event was generated.

◆ SmileDuration

Int64? RealNetworks.ArgusKit.PersonEvent.SmileDuration = null
getset

The smile duration value for the event. This will be 0 until the endTime because this is needed to calculate this duration. This value is in milliseconds.

◆ SourceId

string RealNetworks.ArgusKit.PersonEvent.SourceId = ""
getset

The source id for where this event was generated.

◆ SourceUserId

string RealNetworks.ArgusKit.PersonEvent.SourceUserId = ""
getset

Feed configurator user id.

◆ StartTime

Int64 RealNetworks.ArgusKit.PersonEvent.StartTime = 0
getset

For live sources this is the time since January 1, 1970 UTC. For recorded sources this is the time since the start of the recording. This value is in milliseconds.

◆ Thumbnail

BitmapSource RealNetworks.ArgusKit.PersonEvent.Thumbnail = null
getset

The most recent thumbnail image.

◆ ThumbnailUrl

Uri RealNetworks.ArgusKit.PersonEvent.ThumbnailUrl = null
getset

The thumbnail url if no thumbnail image is available.

◆ Type

PersonEventType RealNetworks.ArgusKit.PersonEvent.Type = PersonEventType.Person
getset

The type of object contained in this event.

◆ Yaw

double? RealNetworks.ArgusKit.PersonEvent.Yaw = null
getset

The yaw value for this event. This is updated only at specific times, such as when Thumbnail is updated.