Video Feeds Properties

Global Properties

Below is a list of global processor properties.

Property Default Description
alarm-enabled False Enables alarms.
status-interval 500 Status reporting time interval in milliseconds.
avigilon N/A Exposes the properties related to the SAFR Avigilon integration.
genetec N/A Exposes the properties related to the SAFR Genetec and SAFR Genetec FaceRec integrations.
digifort N/A Exposes the properties related to the SAFR Digifort integration.
milestone N/A Exposes the properties related to the SAFR Milestone integration.
geutebrueck N/A Exposes the properties related to the SAFR Geutebrueck integration.
videoInsight N/A Exposes the properties related to the SAFR Panasonic Video Insight integration.

Monitoring Properties

Below is a list of all the monitoring properties.

Property Default Value Description
alarm.condition.delinquent.enabled TRUE Enables the deliquent alarm condition.
alarm.condition.delinquent.subject "SAFR Feed Processor Unresponsive" Sets the text of the subject line of the delinquent notification mail.
alarm.condition.delinquent.message "SAFR Feed Processor %s is not responding." Sets the text of the email body of the delinquent notification mail.
alarm.condition.feed.error.enabled TRUE Enables the feed.error alarm condition.
alarm.condition.feed.error.subject "SAFR Feed Error" Sets the text of the subject line of the feed.error notification mail.
alarm.condition.feed.error.message "SAFR Feed Processor %s feed %s encountered an error %d: %s." Sets the text of the email body of the feed.error notification mail.
alarm.condition.lowRAM.enabled TRUE Enables the lowRAM alarm condition.
alarm.condition.lowRAM.subject "SAFR Feed Processor low on RAM" Sets the text of the subject line of the lowRAM notification mail.
alarm.condition.lowRAM.thresholdGB 0.5 The threshold, in GB, below which the lowRAM alarm condition is triggered.
alarm.condition.lowRAM.message "SAFR Feed Processor %s RAM remaining is at %f.1GB which is below healthy threshold of %f.1GB." Sets the text of the email body of the lowRAM notification mail.
alarm.condition.lowDisk.enabled TRUE Enables the lowDisk alarm condition.
alarm.condition.lowDisk.subject "SAFR Feed Processor low on disk space" Sets the text of the subject line of the lowDisk notification mail.
alarm.condition.lowDisk.thresholdGB 1.0 The threshold, in GB, below which the lowDisk alarm condition is triggered.
alarm.condition.lowDisk.message "SAFR Feed Processor %s disk space remaining is at %f.1GB which is below healthy threshold of %f.1GB." Sets the text of the email body of the lowDisk notification mail.
alarm.condition.lowGPUMemory.enabled TRUE Enables the lowGPUMemory alarm condition.
alarm.condition.lowGPUMemory.subject "SAFR Feed Processor low on GPU memory" Sets the text of the subject line of the lowGPUMemory notification mail.
alarm.condition.lowGPUMemory.thresholdGB 0.3 The threshold, in GB, below which the lowGPUMemory alarm condition is triggered.
alarm.condition.lowGPUMemory.message "SAFR Feed Processor %s GPU memory remaining is at %f.1GB which is below healthy threshold of %f.1GB." Sets the text of the email body of the lowGPUMemory notification mail.
alarm.condition.lowCPU.enabled TRUE Enables the lowCPU alarm condition.
alarm.condition.lowCPU.subject "SAFR Feed Processor low on CPU" Sets the text of the subject line of the lowCPU notification mail.
alarm.condition.lowCPU.thresholdPercent 15.0 The threshold, as a percentage, below which the lowCPU alarm condition is triggered.
alarm.condition.lowCPU.message "SAFR Feed Processor %s CPU capacity remaining is at %f.1% which is below healthy threshold of %f.1%." Sets the text of the email body of the lowCPU notification mail.
alarm.condition.lowGPU.enabled TRUE Enables the lowGPU alarm condition.
alarm.condition.lowGPU.subject "SAFR Feed Processor low on GPU" The threshold, as a percentage, below which the lowGPU alarm condition is triggered.
alarm.condition.lowGPU.thresholdPercent 15.0 The threshold, as a percentage, below which the lowGPU alarm condition is triggered.
alarm.condition.lowGPU.message "SAFR Feed Processor %s GPU capacity remaining is at %f.1% which is below healthy threshold of %f.1%." Sets the text of the email body of the lowGPU notification mail.
alarm.mail.enabled TRUE Enables alarm notification mails.
alarm.mail.recipients N/A A comma-separated list of emails that specifies who should receive email notifications.
alarm.mail.username N/A The username for your email service.
alarm.mail.password N/A The password for your email service.

System Properties

Property Default Value Description
event.sync.enabled False Enables the automatic archiving of events, as described in the Web Console's Status Page and Desktop Client's System Configuration Window documentation.
identity.sync.enabled False Enables the automatic synchronization of identities, as described in the Web Console's Status Page and Desktop Client's System Configuration Window documentation.

Feeds Properties

Below is a list of all the supported video feed properties. UI Setting Name specifies the corresponding setting within the Desktop Client, and UI Setting Location specifies where the setting can be found in the Desktop Client.

Camera Properties

