Versions Compared

Key

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

...

TABLE OF CONTENTS

Video archive files

Registry sectionString parameterAvailable valuesDefaultProduct versionParameter in effect
x32:(x32)\Video\FileSystem
x64:(x64)\Video\FileSystem
FileReader.MMF0, 101.0.0 and later

0 – during the playback, the video archive fragments are read into RAM by one frame

1 – during the playback, the video archive fragments are read into the RAM all at once

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.NotifyCoreFrameSkipped0, 111.0.0 and laterThe key enables FRAME_SKIPPED event (see CAM Camera).

0 – the FRAME_SKIPPED event is not generated, core load is reduced

1 – the FRAME_SKIPPED is generated, there is a risk of buffer overflow

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.RecordingStateChangeDelay>30301.0.0 and later

The key sets in seconds the delay period between the state changes of frames skipping. Accordingly, the FRAME_SKIPPED\FRAME_SKIPPED_STOP events won’t be generated more often than the period specified in the key.

See CAM Camera

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.MaxSkippedFramesByPeriod>0501.0.0 and later

The key sets the minimum number of skipped frames for the period (the period is set in the FileSystem.RecordingStateChangeDelay key), during which the FRAME_SKIPPED event will be generated.

See CAM Camera

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.NotifyCoreFileSystemError0, 111.0.0 and later

The key enables the generation of camera events FILE_REC_ERROR and FILE_REC_OK (see CAM Camera).

0 – FILE_REC_ERROR and FILE_REC_OK events are not generated, the load on the core is reduced

1 – FILE_REC_ERROR and FILE_REC_OK events are generated, there is a risk of buffer overflow

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.MinMaxHoursFromNow0, 111.0.0 and later

The key enables the feature of counting down the storage period for the Keep no less than parameter from the last archive record timestamp (see also Configuring video camera archive depth).

0 – the archive storage time is counted from the last archive record time stamp

1 – the archive storage time is counted from the current time

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.SaveUncompressed0, 101.0.0 and later

The key enables or disables compression of the video recorded on the disk.

0 – compressed video is recorded to the disk according to the settings of each camera

1 – uncompressed video is recorded from all cameras to disk, ignoring the compression settings specified for all cameras

Note. This key is required for debugging. It is not recommended to change the value of this key

x32: (x32)\Video\FileSystem
x64: (x64)\Video\FileSystem
FileSystem.DeleteMinutes>=10601.0.0 and later

The key sets in minutes the time segments of the recorded archive that will be deleted when it is necessary to free up space.

The smaller the value, the smaller segment will be deleted in one deletion iteration, but there will be more such iterations. This will speed up the deletion process and will not overflow the buffer

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem


FileSystem.FlushFileBuffers0, 101.0.0 and later

The key specifies the method of clearing the internal data buffer of the OS file system record:

1forced resetting of the internal buffers of the OS file system record (actual prohibition of record caching)

0automatic (at the discretion of the system) resetting of the internal buffers of the OS file system record

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem

FileSystem.MemFile-1, 0, 1-11.0.0 and later

The key specifies the way the archive is recorded to the disk or network storage:

0each frame is recorded to the disk at once. This value is not recommended to use for network storages

