Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FACE PSIM

Registry section

String parameterAvailable valuesDefaultProduct versionParameter in effect

x32: (x32)\FRS
x64: (x64)\FRS

CpuCoreCount>0
1.0.0 and later

The key defines on how many CPU cores the face recognition module will operate (firserver.run process). All cores are in use by default.

x32: (x32)\FRS
x64:
(x64)\FRS

CpuCoreCountSearch>=011.0.0 and later

The key determines how many CPU cores will be used for face search:

0—the number of cores specified in the CpuCoreCount key. The cores are used sequentially. Each core is assigned its own recognition instance.

1—only 1 fixed core is used

2—only 2 fixed cores are used

and so on

x32: (x32)\FRS
x64: (x64)\FRS
FaceLostAge>010001.0.0 and later

The key sets the timeout upon which Face Server ‘loses’ the face if there is no new data about it.

x32: (x32)\FRS
x64: (x64)\FRS
GenFirsInDetector0, 111.0.0 and later

Sets the parameters of generating and attaching face biometrics in the detection tool:

1 – Face detection tools generate and attach face biometrics to the photo. 

0 – Face detection tools do not generate face biometrics – the face is only captured.

Note. Face recognition Server that performs search in the user database checks up whether it has attached biometrics when it gets a face photo. If yes, then biometrics are not further generated for search in the database – data attached to the photo is in use. If no, then recognition Server generates biometrics itself using the photo. 

Generation of biometrics is a resource-intensive process unlike search by ready data – that is why this key allows distributing load among several Servers having only one Server working with the user database.
x32: (x32)\Video\FaceCapture
x64: (x64)\Video\ FaceCapture
timeUntilLost>011.0.0 and later

The key is used to configure the face detection tool – it sets time on the expiry of which the face is considered lost.

For instance, if timeUntilLost = 1 and a man covers his face with the hands in front of the camera and then shows it again, then the face detection tool does not capture it as it considers that the face was lost for the time it was covered.

If the parameter value is 3, then the face will be detected in this case.
x32: (x32)\FRS
x64: (x64)\FRS
IgnoreSamePeople0, 101.0.0 and later

The key enables function of ignoring repeatedly recognized faces. While enabling this function all vectors of captured faces are saved in cache for the specified time interval. When new face is captured, its biometric vector is comparing with already existed vectors in cache. If it coincides with one of such vectors with specified similarity rate then it doesn't send to the further processing. Duration of vector storing in a cache is specified using the Skip repeated recognitions, sec parameter of the Face Recognition Server object. Similarity rate for comparison is came from the Similarity level parameter of the same object. See also Face PSIM software package. Administrator's Guide, section Configuring the captured faces recognition parameters.

x32: (x32)\FRS
x64: (x64)\FRS
ClearIgnoreCache0, 101.0.0 and laterThe key enables cache clearing while using function of ignoring repeatedly recognized faces.
x32: (x32)\FRS
x64: (x64)\FRS
ClearIgnoreCacheTimeTime in HH:MM:SS formatNA1.0.0 and laterThe key sets time when cache clearing is to be performed while using function of ignoring repeatedly recognized faces.
x32: (x32)\FRS
x64: (x64)\FRS
FaceDetectionPeriod>02501.0.0 and laterSpecifies time period in milliseconds equal to frequency of new faces search on the image for the VA recognition algorithm. See also Face PSIM software package. Administrator's Guide.
x32: (x32)\FRS
x64: (x64)\FRS
FaceDBFull path to a local or network folderNA1.0.0 and laterThe key sets a folder for storage of images and vectors for captured and reference faces when UseFaceDB key is set to 1 or 2 (see below).
x32: (x32)\FRS
x64: (x64)\FRS
UseFaceDB0, 1, 221.0.0 and later

The key sets the storage mode for metadata, images and vectors of captured and reference faces.

0 – metadata, images and vectors are stored only in the database.

1 – metadata, images and vectors are stored in the database, and images and vectors are also stored in a folder on disk. The path to the folder is set by the FaceDB parameter (you can specify both local and network folders).

2 – metadata is stored in the database, and images and vectors are stored only in a folder on disk. The path to the folder is set by the FaceDB parameter (you can specify both local and network folders).

Note 1. Metadata is stored in the database in the Hits table, regardless of the value of the UseFaceDB key. 

Note 2. Images of reference faces are stored in the <Axxon PSIM software installation directory>\Bmp\Person folder, regardless of the UseFaceDB key value.

Note 3. Only the UseFaceDB = 2 mode is supported, which is set automatically when Face Axxon PSIM starts if a mode other than this is detected.

x32: (x32)\FRS
x64: (x64)\FRS
FaceDBFreeMB>010001.0.0 and later

The key is used if the the UseFaceDB parameter value is 1 or 2 (see above). The key sets the size of free disk space in megabytes. Once the specified size is reached, the old images, vectors and metadata of captured faces will be deleted. The cleanup is performed on a loop in portions equivalent to 1000 megabytes.

