Versions Compared

Key

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

...

Section


Column
width45%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleTables
Table of Contents



Column
width45%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleDesignations

The following designations are in the reference guide:

(x32x64) – HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\AxxonSoft\PSIM registry section

(x64x32) – HKEY_LOCAL_MACHINE\SOFTWARE\AxxonSoft\PSIM\ registry section

For the Monitoring software:

(x32x64-Monitoring) – HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BitSoft\VHOST\VHostService registry section

(x64x32-Monitoring) – HKEY_LOCAL_MACHINE\SOFTWARE\BitSoft\VHOST\VHostService registry section



...

IP integration (drivers and codecs pack for Axxon PSIM)

Registry section

String parameter

Available values

Default

Product version

Parameter in effect

x32: (x32)\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: (x32)\Video
x64: (x64)\Video

DoubleStream

0, 1


1.0.0 and later

Defines whether asynchronous video display mode is enabled or not.

x32: (x32)\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: (x32)\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 Change 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 the 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: (x32)\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.

...