1at first video is fully recorded to RAM (default video size is 1500 frames, it's specified by the Frame count parameter on the Settings panel of the Video subsystem section of the Tweaki.exe utility, or by the MaxFrames key), temporary files are not created. When the recording ends, it is recorded to the disk by parts, the size of which is set by the FileSystem.WriteBufferSize parameter (4 MB by default). Memory consumption highly increases in this case

-1at first video is recorded to the temporary file in RAM. The minimum size of the temporary file is limited by the FileSystem.PreAllocateFileSize key value. The maximum size of the temporary file is limited by the FileSystem.WriteBufferMemoryLimit key value. When the size of the temporary file reaches maximum value, it is recorded to the disk. Memory consumption highly increases in this case.

By default, when installing Axxon PSIM, the key is not created

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem


FileSystem.WriteBufferMemoryLimit>=041.0.0 and laterThe key sets the maximum possible size of the memory buffer for the channel; when this value is exceeded, the data from the buffer will be recorded to the archive. The unit of measurement is megabytes

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem

FileSystem.PreAllocateFileSize0-200101.0.0 and later

The key is used when FileSystem.MemFile=-1 (described above).

Sets the minimum size of a temporary file in RAM in megabytes, i.e., a file of the specified size will be created immediately before writing to it

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem

FileSystem.FastIndex0, 111.0.0 and later

The key enables fast index download. It is used by 64-bit modules only as memory consumption increases when reading and saving.

Regardless of the key value, the fastIndex.index file is created in the VIDEO folder. This file helps to download indexes much faster.

0 – when Axxon PSIM is started, all indexes are downloaded, so no time is wasted for data loading

1 – when Axxon PSIM is started, the specified file is downloaded and the data on detailed index for each hour will be loaded if required

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem

FileSystem.WriteBufferSize>041.0.0 and later

The key specifies the size of the video data chunks in megabytes that are recorded to the disk simultaneously. If the size of the frame is less than the specified value, it is "glued" to the next frame.

The key is used when the FileSystem.MemFile key value is 1 or -1

Note. See also WritingQueueSize

x32: (x32)\Video
x64: (x64)\Video
WritingQueueSize>0

100

1.0.0 and later

The key sets number of frames storing in RAM until start of data record to buffer. The key can be used with any codec

x32: (x32)\Video\FileSystem

x64: (x64)\Video\FileSystem

FileSystem.ReadRaw0, 101.0.0 and later

The key enables a more optimal read of video archive individual frames from the disk. It is created on the Server.

0 optimization of video archive reading is disabled

1 optimization of video archive reading is enabled

...

Video analytics

Registry section

String parameter

Available values

Default

Product version

Parameter in effect

x32: (X32)\Video\VMDA

x64: (x64)\Video\VMDA

VMDA.inactiveInterval

>0

-

1.0.0 and later

Key specifies time period in minutes, during which absence of detected objects by tracker is permitted. If the key is created, after the specified time and if there is no activity of VMDA detection, the message about inactivity will be generated. On default, this message is not generated

x32: (x32)\Video\VMDA
x64: (x64)\Video\VMDA
VMDAEXT0, 101.0.0 and later

The key is used for separating VMDA trackers process to the individual process. It's recommended to do to increase stability and reliability of the Axxon PSIM basic features. Allocating trackers to a separate process increases the CPU and memory resources used.

0—process of VMDA trackers is starting in the video.run process

1—process of  VMDA trackers is starting in the individual detector_ext.run process

Note 1. The detector_ext.run process is run under the video.run process. The video.run process controls the detector_ext.run process and restarts it if necessary.

Note 2. It's required to install the Axxon PSIM Detector Pack for correct key operation



Note
titleAttention!

If you created many VMDA trackers (for example, about 100), it is highly recommended to set VMDAEXT=1.


x32: (x32)\Video\VMDA
x64: (x64)\Video\VMDA
VMDAEXT.RAM>020001.0.0 and laterThe key is used with the VMDAEXT key and sets the memory space in megabytes which can use the detectror_ext.run process. The process will be restarted if the allocated memory is exceeded. The recommended value is in the range 2000-5000, depending on the hardware resources of the computer

x32:(X32)\Video\VMDA

x64: (x64)\Video\VMDA

VMDA.useSpeedLimitTypeLessThanVMDA detector IDs separated by comma or semicolon-1.0.0 and later

The VMDA detection tool IDs separated by comma or semicolon that should be triggered when the object speed is less than the speed configured for the VMDA detection tool.

Note 1. If no ID is specified for this parameter, or there is no parameter at all, the detection tool is triggered when an object crosses the line in the selected direction with a speed that is approximately the same as the speed configured for the VMDA detection tool.

Note 2. The same VMDA detector id can only be specified for either the VMDA.useSpeedLimitTypeLessThan or the VMDA.useSpeedLimitTypeMoreThan (see below) parameters. The simultaneous operation of both these parameters for the same VMDA detector is not allowed

x32:(x32)\Video\VMDA

x64: (x64)\Video\VMDA

VMDA.useSpeedLimitTypeMoreThanVMDA detector IDs separated by comma or semicolon-1.0.0 and later

The VMDA detection tool IDs separated by comma or semicolon that should be triggered when the object speed is greater than the speed configured for the VMDA detection tool.

Note 1. If no ID is specified for this parameter, or there is no parameter at all, the detection tool is triggered when an object crosses the line in the selected direction with a speed that is approximately the same as the speed configured for the VMDA detection tool. 

Note 2. The same VMDA detector id can only be specified for either the VMDA.useSpeedLimitTypeLessThan (see above) or the VMDA.useSpeedLimitTypeMoreThan parameters. The simultaneous operation of both these parameters for the same VMDA detector is not allowed

x32: (x32)\Video\VMDA
x64: (x64)\Video\VMDA
VMDA.ignoreAnaliticStream0, 101.0.0 and later

The key sets the camera stream used by the detection modules included in the Detector Pack subsystem.

0 – the Video Analytics stream is used

1 – the Default stream is used

Note. If the camera is not used in the multi-thread mode, the first stream (the only one) will be used regardless of the key value

x32: (x32)\Video\VMDA
x64: (x64)\Video\VMDA
VMDAEXT.DEBUGGER0, 101.0.0 and later

The key is used in conjunction with VMDAEXT = 1 (see above). Disables the restart of the Detector_Ext.run module by the Video.run module.

0 – the Detector_Ext.run process is restarted as necessary

1 – the Detector_Ext.run process is not restarted

x32: (x32)\Video\
x64: (x64)\Video\
DrawAngleArrow 0, 111.0.0 and later

The key disables an arrow showing the movement direction of an object detected by the Tracker in the Video Surveillance Monitor.

0 – direction arrow is not displayed

1 – direction arrow is displayed

x32: (x32)\Video\VMDA

x64: (x64)\Video\VMDA

VMDA.oneAlarmPerTrack0, 111.0.0 and later

The key is used together with the key VMDAEXT = 1 (see above). The key determines the alarm generation mode.

0 – one track – many alarms

1 – one track – one alarm

If the key isn't created, the VMDA trackers and neural trackers operate as if VMDA.oneAlarmPerTrack = 1

x32: (X32)\Video\VMDA
x64: (x64)\Video\VMDA
VMDA.SendNewObjectEventToCore0, 111.0.0 and later

The key disables sending events CAM|NEW_OBJECT and CAM|OBJECT_LOST to the core.

0 – events will not be sent to the core

1 – events will be sent to the core

TABLE OF CONTENTS


Web Server

Registry section

String parameter

Available values

Default

Product version

Parameter in effect

x32: (x32)\WebServer\

x64: (x64)\WebServer\

RequestTimeout >0100001.0.0 and later

Sets max.time (in milliseconds) for Server to process a request

x32: (x32)\WebServer\

x64: (x64)\WebServer\

ConnectionTimeoutAtIdle >0300001.0.0 and laterSets max.time (in milliseconds) for connection inactivity between Client and Server. Inactive connection is disconnected upon timeout

x32: (x32)\WebServer\

x64: (x64)\WebServer\

TelemetryPriority0 – 311.0.0 and laterSets the PTZ control priority for a web browser.
0 – control is prohibited
1 – low priority control
2 – medium priority control
3 – high priority control
x32: (x32)\WebServer\
x64: (x64)\WebServer\
SplitArchiveIntervals>050001.0.0 and laterThe key is responsible for merging fragments when requesting the range of available archive recordings via HTTP API (see Ranges of available archive recordings). The interval is set in milliseconds. If the time between recordings is less than specified one, then recordings are merged into one
x32: (x32)\WebServer\
x64:
(x64)\WebServer\
ClearConnectionTimeout>010001.0.0 and later

The key specifies the time in milliseconds for clearing idle connections between the Web-server and connected devices. If the specified time is exceeded, the idle connection is terminated

x32: (x32)\WebServer2\
x64
:
(x64)\WebServer2\
ActiveWebSocket0, 101.0.0 and later

The key enables the possibility of receiving the events of the video subsystem using the WebSocket communication protocol for the Web server 2.0.

0events are received as push notifications

1events are received via WebSocket

The key is created in the registry automatically after you add the Web server 2.0 object

TABLE OF CONTENTS


Map

Registry sectionString parameterAvailable valuesDefault Product versionParameter in effect

x32: (x32)\Map\

x64: (x64)\Map\

NotUsingCash0, 1-1.0.0 and laterThe key is in use on the map when there are objects the backgrounds of which are overlaid. In these cases the object icons can be erroneously displayed because of background caching. To fix these bugs you should disable caching by specifying 1 value for the key. Take into account the fact that caching disabling can cause high CPU load

x32: (x32)\Map\

x64: (x64)\Map\

AlternativeSelect0, 101.0.0 and later

The key is designed to disable object framing.

0 – the object is framed

1 – the object is not framed

x32: (x32)\Map\

x64: (x64)\Map\

<Map_id>MiniMapB>0MiniMapT + 1691.0.0 and later

Sets the Y-axis coordinate of the bottom right corner of the minimap on the monitor in pixels.

Changing of the key value can be required for exact minimap sizing or for resetting minimap position (by deleting MiniMap keys)

x32: (x32)\Map\

x64: (x64)\Map\

<Map_id>MiniMapL>0The X-axis coordinate of the upper left corner of the Map 1.0.0 and later

Sets the Y-axis coordinate of the upper left corner of the minimap on the monitor in pixels.

Changing of the key value can be required for exact minimap sizing or for resetting minimap position (by deleting MiniMap keys)

x32: (x32)\Map\

x64: (x64)\Map\

<Map_id>MiniMapR>0MiniMapL + 2871.0.0 and later

Sets the X-axis coordinate of the bottom right corner of the minimap on the monitor in pixels.

Changing of the key value can be required for exact minimap sizing or for resetting minimap position (by deleting MiniMap keys)

x32: (x32)\Map\

x64: (x64)\Map\

<Map_id>MiniMapT>0The Y-axis coordinate of the upper left corner of the Map1.0.0 and later

Sets the X-axis coordinate of the upper left corner of the minimap on the monitor in pixels.

Changing of the key value can be required for exact minimap sizing or for resetting minimap position (by deleting MiniMap keys)

x32: (x32)\Map\Minimap

x64: (x64)\Map\Minimap

ShowOnMouseMove0, 101.0.0 and later

Sets how the minimap is displayed:

0 – using the Minimap item in the Map feature menu

1 – pointing the mouse cursor to the top left corner of the Map

x32: (x32)\Map\

x64: (x64)\Map\

EventFontHeightInteger-81.0.0 and laterSpecifies the font size for displaying information about the latest event in the feature menu of the object on the map

x32: (x32)\Map\

x64: (x64)\Map\

InscribeEditor0, 111.0.0 and later

The key enables the automatic "Fit the window"checkbox activation for all layers in the Map editor window if this checkbox was previously set for any layer.

0 – the layer will be fit into the Map editor window only if the "Fit the window" checkbox was previously set for this layer

1 – any layer will be fit into the Map editor window, if the "Fit the window" checkbox was previously set for any layer

x32: (x32)\Map\

x64: (x64)\Map\

HideAnalogName0, 101.0.0 and later

The key hides the "Value =" in the value of the objects on the Map for which the Text type of display is selected.

0 – objects' text values are displayed on the Map with the "Value =

1 – objects' text values are displayed on the Map without the "Value =

x32: (x32)\Map\

x64: (x64)\Map\

TouchScreen0, 101.0.0 and later

The key enables opening of the functional menu of the object on the Map by left double clicking the icon.

0 – left double-clicking the icon of an object on the Map does not open the functional menu

1 – left double-clicking the icon of an object on the Map opens a functional menu

x32: (x32)\Map\

x64: (x64)\Map\

MapBlinkUpdateTimeoutMS>03501.0.0 and later

Specifies the period in milliseconds to update the Map. The Map update period determines the flashing period of the icons. At the default value (350 ms), the flashing period of the icons is 700 ms.

Reduce the key value, for example, in cases where the object state changes faster than once every 700 ms and icons are not updated when blinking.

Increase the key value to reduce the load on the Map module

x32: (x32)\Map\

x64: (x64)\Map\

Sort_by_id0, 101.0.0 and later

The key alters object sorting in the Layer drop-down list while operating the object list on the Map (see Monitoring the object status using the Objects list).

0 – sort by name (default)

1 – sort by object ID

x32: (x32)\Map\

x64: (x64)\Map\

DisableBlinkLink0, 101.0.0 and later

The key disables blinking of the layers link icon on the map in case of alarm.

0 – blinking of the icon is enabled

1 – blinking of the icon is disabled

x32: (x32)\Map\

x64: (x64)\Map\

NoInheritAlarmAnotherCard0, 101.0.0 and later

The key disables blinking of the related layers on the map in case of alarm.

0 – both the layer with the alarm and the layers related to it blink

1 – only the layer with the alarm blinks

x32: (x32)\Map\

x64: (x64)\Map\

AlarmLinkSearchDepthKey-1, 0, >0-11.0.1 and later

The key specifies the search depth for alarms across map layers.

-1—search across  layers is not limited.

0—related layers are not taken into account during search, that is, in case of alarm, only the layer on which the alarm occurred will blink (the behavior is similar to the NoInheritAlarmAnotherCard=1 key, which was used before version 1.0.1 and is described above).

>0—indicates the number of layers through which the search will be performed. For example, the Map has 6 interconnected layers and the alarm appeared on the 3rd layer. If the key value=1, the alarm will blink on layer 3, as well as on layers 2 and 4.

The key works when the Search alarmed links recursively checkbox is set and is similar to the Search depth parameter in the interface, see Configuring the mechanism for searching and processing alarm signals on multilayer maps

x32: (x32)\Map\

x64: (x64)\Map\

DrowArrowSearchDepth>=051.0.0 and later

The key sets the depth of making a track between layers when using the DRAW_ARROW command.

0the depth of searching for connections to make a track between layers isn’t limited

>0the number of layers that will be used to find connections to make a track. For example, if there are five map layers and there are alarms on the 1st and the 5th layer, then with DrowArrowSearchDepth=5, the track will be made from the 1st to the 5th layer. With DrowArrowSearchDepth=4, the track won’t be made as there isn’t enough search depth

...