x32: (x32)\FRS
x64: (x64)\FRS
RestPortport number100001.0.0 and laterThe key is used in case the standard port 10000 used by the Face Recognition Server to communicate with the Face Recognition and Search client is occupied by a third-party application that can not be disabled. The key allows you to specify a new port number for communication between the server and the client.
x32: (x32)\FRS
x64: (x64)\FRS
CpuCoreCountAddPerson
>=001.0.0 and later

The key defines the number of CPU cores where the vectors of persons are generated when adding a reference face to the database.

0 – vectors are generated on the number of cores specified in the CpuCoreCount key. The cores are used successively. Recognition sample is bound to each core.

1 – only 1 fixed core (different from those specified in CpuCoreCount) is in use when adding a reference face to the database.

2 – only 2 fixed cores (different from those specified in CpuCoreCount) are in use when adding a reference face to the database.

etc.
x32: (x32)\FRS
x64: (x64)\FRS
Face.HardwareCPU
0, 1, 2NA1.0.0 and later

The key defines the order of binding streams to CPU cores when generating vectors of persons.

no value or 0 – streams are bound randomly to CPU cores.
1 – streams are bound successively to CPU cores depending on their total number.
2 – streams are bound to first cores of each CPU.

x32: (x32)\FRS
x64: (x64)\FRS
Face.RecognizeFacesSeparately0, 101.0.0 and later

Mechanism of displaying faces. When a new mechanism of displaying is enabled, the photo in the list of captured faces is not duplicated – it is updated in the same cell while the tracker "sees" it.  

0 – new mechanism of displaying faces. 

1 – old mechanism of displaying faces. 

x32: (x32)\FRS
x64: (x64)\FRS
FaceDetector.SaveLastFaceCaptureFrame0, 101.0.0 and later

The key enables saving the last recognized face and all its necessary data to a file. This image file can be sent directly to the recognition server via the iidk_client utility.

0 – General operation mode.

1 – When the face is captured, the captureFrame (cam_N) .log file is created (where N is the camera number that captured the face) in the <Axxon PSIM Installer directory>\Modules64\Firserver folder\. This file will contain the last recognized face and all its necessary data. This image file can be sent directly to the recognition server via the iidk_client utility.

Note. The file is overwritten every time a new face is captured.

x32: (x32)\FRS
x64: (x64)\FRS
XSize>=019201.0.0 and later

The key restricts resolution (width) of the photo when adding it to the faces database.

Set greater value to the key if the following message appears when adding a face to DB: "Adding error. The face was not added. Insufficient image quality to add".

x32: (x32)\FRS
x64: (x64)\FRS
YSize>=010801.0.0 and later

The key restricts resolution (height) of the photo when adding it to the faces database.

Set greater value to the key if the following message appears when adding a face to DB: "Adding error. The face was not added. Insufficient image quality to add".
VA and VideoIntellect 1.1




x32: (x32)\FRS
x64: (x64)\FRS
VaAlgorithmNumber0, 101.0.0 and later

The key enables selecting the face recognition and search algorithm.

0 – less resource intensive algorithm is in use

1 – more resource intensive algorithm is in use 

Important! Biometric vectors received using this algorithm cannot be used with alternative one. For proper operation of Face PSIM after changing this parameter biometric vectors are to be converted as described in Switching between the face recognition modules section. 

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectionFilterAlgorithm0, 101.0.0 and later

An alternative algorithm for filtering false triggerings of the tracker. This key is in use if Va.GlobalTrackingDetectionFilter=0 and Va.DetectionFilterValue > 0 (see the corresponding parameters below). 

0 – ALG1

1 – ALG2

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectionFilterValue0-100501.0.0 and later

Configuring alternative algorithm filtering. It is in use if the value of Va.GlobalTrackingDetectionFilter is more than 0 (see the corresponding parameter below).

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.GlobalTrackingDetectionFilter0, 111.0.0 and later

Activates an additional check to filter out false triggerings of the tracker. If faces in masks are not recognized, it is recommended to disable this check, however, this can cause false triggerings of the tracker.

0 – disabled

1 – enabled

Note. It is not recommended to change this parameter without first consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.DetectorAlgorithm0, 101.0.0 and later

Face detection operation mode (identification). The recommended parameter value is 0.

0 – ALG1

1 – ALG2

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.FaceDetectionPeriod>=03501.0.0 and later

This parameter affects the detector captioning capacity. If there is a great value, the tracks can rend.

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.FaceDetectorConfidenceThreshold>=0501.0.0 and later

Face detector confidence threshold (do not confuse with face quality).

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.IdentificationAlgorithm0, 1, 201.0.0 and later

The key enables selecting the algorithm for recognition and face search.

0 – ALG1 less resource-intensive algorithm is in use.

1 – ALG2 identification of the higher quality, but more resource-intensive.

2 – PRECISE the highest quality of recognition, but the most resource-intensive. This algorithm is recommended if significantly less time is spent on face recognition than on detection (if there are few people in the frame).

Important! Since the biometric vectors received by one algorithm cannot be used by another, then after changing the algorithm, the biometric vectors are automatically recreated. The biometric vectors can also be recreated manually (see Switching between the face recognition modules or SDK versions).

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.TrackBestFramesCount>=011.0.0 and later

Specifies the number of seconds to accumulate the best frames of a track for recognition. The increase in time makes it possible to average out the recognized face characteristics, but it can result in the poorer accuracy of the face characteristics recognition.