Property Default Value Description UI Setting Name UI Setting Location
input.back-channel.mobotix.cash-point "None" When the connected camera is a Mobotix camera, this property must be set to the configured cash point within the Mobotix app for the back-channel to work. Cash Point Camera Preferences menu
input.back-channel.type "None" When the connected camera is a Mobotix camera, you can set this property to "Mobotix MX" in order to have SAFR report STRANGER and RECOGNIZED event types to the camera. This feature is necessary if you want to make use of the Mobotix app. If the connected camera isn't a Mobotix camera, this property doesn't have any effect. Back Channel Camera Preferences menu
input.contrast-enhancement.enabled FALSE Enables contrast enhancement of the input video frame. This property is not supported by SAFR Inside. Contrast Enhancement Camera Preferences menu
input.contrast-enhancement.exposure-boost 0 The boost for contrast enhancement. This property is not supported by SAFR Inside. Exposure Boost Camera Preferences menu
input.contrast-enhancement.low-light-threshold 0.02 Low-light-threshold for contrast enhancement. This property is not supported by SAFR Inside. Low Light Threshold Camera Preferences menu
input.lens-correction.enabled FALSE Enables lens correction for the camera. This property is not supported by SAFR Inside. Lens Correction Camera Preferences menu
input.lens-correction.k1 0 The "k1" lens correction factor. This property is not supported by SAFR Inside. Coefficient K1 Camera Preferences menu
input.lens-correction.k2 0 The "k2" lens correction factor. This property is not supported by SAFR Inside. Coefficient K2 Camera Preferences menu
input.mirroring.enabled FALSE Whether the video image should be mirrored before detection and recognition operations are executed. This property is not supported by SAFR Inside. Enable mirroring Camera Preferences menu
input.password N/A Password of the person accessing the video stream. This property is not supported by SAFR Inside. Password Camera Preferences menu
input.rotation.angle 0 Whether the video should be rotated before detection and recognition operations are executed. Valid values are 0, 90, 180, and 270. This property is not supported by SAFR Inside. Rotate Image Camera Preferences menu
input.stream.rtsp.transport "udp" The transport protocol that should be used while accessing the RTSP video stream. Must be one of "udp", "tcp", or "udp-multicast". This property is not supported by SAFR Inside. RTSP Transport Protocol Camera Preferences menu
input.stream.url N/A The video stream URL. The URL must point to a RTSP, HTTP, or FILE stream. Note that if you want to point the input stream to a locally saved file on a Windows machine, VIRGO expects a Windows native path for this property. (e.g. C:\ProgramData\RealNetworks\SAFR\bin\foo.mp4) Address Camera Preferences menu
input.user-name N/A Username of the person accessing the video stream. This property is not supported by SAFR Inside. User Camera Preferences menu
input.video-clock.enabled TRUE Enables enforcement of the video clock. Video files will be processed as fast as possible if the video clock is turned off. Streams are always processed as fast as possible so this value is ignored when input.type is set to "stream". Live streams play at the rate the data is sent, while file streams will be processed as fast as possible. When input.type is set to "file", then this value is used to determine whether the file should be processed at real time or faster than real time. This property is not supported by SAFR Inside. Enforce timing for video frames Camera Preferences menu
source N/A Source name. Source Camera Preferences menu
tracker.detect-direction-of-travel.person.bottom-boundary 0 The percentage of the bottom side of the camera view field to exclude from direction of travel event reporting. This property is not supported by SAFR Inside. Bottom boundary Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.down FALSE Enables direction of travel detection in the downward direction. This property is not supported by SAFR Inside. Down/Towards travel distance (the checkbox) Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.down-distance 0.1 The percentage of the camera view that a tracked person can travel in a downward direction before a direction of travel event is generated. This property doesn't have any effect if tracker.detect-direction-of-travel.person.down is set to FALSE. This property is not supported by SAFR Inside. Down/Towards travel distance Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.left FALSE Enables direction of travel detection in the leftward direction. This property is not supported by SAFR Inside. Left travel distance (the checkbox) Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.left-boundary 0 The percentage of the left side of the camera view field to exclude from direction of travel event reporting. This property is not supported by SAFR Inside. Left boundary Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.left-distance 0.1 The percentage of the camera view that a tracked person can travel in a leftward direction before a direction of travel event is generated. This property doesn't have any effect if tracker.detect-direction-of-travel.person.left is set to FALSE. This property is not supported by SAFR Inside. Left travel distance Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.right FALSE Enables direction of travel detection in the rightward direction. This property is not supported by SAFR Inside. Right travel distance (the checkbox) Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.right-boundary 0 The percentage of the right side of the camera view field to exclude from direction of travel event reporting. This property is not supported by SAFR Inside. Right boundary Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.right-distance 0.1 The percentage of the camera view that a tracked person can travel in a rightward direction before a direction of travel event is generated. This property doesn't have any effect if tracker.detect-direction-of-travel.person.right is set to FALSE. This property is not supported by SAFR Inside. Right travel distance Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.top-boundary 0 The percentage of the top side of the camera view field to exclude from direction of travel event reporting. This property is not supported by SAFR Inside. Top boundary Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.up FALSE Enables direction of travel detection in the upward direction. This property is not supported by SAFR Inside. Up/Away travel distance (the checkbox) Direction of Travel Recognition section of the Camera Preferences menu
tracker.detect-direction-of-travel.person.up-distance 0.1 The percentage of the camera view that a tracked person can travel in an upward direction before a direction of travel event is generated. This property doesn't have any effect if tracker.detect-direction-of-travel.person.up is set to FALSE. This property is not supported by SAFR Inside. Up/Away travel distance Direction of Travel Recognition section of the Camera Preferences menu

Detection Properties

