Introduction

Introduction to MIP SDK 2023 R1

MIPSDK General

Discontinuation Announcement: The 2023 R3 XProtect VMS release will be the last release to include clients, documentation and APIs for C++ integrations. This includes the MilestoneSystems.VideoOS.Platform.SDK-CPP NuGet package, the ServerCommandServiceClient DLL and all C++ Toolkit APIs.

Component integrations

Breaking change: In previous versions the RoleFolder.AddRole method taking 9 arguments would accept null and string.Empty for the last two arguments. This was not documented and unintended and has now been changed, so that it will fail if these are provided. To avoid setting the roleDefaultTimeProfile and roleClientLogOnTimeProfile, just use the version of the method taking 7 arguments instead.

API Gateway

The 2022 R3 release contained a pre-release of support for the WebRTC protocol. This feature has been finalized in the 2023 R1 release and is now enabled by default. Please see documentation on the XProtect API Gateway for details on configuration and troubleshooting, together with the MIP SDK documentation on the sample that demonstrates how to develop a client.

Driver framework

Third-party device drivers are now supported in the Express mode add-hardware wizard in the Management Client and Configuration API. Supported discovery schemes are UPnP, Ping/ARP, mDNS and ONVIF. The SupportedSchemes property on DriverInfo specifies which scheme(s) to use.

Smart Client

ViewItemIndex property added to ImageViewerAddOn enabling reading the index of the containing ViewItem.

Configuration API

ReplaceHardware method has been added to Hardware items which makes is possible to update the configuration after hardware has been physically replaced. It can also be used to change the driver used for the hardware.

Generic events

The generic event interface has been extended with support for related camera IDs. If the text received contains related=<GUID> and the GUID corresponds to the ID of a camera in the system, the ID will be added to the RelatedFQID property of the event and can be used in rule actions by choosing "Use devices from metadata". Only cameras are supported.

Samples

The following samples have been changed:

Several Smart Client samples have been rewritten to use WPF instead of WinForms as we recommend using WPF for both performance and rendering reasons. The remaining Smart Client samples will also be rewritten in the coming months.

The following sample has been removed:

DemoDriver and DemoDriverDevice have been modified to demonstrate the new discovery scheme support.

Fixed issues

RoleDefaultTimeProfile and RoleClientLogOnTimeProfile properties were ignored when RoleFolder.AddRole were called on Configuration API (also affected REST API).

Bug-fix maintenance release 23.1.2

There is a new release 23.1.2 of the MilestoneSystems.VideoOS.Platform.SDK and MilestoneSystems.VideoOS.Platform.SDK.Debug NuGet packages. This release includes the following bug fixes:

Fixed a memory leak whenever the renderers are being recreated when using ImageViewerWpfControl/ImageViewerControl.

Bug-fix maintenance release 23.1.3

There is a new release 23.1.3 of the MilestoneSystems.VideoOS.Platform.SDK and MilestoneSystems.VideoOS.Platform.SDK.Debug NuGet packages. This release includes the following bug fixes (in addition to the 23.1.2 fixes):

An issue was found in ImageViewerWpfControl and ImageViewerControl, which could cause it to throw unhandled System.InvalidOperationException if two or more controls were used in different threads.