Note. For example, if the 1 second value is set, the average error in determining the age will be 2-3 years, and if the 5 seconds value is set, it will be 3-4 years.

x32:(x32)\FRS\CustomAlgoritm
x64:(x64)\FRS\CustomAlgoritm
Va.TrackerMaxLostTime>=05001.0.0 and later

Time since the last recognition after which the track is considered ended.

Note. It is not recommended to change this parameter without consulting with AxxonSoft technical support.

x32: (x32)\FRS\CustomAlgoritm
x64: (x64)\FRS\CustomAlgoritm
Va.EyesClosedDetectorThreshold>=0501.0.0 and later

Sets the sensitivity of the closed eyes recognition. The higher the value, the less sensitive the closed eyes detector.

x32: (x32)\FRS\CustomAlgoritm
x64: (x64)\FRS\CustomAlgoritm
Va.IgnoreBestFrames0,101.0.0 and later

Specifies which frames will be recognized.

0—only the best frame defined by VA will be recognized.

1—all frames will be recognized, as a result the quality of recognition increases, but the CPU load increases, too

х32x32: (х32x32)\FRS\CustomAlgoritm
x64:
(х64x64)\FRS\CustomAlgoritm
Va.LivenessDetectionAlgorithm0, 1, 221.0.0 and later

The key defines the operating mode for the frame-based artificial face detection algorithm:

0—the algorithm is disabled

1—standard operation mode of the algorithm

2—slower but more accurate operation mode of the algorithm

This key can be used together with the Va.LivenessTextureDetectionAlgorithm key for better results

х32x32: (х32x32)\FRS\CustomAlgoritm
x64:
(х64x64)\FRS\CustomAlgoritm
Va.LivenessTextureDetectionAlgorithm0, 1, 2, 301.0.0 and later

The key defines the operating mode for the texture-based artificial face detection algorithm. The following conditions are required for proper operation: high-quality video image, a large face size, and a region of interest (ROI) focused on the center of the frame.

0—the algorithm is disabled

1—standard operation mode of the algorithm

2—slower but more accurate operation mode of the algorithm

3—enables combined operation with the frame-based artificial face detection algorithm (the registry key Va.LivenessDetectionAlgorithm value must be set to 1 or 2)

x32: (x32)\FRS
x64: (x64)\FRS
GenerateEyesClosedEvent0, 101.0.0 and later

Activates the Eyes closed event generation when closed eyes are detected.

x32: (x32)\FRS
x64: (x64)\FRS
FaceTracker.LogTrackerQuality0, 101.0.0 and laterThe key enables logging of every face capture event in the general log file of the Face Recognition Server debugging window, where additional information is displayed, such as: the quality of the captured face, the number of all captured faces, the number of high-quality faces, etc. (for details, see Debug window).
x32: (x32)\FRS
x64: (x64)\FRS
IsProcessObject
0, 111.0.0 and later

Enables the launch of each Face Recognition Server in a separate process.

0 – all Face Recognition Servers launch in the same process.

1 – each Face Recognition Server is launched in a separate process.

x32: (x32)\FRS
x64: (x64)\FRS
ThreadAffinity.Ignore0, 101.0.0 and later

Enables ignoring threads affinity to kernels inside firserver.run.

0 – ignoring threads affinity to kernels is disabled.

1 – ignoring threads affinity to kernels is enabled. The key is used in conjunction with the IsProcessObject=0 key.

x32: (x32)\FRS
x64: (x64)\FRS
ResizeWidth
>=001.0.0 and later

Sets the video resolution that is sent from cameras to all Face Detection modules.

Actually, the width of the video image is set, and the height is adjusted automatically based on the aspect ratio of the original video. For example, if the original video has a resolution of 2560x1920, then if you set the value to 960, then the video will be converted to a resolution of 960x720.

If the value is set to 0, then the video image will be received in its original resolution.

x32: (x32)\FRS
x64:
(x64)\FRS
NeedUpdatePerson0, 111.0.0 and later

Enables compliance check of Face PSIM users with Axxon PSIM users:

0—compliance check is disabled, user changes are not checked

1—compliance check is enabled. All user changes made in the Axxon PSIM database, but missing in the Face PSIM database, are transferred there. User parameters that are present in the Face PSIM database, but missing in the Axxon PSIM database, are deleted

x32: (x32)\FRS\Thermal
x64: (x64)\FRS\Thermal
SaveThermalJson
0, 101.0.0 and later

Enables saving all json and images received from the thermal camera during face recognition to the folder. The data from the camera will be saved at the following address:

  • In case of face recognition: <Axxon PSIM installation directory>\Modules64\Firserver\ThermalImages\{Face detection tool ID}
  • In case the face is not recognized: <Axxon PSIM installation directory>\Modules64\Firserver\ThermalImages\{Face detection tool ID}\NoFaces

0 – data from the thermal camera is not saved to the folders

1 – data from the thermal camera is saved to the folders

x32: (x32)\FRS\Thermal
x64: (x64)\FRS\Thermal
ForceProcessWholeImage
0, 101.0.0 and later