Property Default Value Description UI Setting Name UI Setting Location
detector.detect-badges FALSE Whether detection of badges should be enabled for this feed. This property is not supported by SAFR Inside. Enable badge detector Badge detector section of the Detection Preferences menu
detector.detect-faces TRUE Whether detection of faces should be enabled for this feed. Enable face detector Face detector section of the Detection Preferences menu
detector.detect-faces-input-size "normal" Face detector input size. Applicable only when high-sensitivity detection service is used. Possible values:
small - 320x240 or 320x180 or 240x320 or 180x320 (whichever fits better)
normal - 640x480 or 640x360 or 480x640 or 360x640 (whichever fits better)
large - 1280x720 or 720x1280 (whichever fits better)
Input Size Face detector section of the Detection Preferences menu
detector.detect-faces-service "auto" Specifies which face detection service will be used:
standard - The standard facial detection service that SAFR uses.
high-sensitivity - A high sensitivity facial detection service which has a lower latency and whose performance doesn't degrade when multiple faces are being analyzed simultaneously. The high sensitivity service consumes many more GPU resourcs than the standard service.
auto - This value will automatically select the high sensitivity service if sufficient GPU resources are available to run it. If there are insufficient GPU resources, then the standard service is used instead.
This property is not supported by SAFR Inside.
Detection service Face detector section of the Detection Preferences menu
detector.detect-people FALSE Whether detection of people should be enabled for this feed. This detects any part of a person's body and not just the face. This property is not supported by SAFR Inside. Enable person detector Person detector section of the Detection Preferences menu
detector.detect-people-every-n-frames 1 This can be used to avoid running person detection on every frame. Since person detection requires a lot of GPU processing if the hardware is not powerful enough this value can be changed so that we only attempt to detect people every Nth frame to save processing power to keep up with realtime detection. This property is not supported by SAFR Inside. Detect persons every Person detector section of the Detection Preferences menu
detector.detect-people-input-size "normal" Valid values:
normal - 416 pixel input. People detection balances speed and accuracy for best results.
small - 320 pixel input. People detection will be the fastest with this input, but least accurate.
large - 608 pixel input. People detection will be the slowest with this input, but most accurate.
This property is not supported by SAFR Inside.
Input Size Person detector section of the Detection Preferences menu
detector.detect-people-model "balanced" Valid values:
max-accuracy - Use a larger model for better accuracy, but the speed will be slower.
max-speed - Use a smaller model for faster speed, but the accuracy will be lower.
balanced - Use a larger model for better accuracy, but the precision will be slightly lower resulting in faster speeds than the max-accuracy model without sacrificing too much accuracy. This property is not supported by SAFR Inside.
Detection service Person detector section of the Detection Preferences menu
detector.detect-rgb-liveness FALSE Enables the RGB liveness detector. This property is not supported by SAFR Inside. Enable RGB liveness detector RGB liveness detector section of the Detection Preferences menu
detector.face-sensitivity-threshold 0 The sensitivity threshold when using the High Sensitivity facial detection service. The lower this value is, the more lenient the facial detection service will be when attempting to recognize a face, which can result in additional false positives. This setting is only available if you selected High Sensitivity for the Detection service setting above. This property is not supported by SAFR Inside. Detection Sensitivity Threshold Face detector section of the Detection Preferences menu
detector.final-face-selection-threshold 0.9 The final face candidate threshold that is used during face detection. This property is not supported by SAFR Inside. Final candidate selection threshold Face detector section of the Detection Preferences menu
detector.initial-face-selection-threshold 0.8 The initial face candidate threshold that is used during face detection. This property is not supported by SAFR Inside. Initial candidate selection threshold Face detector section of the Detection Preferences menu
detector.maximum-concurrent-detections 1 The maximum number of concurrent detections to allow. 0 means to automatically set this. This property is not supported by SAFR Inside. Maximum detectors per feed Face detector section of the Detection Preferences menu
detector.maximum-input-resolution 720 Maximum resolution of the Input image. Bigger images are scaled down (aspect-ratio preserving) to this resolution before detection. Reduce vertical input image size to Face detector section of the Detection Preferences menu
detector.maximum-input-resolution-badges 4320 Maximum resolution of the Input image. Bigger images are scaled down (aspect-ratio preserving) to this resolution before detection. This property is not supported by SAFR Inside. Reduce vertical input image size to Badge detector section of the Detection Preferences menu
detector.middle-face-selection-threshold 0.85 The middle face candidate threshold that is used during face detection. This property is not supported by SAFR Inside. Middle candidate selection threshold Face detector section of the Detection Preferences menu
detector.minimum-consecutive-detections-required-person 0 This is the number of consecutive detections that are required before reporting that the person (based on object id) was actually detected and can be used to filter out false positives. This property is not supported by SAFR Inside. Consecutive confirmation required Person detector section of the Detection Preferences menu
detector.minimum-required-badge-size 0 The minimum size of badges to accept from the detector. Only badges with at least this size are eligible for recognition. This property is not supported by SAFR Inside. Minimum required badge size Badge detector section of the Detection Preferences menu
detector.minimum-required-face-size 0 The minimum size of faces to accept from the detector. Only faces with at least this size are eligible for recognition. Minimum required face size Face detector section of the Detection Preferences menu
detector.minimum-required-person-to-screen-height-proportion 0 Specifies the ratio of the person to the screen height. This can be between 0 - 1 and allows for decimal precision. For example, if you don't want the person to show up unless they are greater than 25% of the image height then specify a value of 0.25. This property is not supported by SAFR Inside. Minimum required person to screen proportion Person detector section of the Detection Preferences menu
detector.minimum-searched-badge-size 20 The badge detector is advised to search for badges of at least this size. This value is applied while searching the image. This property is not supported by SAFR Inside. Minimum searched badge size Badge detector section of the Detection Preferences menu
detector.minimum-searched-face-size 80 The face detector is advised to search for faces of at least this size. This value is applied while searching the image. This property is not supported by SAFR Inside. Minimum searched face size Face detector section of the Detection Preferences menu
detector.person-detection-threshold 0.4 This is the detection threshold to use when matching objects. The higher the threshold the more strict the matching will be and the higher the confidence will be that the actual object matches. This property is not supported by SAFR Inside. Person detection threshold Person detector section of the Detection Preferences menu
detector.person-separation-threshold 0.45 This threshold controls the object separation when the objects are overlapping. This determine how much overlap is needed before no longer detecting the object with the weaker footprint. This property is not supported by SAFR Inside. Person separation threshold Person detector section of the Detection Preferences menu
detector.rgb-liveness-detection-scheme "strict-multimodal" Specifies which RGB liveness model(s) should be used:
texture-unimodal: Only the Texture model will be used.
context-unimodal: Only the Context model will be used.
strict-multimodal: Both the Texture and Context models will be used. For a subject to pass the RGB liveness test, both of the results of the models must meet or exceed the Liveness detection threshold value.
normal-multimodal: Both the Texture and Context models will be used. For a subject to pass the RGB liveness test, the average of the results of the two models must meet or exceed the Liveness detection threshold value.
tolerant-multimodal: Both the Texture and Context models will be used. Subjects pass the RGB liveness test when the result of either model meets or exceeds the Liveness detection threshold value.
This property is not supported by SAFR Inside.
Detection scheme RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-evaluate-fake-over-n-frames 10 The number of frames over which fakeness should be evaluated. This property is not supported by SAFR Inside. Evaluate fake over RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-evaluate-over-n-frames 10 The number of frames over which RGB liveness detection should be evaluated. This property is not supported by SAFR Inside. Evaluate liveness over RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-fake-threshold 0.2 Specifies how difficult it will be for a subject to be verified as NOTLIVE_CONFIRMED. This property is not supported by SAFR Inside. Fake detection threshold RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-center-pose-quality 0.2 The minimum face center pose quality for RGB liveness detection to be used. This property is not supported by SAFR Inside. Minimum required center pose quality RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-confirmed-percent 0.85 The percentage of frames that must meet the liveness or fake threshold for the subject to be declared either LIVENESS_CONFIRMED or NOTLIVE_CONFIRMED. This property is not supported by SAFR Inside. Minimum confirmations required RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-face-context-percent 1.0 The minimum required extra context around faces for the Context model of RGB liveness detection to be used. This property is not supported by SAFR Inside. Minimum required face context size RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-face-contrast-quality 0.45 The minimum face contrast quality for RGB liveness detection to be used. This property is not supported by SAFR Inside. Minimum required face contrast quality RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-face-sharpness-quality 0.45 The minimum face sharpness quality for RGB liveness detection to be used. This property is not supported by SAFR Inside. Minimum required face sharpness quality RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-face-size 150 The minimum required height and width of a face, in number of pixels, for the Texture model of RGB liveness detection to be used. This property is not supported by SAFR Inside. Minimum required face size RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-minimum-preliminary-threshold 0.19 For multimodal detection schemes, this is the liveness threshold which the first evaluated model (the Texture model) must exceed before SAFR will bother evaluating the second model. If this threshold is not met, SAFR immediately returns NOTLIVE_CONFIRMED for the subject. This property is not supported by SAFR Inside. Minimum preliminary liveness threshold RGB liveness detector section of the Detection Preferences menu
detector.rgb-liveness-threshold 0.6 Specifies how difficult it will be for a subject to be verified as LIVENESS_CONFIRMED. This property is not supported by SAFR Inside. Liveness detection threshold RGB liveness detector section of the Detection Preferences menu
tracker.minimum-required-consecutive-badge-detections 0 The number of consecutive detections that are required before reporting that the object (based on object id) was actually detected. This property can be used to filter out false positives. This property is not supported by SAFR Inside. Consecutive confirmations required Badge detector section of the Detection Preferences menu

