The xprotect driver

This driver supports Milestone’s XProtect Corporate and XProtect Professional+ video management software running in a company-wide installation that includes at least one Supervisor PC.

Versions supported

Milestone Xprotect version Supported by
Xprotect 2020 R3 and earlier Niagara 4.10u1 and earlier
Milestone Xprotect 2021 R1 Not supported

xprotect features

Supported features include:

  • Automatic discovery of cameras
  • PTZ operations: control and go to presets
  • Surveillance Viewer
  • Live HTML5 video streaming
  • Playback HTML5 video streaming
  • Switching between live and playback video
  • Motion detection alarms and recording video triggered by an alarm
  • Alarm console video playback
  • Remote video connections
  • Fox video streaming
  • Graphics widgets
  • Support for a management server

Tested models

The xprotect driver has been tested with the Milestone XProtect Corporate and XProtect Professional+ products.

Required files

This file in the Niagara_Home\modules folder: xprotect-wb.jar

 NOTE: The previous module name for the xprotect driver was xprotect-se.jar. If you upgrade a system, do not copy this old file to the module folder. Running the software with both drivers introduces conflicts. 

These files are in the Niagara_Home\bin folder:

  • VideoOS.Platform.dll
  • VideoOS.Platform.SDK.dll
  • xprotectBridgeService.exe

Compliance

 NOTE: For the purpose of configuring a camera, the xprotect driver must run in the Supervisor PC. Stand-alone systems, which have only one controller, do not support integrating a camera with the Milestone video management software. In a company-wide installation, the xprotect driver running in a controller provides alarm mapping (it resolves xprotect camera Ords that appear in the Supervisor’s alarm console). No other xprotect features work in a controller. 
  • The Xprotect SDK API does not support preset creation. The xprotect video driver supports only the Move to Preset option. To create presets, use the Milestone Corporate software.
  • An action on the XProtect camera, called Get Preset List, must be invoked to read the list of presets from the Milestone Corporate software. Workbench provides this action, which takes immediate effect. Otherwise, getting presets from the camera occurs automatically on each camera ping.
  • The XProtect SDK does not provide an API to add a camera programmatically to the management or recording servers. As a result, the xprotect driver does not support the add-net-camera option from Workbench. You must discover cameras to add them to a station.
  • The XProtect SDK API does not support Iris and Focus controls. Consequently, the xprotect driver does not support the Iris and Focus operations from Workbench.
  • The xprotect driver supports only Motion Detection Started and Motion Detection Stopped alarm conditions from the Milestone Corporate software.
  • Since motion detection events are polled from a recording server, recording servers must be discovered and added to the management server component apart from cameras.

HTML5 streaming

The latest versions of Niagara support the video framework HTML5 streaming using the Milestone xprotect driver for video playback. The Surveillance Viewer continues to use the applet view (supported by Web Launcher), however, the playback viewer supports HTML5–rendered video clips. HTML5 streaming makes use of the MilestoneXprotectServer and XProtectMobileServer.