The key is used in case the Combined work with thermal camera and Get photo from thermal camera checkboxes are set on the settings panel of the Face Recognition Server object.

Enables the face search throughout the entire frame if a face was not previously recognized due to incorrect coordinates of the face frame received from the thermal camera.

Details on this mode:

  • The number of recognitions and the system load will increase.
  • The negative face images will be displayed in the Face recognition and search interface module.
  • The same temperature will be indicated for all recognized faces in the frame.

0 – Unrecognized faces are ignored.

1 – Enables the face search throughout the entire frame if a face was not previously recognized.

x32: (x32)\FRS\Update
x64: (x64)\FRS\Update
Update.CpuCoreCount
>=111.0.0 and later

Sets the number of threads on which the biometric vectors are re-generated when switching between different face recognition modules or SDK versions.

...

POS PSIM

Registry section

String parameter

Available values

Default

Product version

Parameter in effect

x32: (x32)\POS
x64: (x64)\POS

Capture

0, 1

1

1.0.0 and later

Defines whether to store log-files or not. 
Log-files are stored in the <Axxon PSIM Folder>\Modules\PosCapture folder.

x32: (x32)\POS
x64: (x64)\POS

Dos2Win

0, 1

1

1.0.0 and later

Detects encoding:
1 – read XML encoding in DOS codepage;
0 – read  XML as it is

x32: (x32)\POS
x64: (x64)\POS

GlobalTextDelay

NA

0

1.0.0 and later

Sets the shift of Text data from video to TextSearch.

x32: (x32)\POS
x64: (x64)\POS

Nohotkey

0, 1

1

1.0.0 and later

Allows disabling hot keys used for POSVIEWER and TITLEVIEWER. If Nohotkey = 1, then when clicking
Ctrl+Shift+E – the frame export folder is opened;
Ctrl+Shift+T – the Tools folder is opened.

x32:(x32)\POS
x64:(x64)\POS
DecodeUtf80, 101.0.0 and later

The key enables the UTF-8 encoding to ensure the correct display of captions in cases when the incoming to the POS terminal packages have the UTF-8 encoding.

x32: (x32)\POS
x64: (x64)\POS

PosLogMaxsize

>0

10

1.0.0 and later

The key sets maximum size (in MBs) of the POS terminal’s log.

Note. POS terminal logging is enabled using the Capture key – see above.

x32: (x32)\POS
x64: (x64)\POS
SetFlowControlNone0, 111.0.0 and laterCOM port control. Set to 0 if POS terminal fails to operate while connecting to POS PSIM.
x32: (x32)\POS
 x64: (x64)\POS
UseLocalTimestamp0, 101.0.0 and later

The key enables the received local timestamp conversion to UTC when creating a record in the corresponding POS PSIM database.

0 – received local timestamp will be recorded to the corresponding database without any changes.

1 – received local timestamp will be converted to UTC when creating a record in the corresponding database.

x32: (x32)\POS
 x64: (x64)\POS
UseLastCashierInfo0, 101.0.0 and later

In case the D-store POS-terminals are used, the key enables saving the info about the last cashier whose data was received by the POS-terminal. Until there is no data, the following default values are used: cashier_name = "Jane B."; cashier_number = "1147911";

0 – the info about the last cashier whose data was received by the POS-terminal, is not saved.

1 – the info about the last cashier whose data was received by the POS-terminal, is saved.

x32: (x32)\POS
 x64: (x64)\POS
NewReceipt.Use0, 101.0.0 and later

In case the D-store POS-terminals are used, the key enables initiating the receipt creation by any data input. In addition to that, the text line specified in the NewReceipt.Word key (see below) is added to the receipt text.

0 – the receipt creation is initiated by the word specified to trigger the receipt creation.

1 – the receipt creation is initiated by any data input, and the text line specified in the NewReceipt.Word key (see below) is added to the receipt text.

Note. This key works only if the UseLastCashierInfo key (see above) is enabled.

x32: (x32)\POS
 x64: (x64)\POS
NewReceipt.Word
String valueNEW RECEIPT1.0.0 and laterThe key enables specifying the text line which will be added to the receipt text if the NewReceipt.Use key (see above) is enabled.
x32: (x32)\POS
 x64: (x64)\POS
PrintTime0, 101.0.0 and later

The key activates displaying in the Monitor the time (UTC) when each caption appeared.

0 – the captions timestamps (UTC) are not displayed in the Monitor.

1 – the captions timestamps (UTC) are displayed in the Monitor.

...

IP integration (drivers and codecs pack for Axxon PSIM)

Registry section

String parameter

Available values

Default

Product version

Parameter in effect

x32: (X32x32)\Video
x64: (x64)\Video

ArchiveFps

1-24


1.0.0 and later

Sets the number of frames recorded to the archive (max.resolution). LiveFps and ArchiveFps parameters are not to exceed 24 in total.

x32: (X32x32)\Video
x64: (x64)\Video

DoubleStream

0, 1


1.0.0 and later

Defines whether asynchronous video display mode is enabled or not.

x32: (X32x32)\Video
x64: (x64)\Video

IpIntDrivers3

Brand name: Axis; Acti, etc.


1.0.0 and later

The IpIntDrivers3 string parameter is created and the names of brands that need 3.0 driver are listed.