Tracking Properties

Property Default Value Description UI Setting Name UI Setting Location
tracker.enable-face-bounds-prediction TRUE Enables face bounds prediction, which predicts which direction the face is moving to maintain tracking. Enable motion prediction Tracking Preferences menu
tracker.enable-face-size-correlation TRUE Enables face correlation of tracked faces, which compares detected faces looking for a change in area. Enable correlation of faces by size Tracking Preferences menu
tracker.enable-high-precision FALSE Enables high precision tracking, which decreases event fragmentation and increases the stickiness of SAFR's tracking algorithm at the cost of computer processing power. This property should be enabled if you are experiencing duplicate or missing Direction of Travel events. See Camera Preferences for information about the Direction of Travel feature. This property is not supported by SAFR Inside. High precision tracking Tracking Preferences menu
tracker.failed-recognition-back-off-interval 340 After making the initial recognition attempts as quickly as possible, back up the amount specified by this setting for each subsequent recognition. This continues until the retry interval is reached. Failed recognition back-off interval Tracking Preferences menu
tracker.failed-recognition-retry-interval 0 The interval in which to run recognition requests if the face has not been recognized. Retry failed recognition after every Tracking Preferences menu
tracker.identity-relearn-interval-days 0 Updates the identity only when the currently saved identity is older than the updated identity. Relearn face interval days Tracking Preferences menu
tracker.identity-update-better-image FALSE Updates the identity when the currently saved identity is of lower quality (in all aspects) than the new image. Update identity with better image Tracking Preferences menu
tracker.initial-recognition-attempts 3 The number of initial recognition attempts to make on an unrecognized person as fast as possible. Initial recognition attempts Tracking Preferences menu
tracker.maximum-linger-frames 30 Determines for how many frames more we continue to keep a tracked face around after we have failed to detect it in the most recent frame. This makes the tracker resilient against intermittent loss of face. Stop tracking a face after it has lingered for Tracking Preferences menu
tracker.max-position-change-relative-to-face 115 The maximum position change, specified in percentage relative to the face size, to continue tracking. Maximum change to continue tracking, Face position Tracking Preferences menu
tracker.max-size-change-relative-to-face 50 The maximum size change, specified in percentage relative to the object size, to continue tracking. Maximum change to continue tracking, Size Tracking Preferences menu
tracker.min-failed-recognitions-to-stop-tracking-identity 3 When a face is being tracked recognitions are continually confirming the identity. The identity is also being verified if it is transferred from a person object. In these cases, if the recognition or verification fails this number of consecutive times then the identity will be reset and no longer associated with the face because we are no longer sure it is the same identity. Minimum failed recognitions to stop tracking identity Tracking Preferences menu
tracker.minimum-number-identical-recognitions-learn 2 The number of consecutive recognitions that need to occur before adding a new identity to the system. Minimum recognitions to learn identity Tracking Preferences menu
tracker.minimum-number-identical-recognitions-lock 1 The number of consecutive recognition attempts that we must run and produce the same person identity before we lock onto this identity. Minimum recognitions to lock on to identity Tracking Preferences menu
tracker.minimum-required-consecutive-mask-detections 1 The number of consecutive detections that are required before reporting that the masked person was detected. This property can be used to filter out false positives. This property is not supported by SAFR Inside. Consecutive Mask Detections Tracking Preferences menu
tracker.reconfirm-identity-in-video-on-every-key-frame FALSE When a key frame is encountered in a video file all the faces that are being tracked are marked as unconfirmed so that their identities are reconfirmed to make sure they are the same person. This setting only applies to video files; it can't be used with live video. This property doesn't actually appear in the VIRGO property list; possibly delete. Reconfirm identity in video after each Key Frame Tracking Preferences menu
tracker.reconfirmation-interval 1000 Identity reconfirmation time interval in ms. Reconfirm identity after every Tracking Preferences menu
tracker.stop-tracking-on-failed-re-recognition FALSE If recognition fails when re-recognizing a person then delete the identity that was created. Stop tracking on failed re-recognition Tracking Preferences menu

Recognition Properties