x32: (X32x32)\Video
x64: (x64)\Video

IpIntDriverVersion

2, 3


1.0.0 and later

Defines the version number of loaded drivers:
2 – to load drivers version 2.0;
3 – to load drivers version 3.0;
This parameter has a high priority and cancels IpIntDrivers3 parameter.

x32: (x32)\Video
x64: (x64)\Video

LiveFps

1-24


1.0.0 and later

Sets the number of frames displayed in the 800x600 format. LiveFps and ArchiveFps parameters are not to exceed 24 in total.

x32: (x32)
x64: (x64)

LoadIpIntDirectly

0, 1

 

1.0.0 and later 

1 – enable IntegratedDevice via video.run. If the setting is enabled and at least one IntegratedDevice is added, then other IP video capture cards are disabled.

0 – IIntegratedDevice operates as a separate run-module.

x32: (x32)\Video\TransportProtocols
x64: (x64)\Video\TransportProtocols
<Driver name><protocol>NADP 1.0.0 and later

The key is used to change a transport protocol used by the IP device.

Example of the key value: "ONVIF"="tcp" means that TCP protocol is used to transfer data via ONVIF.

See details in Changing the transport protocol used by IP-device

Example of the key value: "rtsp"="multicast" allows enabling Multicast mode of the RTSP Server. The object configuration is required in addition to the key.

See details in Configuring RTSP Server module.

x32: (x32)\Video\MetadataTransportProtocols
x64: (x64)\Video\MetadataTransportProtocols

The name of camera driver (in the driver parameter of the

C:\Program Files\ Common Files\ AxxonSoft\ Ipint.DriverPack \3.0.0\ Ipint.<Driver name>.rep file)
The name of transport protocol (is to be the same as one of the values specified in metadataTransportProtocol property in the corresponding .rep file).NADP 1.0.0 and laterThe key is used to change a metadata transport protocol. At the time of writing this documentation change of a metadata transport protocol was available for ONVIF driver only (possible values are tcp and udp).
x32: (x32)\Video
x64: (x64)\Video
UnloadUnusedDriverTimeout>=060DP 1.0.0 and later

The key sets unused driver unload timeout for cameras. For instance, if camera brand is in several drivers, all of them are loaded at camera connection. To unload the unused drivers, set non-zero value to this key.

If the key is not created, then unused drivers are unloaded in 60 seconds.

0 – drivers do not unload (such behavior was in DriverPack versions older than the current one).

The key value that is > 0 sets unused driver unload timeout.

If the key is created but it consists of NaN value, then unused driver unload timeout is set to the default value – 60 seconds.

x32: (x32)\TELEMETRY
x64: (x64)\TELEMETRY

PresetCompatibility0, 1NADP 1.0.0 and later

The key is used to enable the compatibility between presets in Axxon PSIM and previous versions of Drivers Pack, i.e. to decreasing the preset number by 1 when sending it to the driver.

0 – a new operation mechanism with presets the same as in Axxon One is in use in Axxon PSIM. If preset 1 is selected in Axxon PSIM interface, then value 1 is sent to the driver.

1, or if the key is not created – the compatibility mode is in use: if preset 1 is selected/created in Axxon PSIM interface, then value 0 is sent to the driver.

x32: (x32)\Video
x64: (x64)\Video

FFTHREADCOUNT>=01DP 1.0.0 and later

The key sets the number of streams created in FFmpegDecoder.

0 – decoder automatically selects the number of created streams.

>0 – sets the number of streams in use.

By default if there is no key or the value is incorrect, then value 1 is in use.

Auto selection of the number of streams can result in the system load reduction or its increase as the number of streams recreated during decoding increases – this affects the performance.

x32: (x32)\EventSources
x64: (x64)\EventSources

<brand>.<model> (for example, ONVIF.1_channel_device).

If all models of some manufacturer require a specific method of getting events, then there must be a string key named <brand> in the section.

Pull point

Meta data

Disable

Meta dataDP 1.0.0 and later

By the date the documentation in created, this key is supported for three brands: ONVIF, RVi and IDIS. For models of these brands, the key is created automatically when the Drivers Pack is installed.

The key sets a method of getting data about the analytics and the sensors of the device:

  • Pull point – getting events by http request of the camera
  • Meta data – getting events from the metadata stream
  • Disable – getting events is disabled.
All other values (including an empty string) or if there is no key for the model and brand in the specified section mean that you must use the default method, created as default in the rep file for the given model.
x32: (x32)\Video\UseSsrcChecking
x64: (x64)\Video\UseSsrcChecking
RTSP

enable

disable

enableDP 1.0.0 and later

The key is intended for setting up synchronization source (SSRC) for RTSP stream:

enable – SSRC check enabled;

disable – SSRC check disabled.

x32: (x32)\Video
x64: (x64)\Video

FFLOGDELAY0, 10CP 1.580Enables logging of delays of frames decoding and idle time for FFMPEG codec.
x32: (x32)\Video\TsConverters
x64: (x64)\Video\TsConverters

<brand>.<model>, for example, Tattile.ANPR Mobile

If all brand's models require a certain method of the timestamp adjustment, then the section must contain a string key with the name <brand>.

  • InfrequentTs
  • ValidDeviceTs
  • None
Depends on the brand

DP 1.0.0

and later

The keys in this section specify the method of the frame timestamp adjustment.

If the key is not created, the timestamp transferred to the Axxon PSIM equals 0, and then the current time is set as its value.

The None value is used if it is necessary to disable the adjustment and transfer the timestamp received from the camera as is.

The ValidDeviceTs value means that the timestamp adjustment method is used before the timestamps transmission to the Axxon PSIM if the timestamp received from the camera differs from the current time by the value greater than the one specified in the MaxTimestampDeviation key (see below). After the adjustment, the timestamp calculated on the basis of the previous frame's timestamp and the time elapsed since its reception is transmitted to the Axxon PSIM.

InfrequentTs value discards the relative timestamps, transferring 0 to the Axxon PSIM instead (i.e., the current time is set as the timestamp value), and it also transfers the absolute timestamps with the ETimestampValidityFlag flag. This adjustment method should be used for the devices with the license plates recognition which transfer the separate frames to the external system, rather than a continuous video stream.

For some manufacturers, when installing the Drivers Pack, the keys with the necessary values are automatically created in the appropriate registry key.

x32: (x32)\Video
x64: (x64)\Video
MaxTimestampDeviation>=0NADP 1.0.0 and later

The key is used for the ValidDeviceTs key value from the TsConverters branch (see above).

The key sets the maximum permissible deviation of the frame timestamp from the current Server time.

x32: (x32)\Video
x64: (x64)\Video
ErrorSensitivity0, 10DP 1.0.0 and later

The key enables the interruption of the H.265 video decoding via the ffmpeg decoder in case of the slightest error in the video stream.

0 – if the video stream contains errors, then a buffer with artifacts will be received from the ffmpeg decoder.

1 – if the video stream contains errors, then an empty buffer will be received from the ffmpeg decoder.

x32: (x32)\Video\RTSP
x64: (x64)\Video\RTSP
AudioSeparatedConnection0, 10DP 1.0.0 and laterEnables RTSP audio over a separate TCP connection.
x32: (x32)\Video
x64: (x64)\Video
servicesVersionauto, ver1, ver2autoDP 1.0.0 and later

The key sets the version of ONVIF services (only for ONVIF and ONVIF 2.X):

auto – get available versions and choose the latest if possible.

ver1 – use old versions of services.

ver2 – use new versions of services.

x32: (x32)\Video
x64: (x64)\Video
servicesSourcegetServices, getCapabilitiesgetServicesDP 1.0.0 and later

The key determines the source of the ONVIF services version (only for ONVIF and ONVIF 2.X):

getServices – get a list of services using the new interface.

getCapabilities – get a list of services using the old interface.

x32: (x32)\Video\Virtual
x64: (x64)\Video\Virtual
​playFileOnce0, 10DP 1.0.0 and later

Disables looping files in a virtual video capture device of a Virtual bench type.

0 – videos in a Virtual bench virtual capture device are played in a loop.

1 – videos in a Virtual bench virtual capture device are played once.

See also Creating and configuring a virtual Video Capture Device.

x32: (X32x32)\TELEMETRY
x64: (x64)\TELEMETRY
cgiPrefix

"/cgi-bin/ptz.cgi?", "/stw-cgi/ptzcontrol.cgi?"

-DP 1.0.0 and later

The key is required for PTZ operation with Hanwha Techwin IP-devices:

"/cgi-bin/ptz.cgi?" – for old models (not X-series)

"/stw-cgi/ptzcontrol.cgi?" –  for new models X-series

x32: (x32)\Video
x64: 
(x64)\Video

DecompressorResetOnErrorTimeout0 – 18060

DP 1.0.0 and later

Compatibility: Axxon PSIM 1.0.0 and later

Time in seconds before the decompressor resets after an error. The value for the key should be selected empirically based on the stream parameters of a particular video camera.

Attention! It is recommended to change the value for the key only with the assistance of technical support.

x32: (x32)\Video
x64: (x64)\Video
IQS_ADDITIONTAL_VIDEO_FRAMES_COUNT>=11DP 1.0.0 and later

The key sets the number of buffered decoded frames for the IntelQuickSync decoder.

...

DetectorPack PSIM

Registry section

String parameterAvailable valuesDefaultProduct versionDescription

x32: (x32)\DetectorExt

x64: (x64)\DetectorExt

MaxRestartsCount>=111.0.0 and later

The key specifies the number of attempts to restart the detection tool in case of an internal error

x32: (x32)\DetectorExt

x64: (x64)\DetectorExt

 

Recumbent.SkipSitPeople0, 1NA1.0.0 and later

The key excludes repeated triggering of the Pose detection tool when there is a recumbent person in the frame:

0—repeated triggering of the detection tool isn't excluded

1—repeated triggering of the detection tool is excluded

The registry key is created manually.

If Recumbent.SkipSitPeople=1, and the values of other keys (Recumbent.SkipSitPeopleTimeOffset and Recumbent.SkipSitPeopleAreaOffset) aren't specified or only one is specified, then the default values are used for the missing keys. To specify the values different from default values, you must manually specify the Recumbent.SkipSitPeopleTimeOffset and Recumbent.SkipSitPeopleAreaOffset registry keys