Property Default Value Description UI Setting Name UI Setting Location
recognizer.3d-liveness-threshold 0.6 Windows only. Specifies the 3d liveness threshold. This property is not supported by SAFR Inside. Liveness threshold Detect section of the Recognition Preferences menu
recognizer.detect-3d-liveness FALSE Windows only. Enables 3D liveness detection on Intel RealSense D415 and D435 cameras. This property is not supported by SAFR Inside. 3D Liveness Detect section of the Recognition Preferences menu
recognizer.detect-age FALSE Enables the detection of age information. Age Detect section of the Recognition Preferences menu
recognizer.detect-gender FALSE Enables the detection of gender information. Gender Detect section of the Recognition Preferences menu
recognizer.detect-identity TRUE Enables detection of an identity, which matches against the existing database of people (identities). Identity Detect section of the Recognition Preferences menu
recognizer.detect-mask FALSE When enabled, SAFR will evaluate all occluded faces to see if they're covered by a mask. If they are, then SAFR will use the mask enhanced model to attempt to recognize the face behind the mask. If the occluded face isn't covered by a mask, then the normal occluded model will be used instead. Mask Detect section of the Recognition Preferences menu
recognizer.detect-mask-threshold 0.5 Specifies the threshold at and above which mask detection will conclude that mask=true. Mask Detection Threshold Detect section of the Recognition Preferences menu
recognizer.detect-occlusion FALSE Enables occlusion detection during recognition. Occlusion Detect section of the Recognition Preferences menu
recognizer.detect-pose-action FALSE Enables pose liveness detection. This property is not supported by SAFR Inside. Pose liveness action Detect section of the Recognition Preferences menu
recognizer.detect-rgb-action FALSE Enables RGB liveness detection. Note that the RGB Liveness Detector on the Detection Preferences menu must be enabled for RGB liveness detection to work. This property is not supported by SAFR Inside. RGB liveness action Detect section of the Recognition Preferences menu
recognizer.detect-sentiment FALSE Enables the detection of sentiment information. Sentiment Detect section of the Recognition Preferences menu
recognizer.detect-smile-action FALSE Enables the smile action recognizer. This property is not supported by SAFR Inside. Smile action Detect section of the Recognition Preferences menu
recognizer.identity-masked-threshold-offset 0 Sets the identity threshold when detecting masks. Masked face threshold offset Identity recognition threshold section of the Recognition Preferences menu
recognizer.identity-proximity-threshold-allowance 0.13 A boost value that is added to the Identity Recognition Threshold. Proximity threshold allowance Identity recognition threshold section of the Recognition Preferences menu
recognizer.identity-recognition-threshold 0.54 Identity recognition threshold. Identity recognition threshold Identity recognition threshold section of the Recognition Preferences menu
recognizer.learning-enabled FALSE Enables the feed to learn new identities. Identity Detect section of the Recognition Preferences menu
recognizer.learn-occluded-faces FALSE Enables learning of occluded faces regardless of the maximum occlusion setting. If this is true then the server configuration will be used, which by default doesn't do any occlusion detection. Allow learning of occluded faces Detect section of the Recognition Preferences menu
recognizer.maximum-clip-ratio 0.1 The maximum clip ratio on either side the recognition candidate might have. For recognition Clipping tolerances section of the Recognition Preferences menu
recognizer.maximum-clip-ratio-identification 0 The maximum clip ratio on either side the insertion candidate might have. For learning/strangers Clipping tolerances section of the Recognition Preferences menu
recognizer.maximum-concurrent-recognitions 5 The maximum number of concurrent recognitions to allow. 0 means to automatically set this. This property is not supported by SAFR Inside. Maximum recognizers per feed Recognition Preferences menu
recognizer.maximum-occlusion 0 The maximum occlusion value that is allowed when adding new candidate images into the Person Directory. If the face is occluded with a value greater than this then the face will not be added, but if it's less than or equal to this value then it will be added. Occlusion threshold Detect section of the Recognition Preferences menu
recognizer.maximum-pitch-identification 0.4 The maximum pitch value used to determine if the face is looking straight ahead. The pitch value is the forward/backward movement of the face. Max Pitch Minimum required center pose quality section of the Recognition Preferences menu
recognizer.maximum-roll-identification 0.15 The maximum roll value used to determine if the face is looking straight ahead. The roll value is the side to side tilt movement of the face. Max Roll Minimum required center pose quality section of the Recognition Preferences menu
recognizer.maximum-yaw-identification 0.4 The maximum yaw value used to determine if the face is looking straight ahead. The yaw value is the side to side movement of the face. Max Yaw Minimum required center pose quality section of the Recognition Preferences menu
recognizer.minimum-center-pose-quality 0.05 The minimum center pose quality that a recognition candidate must have in order to allow the addition of the candidate image into the Person Directory. For recognition Minimum required center pose quality section of the Recognition Preferences menu
recognizer.minimum-center-pose-direct-gaze 0.70 If a face's center pose quality is above this value, the face is determined to be gazing directly at the camera, but if the center pose quality is below this value, the face is determined to be turned away. The longer the face gazes directly at the camera, the longer events' directGazeDuration is. This property is not supported by SAFR Inside. For direct gaze detection Minimum required center pose quality section of the Recognition Preferences menu
recognizer.minimum-center-pose-quality-identification 0.45 The minimum center pose quality that a recognition candidate must have in order to allow the addition of the candidate image into the Person Directory. For learning/strangers Minimum required center pose quality section of the Recognition Preferences menu
recognizer.minimum-center-pose-quality-merging 0.59 The minimum center pose quality that a recognition candidate must have in order to allow merging. For merging Minimum required center pose quality section of the Recognition Preferences menu
recognizer.minimum-face-contrast-quality 0.1 The minimum face contrast quality that a face image must have before recognition is attempted. For recognition Minimum required face contrast quality section of the Recognition Preferences menu
recognizer.minimum-face-contrast-quality-identification 0.3 The minimum face contrast quality that a recognition candidate must have in order to allow the addition of the candidate image into the Person Directory. For learning/strangers Minimum required face contrast quality section of the Recognition Preferences menu
recognizer.minimum-face-contrast-quality-merging 0.45 The minimum face contrast quality that a recognition candidate must have in order to allow merging. For merging Minimum required face contrast quality section of the Recognition Preferences menu
recognizer.minimum-face-sharpness-quality 0.1 The minimum face sharpness quality that a face image must have before recognition is attempted. For recognition Minimum required face sharpness quality section of the Recognition Preferences menu
recognizer.minimum-face-sharpness-quality-identification 0.3 The minimum face sharpness quality that a recognition candidate must have in order to allow the addition of the candidate image into the Person Directory. For learning/strangers Minimum required face sharpness quality section of the Recognition Preferences menu
recognizer.minimum-face-sharpness-quality-merging 0.45 The minimum face sharpness quality that a recognition candidate must have in order to allow merging. For merging Minimum required face sharpness quality section of the Recognition Preferences menu
recognizer.minimum-face-size 80 The minimum size of faces to detect. This value is applied after searching the image. For recognition Minimum required face size section of the Recognition Preferences menu
recognizer.minimum-face-size-identification 120 The minimum resolution that a recognition candidate image must have in order to allow the addition of the candidate image into the Person Directory. For learning/strangers Minimum required face size section of the Recognition Preferences menu
recognizer.minimum-face-size-merging 220 The minimum resolution a recognition candidate must have in order to allow merging. For merging Minimum required face size section of the Recognition Preferences menu
recognizer.pose-action-max-cpq-jump-after-discontinuity 0.15 The maximum change between samples while the pose is changing from center to profile if lingering. This property is not supported by SAFR Inside. Max CPQ jump after tracking loss Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-max-cpq-jump-in-continuity 0.18 The maximum change between samples while the pose is changing from center to profile. This property is not supported by SAFR Inside. Max CPQ jump in continuous tracking Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-max-profile-confidence-end 0.60 The maximum profile pose confidence to allow during the final profile pose detection phase. This property is not supported by SAFR Inside. Min profile confidence at end Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-max-profile-pose-quality 0.26 The maximum center pose quality to use when detecting the final profile pose. This property is not supported by SAFR Inside. Profile pose quality Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-max-profile-pose-roll 0.3 The maximum roll threshold in either direction in which the face can rotate when determining whether the face is in profile pose. This property is not supported by SAFR Inside. Max profile pose roll Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-min-center-pose-quality 0.5 The minimum center pose quality to use when detecting the initial center pose. This property is not supported by SAFR Inside. Center pose quality Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-min-detections-per-second 15 The minimum number of frames per second that is required during the process. This property is not supported by SAFR Inside. Min Detections Per Second Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-min-profile-confidence-start 0.35 The minimum profile pose confidence to allow during the initial center pose detection phase. This property is not supported by SAFR Inside. Max profile confidence at start Detect section of the Recognition Preferences menu
recognizer.pose-action-min-profile-pose-yaw 0.81 The minimum profile pose yaw value that is required during the final profile pose detection phase. This property is not supported by SAFR Inside. Min profile pose yaw Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-min-profile-similarity 0.86 The minimum similarity score required when verifying the final profile pose. This property is not supported by SAFR Inside. Min profile similarity Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-min-transition-poses 2 The minimum number of required center pose samples during the transition from center to profile pose. This property is not supported by SAFR Inside. Min transition poses Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-profile-pose-required-confirmations 1 The number of consecutive confirmations required to enter the final profile pose detection phase. This property is not supported by SAFR Inside. Profile pose consecutive confirmations required Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-action-required-confirmations 3 The number of consecutive confirmations required to enter the initial center pose detection phase. This property is not supported by SAFR Inside. Center pose consecutive confirmations required Pose liveness action configuration section of the Recognition Preferences menu
recognizer.pose-configuration-identification-enabled FALSE If this is true then pose configuration is enabled for identification. The pose configuration allows for replacing center pose quality with advanced parameters such as yaw, pitch and roll. When pose configuration is enabled, then recognizer.minimum-center-pose-quality is ignored and the following 3 properties are used instead: recognizer.maximum-yaw-identification, recognizer.maximum-pitch-identification, and recognizer.maximum-roll-identification. Identification Enabled Pose liveness action configuration section of the Recognition Preferences menu
recognizer.rgb-action-identity-threshold-boost 0.0 The amount to temporarily boost identity recognition attempts during RGB liveness actions. This property is not supported by SAFR Inside. Identity recognition threshold boost RGB liveness action configuration section of the Recognition Preferences menu
recognizer.rgb-action-min-recognitions-fake 2 The minimum number of consecutive "fake" recognitions that are required in order to consider the face fake. This property is not supported by SAFR Inside. Consecutive recognitions for fake RGB liveness action configuration section of the Recognition Preferences menu
recognizer.rgb-action-min-recognitions-live 2 The minimum number of consecutive "live" recognitions that are required in order to consider the face live. This property is not supported by SAFR Inside. Consecutive recognitions for live RGB liveness action configuration section of the Recognition Preferences menu
recognizer.smile-detect-rgb-liveness FALSE Enables RGB liveness detection for the smile action recognizer. RGB liveness validation Smile action configuration section of the Recognition Preferences menu
recognizer.smile-rgb-action-min-recognitions-fake 2 The minimum number of consecutive "fake" recognitions that are required in order to consider the face fake. Consecutive recognitions for fake Smile action configuration section of the Recognition Preferences menu
recognizer.smile-rgb-action-min-recognitions-live 2 The minimum number of consecutive "live" recognitions that are required in order to consider the face live. Consecutive recognitions for live Smile action configuration section of the Recognition Preferences menu
recognizer.smile-duration 0 The amount of time that the smile should last. This property is not supported by SAFR Inside. Smile duration Smile action configuration section of the Recognition Preferences menu
recognizer.smile-identity-threshold-boost 0.13 The smile threshold to boost temporarily during the smile action. This property is not supported by SAFR Inside. Identity recognition threshold boost Smile action configuration section of the Recognition Preferences menu
recognizer.smile-pre-delay 100 The amount of time that there should be no smile. This property is not supported by SAFR Inside. Pre-smile delay Smile action configuration section of the Recognition Preferences menu
recognizer.smile-thresholds-enabled FALSE Enables the smile threshold values. This property is not supported by SAFR Inside. Transition thresholds Smile action configuration section of the Recognition Preferences menu
recognizer.smile-threshold-neutral -0.1 The threshold in which there is no smile. This property is not supported by SAFR Inside. The neutral face slider below the Transition thresholds setting. Smile action configuration section of the Recognition Preferences menu
recognizer.smile-threshold-smiling 0.7 The threshold in which there is a smile. This property is not supported by SAFR Inside. The smiley face slider below the Transition thresholds setting. Smile action configuration section of the Recognition Preferences menu