x32: (x32)\DetectorExt

x64: (x64)\DetectorExt

 

Recumbent.SkipSitPeopleTimeOffset>06001.0.0 and later

You must manually create the registry key with the value Recumbent.SkipSitPeople=1, otherwise the Recumbent.SkipSitPeopleTimeOffset registry key doesn't work. 

The key specifies the time period in seconds during which repeated triggering of the Pose detection tool when there is a recumbent person in the frame is excluded.

If Recumbent.SkipSitPeople=1, and the values of other keys (Recumbent.SkipSitPeopleTimeOffset and Recumbent.SkipSitPeopleAreaOffset) aren't specified or only one is specified, then the default values are used for the missing keys. To specify other value, you must create the Recumbent.SkipSitPeopleTimeOffset registry key manually

x32: (x32)\DetectorExt

x64: (x64)\DetectorExt

 

Recumbent.SkipSitPeopleAreaOffset>0501.0.0 and later

You must manually create the registry key with the value Recumbent.SkipSitPeople=1, otherwise the Recumbent.SkipSitPeopleAreaOffset registry key doesn't work. 

The key specifies the percentage of increase in the original size of the alarm border, in which repeated triggering of the Pose detection tool when there is a recumbent person in the frame is excluded.

If Recumbent.SkipSitPeople=1, and the values of other keys (Recumbent.SkipSitPeopleTimeOffset and Recumbent.SkipSitPeopleAreaOffset) aren't specified or only one is specified, then the default values are used for the missing keys. To specify other value, you must create the Recumbent.SkipSitPeopleAreaOffset registry key manually

x32: (x32)\DetectorExt\BARCODE_DETECTOR

x64: (x64)\DetectorExt\BARCODE_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Barcode Detection: External Detector - BARCODE_DETECTOR.1

x32: (x32)\DetectorExt\BASE_POSE_DETECTOR

x64: (x64)\DetectorExt\BASE_POSE_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Pose Detection: External Detector - BASE_POSE_DETECTOR.1

x32: (x32)\DetectorExt\CONVEYOR_BELT_DETECTOR

x64: (x64)\DetectorExt\CONVEYOR_BELT_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Conveyor Belt Detection: External Detector - CONVEYOR_BELT_DETECTOR.1

x32: (x32)\DetectorExt\CROWD_COUNTER

x64: (x64)\DetectorExt\CROWD_COUNTER

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Detection of moving against crowd flow: External Detector - CROWD_COUNTER.1

x32: (x32)\DetectorExt\CROWD_COUNTER_TVN

x64: (x64)\DetectorExt\CROWD_COUNTER_TVN

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Crowd detection (TVN): External Detector - CROWD_COUNTER_TVN.1

x32: (x32)\DetectorExt\EQUIPMENT_DETECTOR

x64: (x64)\DetectorExt\EQUIPMENT_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Equipment detection (PPE): External Detector - EQUIPMENT_DETECTOR.1

x32: (x32)\DetectorExt\FIRE_DETECTOR

x64: (x64)\DetectorExt\FIRE_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Fire detection: External Detector - FIRE_DETECTOR.1

x32: (x32)\DetectorExt\FLUID_DETECTOR

x64: (x64)\DetectorExt\FLUID_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Fluid level detection: External Detector - FLUID_DETECTOR.1

x32: (x32)\DetectorExt\GLOW_DETECTOR

x64: (x64)\DetectorExt\GLOW_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Detection of light indication control: External Detector - GLOW_DETECTOR.1

x32: (x32)\DetectorExt\HEAT_ZONE_DETECTOR

x64: (x64)\DetectorExt\HEAT_ZONE_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Heat map detection: External Detector - HEAT_ZONE_DETECTOR.1

x32: (x32)\DetectorExt\HEAT_ZONE_DETECTOR

x64: (x64)\DetectorExt\HEAT_ZONE_DETECTOR

ReportFrequency >09001.0.0 and later

Sets the data collection frequency (sec) for heat map detection tool

x32: (x32)\DetectorExt\HEAT_ZONE_DETECTOR

x64: (x64)\DetectorExt\HEAT_ZONE_DETECTOR

DebugReportFrequency >0101.0.0 and later

Sets the data update frequency (sec) from heat map detection tool in the Debug window in seconds

x32: (x32)\DetectorExt\NEURO_COUNTER

x64: (x64)\DetectorExt\NEURO_COUNTER

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Neurocounter: External Detector - NEURO_COUNTER.1

x32: (x32)\DetectorExt\NEURO_TRACKER

x64: (x64)\DetectorExt\NEURO_TRACKER

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Neurotracker: External Detector - NEURO_TRACKER.1

x32: (x32)\DetectorExt\NEURO_TRACKER\NEURO TRACKER_id

x64: (x64)\DetectorExt\NEURO_TRACKER\NEURO TRACKER_id

 

windowH
windowStepH
windowW
windowStepW
nonnegative integerabsent1.0.0 and later

Sets the custom size of the scanning windows. 

  1. In the registry, create a new section NEURO_TRACKER_id, where id is the id of the neurotracker, which window sizes you want to change.
  2. In this section, create four registry keys:
    1. windowH—scanning window height;
    2. windowW—scanning window width;
    3. windowStepH—scanning window step height;
    4. windowStepW—scanning window step width.
  3. Specify the required values for all four keys. Otherwise, the default settings will be used.

Example of custom settings for a 1920×1080 frame divided into four equal scanning windows:
windowH=540
windowStepH=540
windowW=960
windowStepW=960

x32: (x32)\DetectorExt\OCCUPANCY_COUNTER

x64: (x64)\DetectorExt\OCCUPANCY_COUNTER

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Queue length detection: External Detector - OCCUPANCY_COUNTER.1

x32: (x32)\DetectorExt\NEURO_COUNTER\NEURO COUNTER_id

x64: (x64)\DetectorExt\NEURO_COUNTER\NEURO COUNTER_id

 

windowH
windowStepH
windowW
windowStepW
nonnegative integerabsent1.0.0 and later

Sets the custom size of the scanning windows. 

  1. In the registry, create a new section NEURO COUNTER_id, where id is the id of the neurocounter, which window sizes you want to change.
  2. In this section, create four registry keys:
    1. windowH—scanning window height;
    2. windowW—scanning window width;
    3. windowStepH—scanning window step height;
    4. windowStepW—scanning window step width.
  3. Specify the required values for all four keys. Otherwise, the default settings will be used.

Example of custom settings for a 1920×1080 frame divided into four equal scanning windows:
windowH=540
windowStepH=540
windowW=960
windowStepW=960

x32: (x32)\DetectorExt\PEOPLE_COUNTER

x64: (x64)\DetectorExt\PEOPLE_COUNTER

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the People counter detection: External Detector - PEOPLE_COUNTER.1

x32: (x32)\DetectorExt\SMOKE_DETECTOR

x64: (x64)\DetectorExt\SMOKE_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Smoke detection: External Detector - SMOKE_DETECTOR.1

x32: (x32)\DetectorExt\STOPPED_CAR_DETECTOR

x64: (x64)\DetectorExt\STOPPED_CAR_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Stopped vehicle detection: External Detector - STOPPED_CAR_DETECTOR.1

x32: (x32)\DetectorExt\SWEETHEARTING_DETECTOR

x64: (x64)\DetectorExt\SWEETHEARTING_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Sweethearting at checkout detection: External Detector - SWEETHEARTING_DETECTOR.1

x32: (x32)\DetectorExt\TRAFFIC_LIGHTS

x64: (x64)\DetectorExt\TRAFFIC_LIGHTS

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Traffic lights detection: External Detector - TRAFFIC_LIGHTS.1

x32: (x32)\DetectorExt\TRAIN_DETECTOR

x64: (x64)\DetectorExt\TRAIN_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. Example of a separate process for the Train detection: External Detector - TRAIN_DETECTOR.1

x32: (x32)\DetectorExt\VIDEO_INTELLECT_INTERNAL_DETECTOR

x64: (x64)\DetectorExt\VIDEO_INTELLECT_INTERNAL_DETECTOR

 

IsProcessObject0, 101.0.0 and later

Activates the start of the VideoIntellect detection tool in a separate process:

0—detection tool is started in one common External Detector process, all messages and reactions from this detection tool go to the common process

1detection tool is started in a separate External Detector - Detector type.Detector Id process, all messages and reactions from this detection tool go to the separate process. If there are sub-tools, their messages go to the parent process. 

Examples of separate processes for the VideoIntellect detection tools:

VideoIntellect embedded detector: External Detector - VIDEO_INTELLECT_INTERNAL_DETECTOR.1
VideoIntellect detection of movement in prohibited area: External Detector - VI_FORBIDDEN_DETECTOR.1
VideoIntellect detection of prohibited direction: External Detector - VI_DIRECTION_DETECTOR.1
VideoIntellect detection of crowd: External Detector - VI_CROWD_DETECTOR.1
VideoIntellect abandoned objects detection: External Detector - VI_ABANDONED_DETECTOR.1
VideoIntellect detection of camera state: External Detector - VI_FAULTER_DETECTOR.1
VideoIntellect abandoned objects street detection: External Detector - VI_ABANDONED_STREET_DETECTOR.1

x32:  (X32x32)\Video\
x64: (x64)\Video\
report_frequency>=030001.0.0 and laterSets the time period in milliseconds, during which the repeated triggering of the Sweethearting detection module is ignored
x32: (X32x32)\
x64: (x64)\
ShowVideoIntellectObjects ><=0NA1.0.0 and later

Hides the VideoIntellect detector objects from the Axxon PSIM objects tree.

0the VideoIntellect detector objects are hidden

><0VideoIntellect detector objects are displayed

x32: (X32x32)\Video
x64: (x64)\Video
LongInZoneTimeout2>=0NA1.0.0 and later

The key sets the time in seconds which defines the time the object stays in the zone, after which the NeuroTracker VMDA detection tools with the Staying in the area for more than 10 sec detector type, created under the Neurotracker object, are triggered. If this key is not specified, then it is considered equal to the LongInZoneTimeout key value (see Axxon PSIM base version)

...