Event Properties

Property Default Value Description UI Setting Name UI Setting Location
reporter.delay 0 Delay the event reporting to the server by this amount in seconds. Reporting delay Report events section of the Events Preferences menu
reporter.enabled TRUE Enables or disables event reporting. Report events Report events section of the Events Preferences menu
reporter.maximum-face-image-size 240 When event images are being saved, this property specifies the maximum size of the event face images, in pixels. Preserve Event Face Image, Max Image Size Report events section of the Events Preferences menu
reporter.maximum-scene-image-size 320 When event scene thumbnail images are being saved, this property specifies the maximum size of the event scene thumbnail images, in pixels. Preserve Event Scene Thumbnail Image, Max Image Size Report events section of the Events Preferences menu
reporter.minimum-event-duration-identified 0 The minimum allowed recognized person event duration in seconds. Events shorter than this duration will not be reported. Min Identified Event Duration Report events section of the Events Preferences menu
reporter.minimum-event-duration-stranger 0 The minimum allowed stranger event duration in seconds. Events shorter than this duration will not be reported. Min Stranger Event Duration Report events section of the Events Preferences menu
reporter.minimum-event-duration-unidentified 1500 The minimum allowed unrecognizable person event duration in seconds. Events shorter than this duration will not be reported. Min Unrecognizable Event Duration Report events section of the Events Preferences menu
reporter.report-event-face TRUE Enables the inclusion of face thumbnails in event reports. Preserve Event Face Image Report events section of the Events Preferences menu
reporter.report-event-scene FALSE Enables the inclusion of scene images in event reports. Preserve Event Scene Thumbnail Image Report events section of the Events Preferences menu
reporter.report-secondary-events FALSE Reports secondary events. Secondary events are events that are associated with a primary event via the rootEventId property in the event. It is usually preferred to only report the primary events and the secondary events need to only be reported if there is more detail needed. If this is disabled then all events with a rootEventId property set to a primary event will not be reported. Only events with rootEventId not set to anything will be reported, which are the primary events. Include Secondary Events Report events section of the Events Preferences menu
reporter.report-speculated-events TRUE Reports events for speculated faces. Speculated faces are faces that aren't a 100% match, but are close. Include Speculated Identity Events Report events section of the Events Preferences menu
reporter.report-stranger-events TRUE Reports events for people that are strangers. These are people not registered by the system after running facial recognition on the face. Include Stranger Events Report events section of the Events Preferences menu
reporter.report-unrecognizable-events TRUE Reports events for people that are not recognizable. Include Unrecognizable Events from Camera and Include Unrecognizable Events from Video Report events section of the Events Preferences menu
reporter.stranger-events.only-if-occluded FALSE Specifies whether only occluded stranger events should be reported. By default stranger events are only generated if the face is not occluded, if occlusion detection is enabled, otherwise they are generated when the face meets the identification image quality metrics. If this option is set to true then stranger events will be reported only if the face is occluded. Include Stranger Events, Only if occluded Report events section of the Events Preferences menu
reporter.stranger-maximum-age 0 The maximum age of strangers that will trigger stranger events. If a stranger older than the specified maximum age is detected, no stranger event is generated. Include Stranger Events, Max Age Report events section of the Events Preferences menu
reporter.stranger-minimum-age 0 The minimum age of strangers that will trigger stranger events. If a stranger younger than the specified minimum age is detected, no stranger event is generated. Include Stranger Events, Min Age Report events section of the Events Preferences menu
reporter.update-images FALSE Updates the thumbnail images with higher quality images during the course of the event if possible. Update in-progress event attributes, Include qualified images with updates Report events section of the Events Preferences menu
reporter.update-in-progress-event-interval 1000 When reporter.update-in-progress-event-properties is set to TRUE, this property specifies the time interval in which to update event properties that change. When reporter.update-in-progress-event-properties is set to FALSE, this property has no effect. Update in-progress event attributes, Update interval Report events section of the Events Preferences menu
reporter.update-in-progress-event-properties FALSE If this is enabled, then any event properties that change will be updated at the specified reporter.update-in-progress-event-interval. Many properties do change periodically. (e.g. averages that are continually computed) Update in-progress event attributes Report events section of the Events Preferences menu

Miscellaneous Properties

Property Default Value Description UI Setting Name UI Setting Location
directory N/A Directory name. User Directory Account Preferences menu
input.crop-rectangle.enabled FALSE When this is true the defined crop rectangle is used for the camera feed. The crop rectangle is specified in a normalized coordinate system, which means the rectangle is (0, 0) x (1, 1). This property is not supported by SAFR Inside. The Crop button Camera Feed Analyzer
input.crop-rectangle.height 1 The normalized height value relative to the video of how big the crop rectangle size should be. This property is not supported by SAFR Inside. The Crop button Camera Feed Analyzer
input.crop-rectangle.left 0 The normalized left coordinate relative to the video of where the crop rectangle origin should be. This property is not supported by SAFR Inside. The Crop button Camera Feed Analyzer
input.crop-rectangle.top 0 The normalized top coordinate relative to the video of where the crop rectangle origin should be. This property is not supported by SAFR Inside. The Crop button Camera Feed Analyzer
input.crop-rectangle.width 1 The normalized width value relative to the video of how big the crop rectangle size should be. This property is not supported by SAFR Inside. The Crop button Camera Feed Analyzer
input.loop FALSE Enables looping of the feed input. Only video file-based feeds support looping. Ignored when input.type is set to "stream". (e.g. when a camera feed is being processed). This property is not supported by SAFR Inside. Loop playback Video section of the User Interface Preferences menu
input.stream.name N/A A friendly name used for display purposes. This property is not supported by SAFR Inside. Feed Name Add Feed dialogue after pressing the Add to Video Feeds button
mode "Enrolled and Stranger Monitoring" Specifies which operator mode the feed is using. The Operator Mode drop-down menu Camera Feed Analyzer
reporter.events-date-timestamps-enabled TRUE When a video file is being processed, this property is used to determine whether the events should use date timestamps relative to an initial start date or video timestamps relative to the start of the video.

If this setting is FALSE, video timestamps will be used. In this case the timestamps are relative to the start of the video, which is typically 0. It also sets the context to "media" when posting the event so that the time will properly be interpreted as a timestamp rather than a date.

If this setting is set to TRUE, then date timestamps will be used relative to the reporter.events-initial-date-offset. If reporter.events-initial-date-offset is null then the current system date will be used when the video processing starts. In this case, the context is set to "live" when posting events so that the time will properly be interpreted as a date.

There are cases when videos are processed where users are interested in video timestamps. (e.g. a video indexing feature) In these cases, this setting should be set to FALSE. The more common use case now is that users are interested in processing video files in real time or processing security videos from specific times that it is necessary to use date timestamps relative to a specific time instead of video timestamps relative to the start of the video. The reporter.events-initial-date-offset option is ignored when this is set to false. This property is not supported by SAFR Inside.
Actual start time Open video file dialog
reporter.events-initial-date-offset 0 When processing a video file for events this value can be used to set the initial date offset to use for the events being processed. By default video events start with current system time. This option is ignored if the reporter.events-date-timestamps-enabled option is set to FALSE because video timestamps will be used instead. Actual start time Open video file dialog
site N/A Site name, if any. Default Site Account Preferences menu

SAFR SCAN Properties

The UI for all these properties can be found in the SAFR SCAN Console.

Property Default Value Description UI Setting Name Sidetab Location Tab Location
access.tailgating.cardId "" If set, this cardId is sent to the connected control panel when tailgating is detected. Tailgating Signal Card ID Tailgating Operation
access.tailgating.detect-on-exit False If False, tailgating is only detected for people entering the facility (i.e., approaching the camera). If True, tailgating is detected for people entering or exiting the facility. Detection direction Tailgating Operation
access.tailgating.distance 1.2 The maximum distance, in meters, after an authorized person where a subsequent person is considered a tailgater. Maximum tailgating distance Tailgating Operation
access.tailgating.door-open-signal "disabled" Configures the door open signal. There are three possible values:
disabled:The door open signal is disabled.
low:By default, the door open signal will indicate that the door is closed; a charge must be sent in order to indicate that the door is open.
high:By default, the door open signal will indicate that the door is open; a charge must be sent in order to indicate that the door is closed.
Door open input signal Tailgating Operation
access.tailgating.enabled False Enables tailgating detection. Tailgating detection Tailgating Operation
access.tailgating.facilityId "" If set, this facilityId is sent to the connected control panel when tailgating is detected. Tailgating Signal Card Facility ID Tailgating Operation
access.tailgating.time 10000 The minimum amount of time, in milliseconds, where tailgating is enforced after an authorized person is granted access. Minimum enforced tailgating time Tailgating Operation
display.message.tailgating "Tailgating" Message when tailgating is detected. Tailgating detected message Display Operation
display.tailgating.duration 5000 The duration, in milliseconds, of the LED display when SAFR SCAN detects tailgating. Tailgating detected light duration Display Operation
display.tailgating.max-brightness 1.0 The brightness of the LED display when SAFR SCAN detects tailgating. This value ranges from 0 to 1, inclusive. Tailgating detected light brightness Display Operation
display.tailgating.rgb "FF6D00" RGB color code in hexadecimal of SAFR SCAN's LED display when tailgating is detected. Tailgating detected light color Display Operation

Properties Not Appearing in the UI

Property Default Value Description
accelerator "auto" The type of acceleration that a feed should use. There are three possible values:
auto - VIRGO will automatically pick the best available acceleration type. For example, VIRGO will assign the feed to one of the available GPUs if there is still processing capacity available. Otherwise VIRGO will assign the feed to the CPU.
cpu - The feed will exclusively run on the CPU and not use any GPU even if a GPU is available.
gpu - The feed will exclusively run on a GPU and not use the CPU for video decoding, graphics processing, or detection. The feed will fail if no GPU is available.
This property is not supported by SAFR Inside.
accelerator.gpu-id 0 The GPU identifier to use when GPU acceleration is in use. This property is only used when the accelerator property is set to gpu or auto, and a GPU is being used. If the accelerator.gpu-id property is specified it will force the specific GPU to be used, and if failure occurs SAFR will fall back to the CPU. accelerator.gpu-id is an advanced setting that should only be used in very specific cases. This property is not supported by SAFR Inside.
accelerator.gpu-frame-pool-size -2 Used to set the initial GPU video frame pool size. accelerator.gpu-frame-pool-size is an advanced setting that can be used to fine tune certain use cases. The possible values for this property are listed below.

-2: Indicates that the platform default behavior should be used. The platform will determine what GPU frame pool size to use.

-1: Indicates that the hardware decoder default value should be used. The only time the hardware decoder default value is not used is if it will cause a problem with the hardware accelerator implementation.

0 - N: This value will override the automatic value and will be used unless this will cause a problem in the hardware accelerator implementation. The maximum value for N is 32. This should be changed with caution because using low values (e.g. 0, 1, 2, or 3) can cause performance issues.

This property is not supported by SAFR Inside.
capture.frame-delay 30 Wall-clock time between consecutive frame captures. If this value is set to 0 then VIRGO will capture frames as fast as the native frame rate is playing the video. This property is not supported by SAFR Inside.
capture.maximum-frames 3600 If > 0, enables the capture of "max-frames" frames; if 0, disables capture. This property is not supported by SAFR Inside.
capture.overlay-level 3 Specifies manner in which overlays will be provided. This property is not supported by SAFR Inside.

0 = Won't provide overlays.

1 = Provides overlays as separate object tracking meta-data streams.

2 = Provides overlays rendered directly into the video frames.

3 = Provides overlays as separate object tracking meta-data streams and rendered directly into the video frames - both or whichever is available - to the maximum available according to the declared capabilities.
capture.size 480 Specifies size of the smaller dimension of the image that will be sent. This property is not supported by SAFR Inside.
detector.detect-vehicle N/A Internal use only.
detector.detect-vehicle-every-n-frames N/A Internal use only.
detector.detect-vehicle-input-size N/A Internal use only.
detector.detect-vehicle-model N/A Internal use only.
detector.minimum-consecutive-detections-required-vehicle N/A Internal use only.
detector.minimum-required-vehicle-to-screen-proportion N/A Internal use only.
enabled FALSE Enables or disables the feed.
input.contrast-enhancement.detection-only FALSE If true then contrast enhancement is applied to the image which is handed off to the face detector only. If false then contrast enhancement is applied to the video frame as delivered by the camera. Consequently the contrast enhancement effect is visible in the video preview if this option is off but not if it is on. This property is not supported by SAFR Inside.
input.stream.id N/A Identifier used to connect to a stream if input.stream.url is blank. This property is not supported by SAFR Inside.
input.type "stream" The type of feed input; either "stream" or "file".
recognizer.detect-mask-model "precise" Specifies the model to be used for mask detection. There are 3 possible values:
Precise: This model produces the least number of false positives (i.e. detecting that a person is wearing a mask but there is no mask), but it suffers from the lowest true positive rate. (i.e. detecting masks that are actually there)
Sensitive: This model produces the highest true positive rate, but it suffers from the highest number of false positives.
Normal: This model produces a moderate amount of both false positives and true positives.
recognizer.mask-check-detection-edge-threshold 0.03 How far a face must be from the edge of the screen before a mask event detection is attempted. For example, if a face is 100 pixels, and recognizer.mask-check-detection-edge-threshold is set to .03 (i.e. 3%), then the face must be 3 pixels from the edge of the screen before SAFR will attempt a mask event detection. This property is not supported by SAFR Inside.
recognizer.mask-check-enabled FALSE Enables the detection of mask event types. Mask event detection attempts can return 3 potential results: mask=false, mask=indeterminate, or mask=true. After the configured number of consecutive mask event detection results, the mask event state is set to the appropriate value. The mask event state can only progress from false towards true; the state never regresses back towards false. For example, once the mask event state for a viewed person becomes set to mask=true, then that person's mask event state won't ever regress to mask=indeterminate or mask=false.
Events are generated when the mask event state is set to either mask=false or mask=true.
recognizer.mask-check-min-consecutive-mask-detections 1 Specifies the minimum number of consecutive mask=true mask detection results that must occur before SAFR will generate a mask=true event. See the recognizer.mask-check-enabled property for more information.
recognizer.mask-check-min-consecutive-no-mask-detections 2 Specifies the minimum number of consecutive mask=false mask detection results that must occur before SAFR will generate a mask=false event. See the recognizer.mask-check-enabled property for more information.
recognizer.mask-check-min-consecutive-occluded-no-mask-detections 2 Specifies the minimum number of consecutive mask=indeterminate mask detection results that must occur before SAFR will set the mask event state to mask=indeterminate. See the recognizer.mask-check-enabled property for more information.
recognizer.mask-check-min-mask-detection-size 70 The smallest face size, in pixels, upon which SAFR will attempt to detect a mask event.
statistics.enabled FALSE Specifies whether VIRGO should record and report statistics for this feed.

Update Properties

The update properties are not intended for public consumption at this time.

Property Default Value Description
client-type OS-defined client type Internal use only.
version N/A Internal use only.
enabled FALSE Internal use only.
progress-status N/A Internal use only.
progress-url N/A Internal use only.
download-url N/A Internal use only.
log-enabled FALSE Internal use only.
progress-interval 1000 Internal use only.

See Also