Introduction

Introduction to MIP SDK 2019 R3

To improve security, all methods and properties that include passwords as string arguments now also have a version taking a SecureString instead. Going forward, it is encouraged to use the SecureString versions.

As of 2019 R2, the Central/AlarmService API has been removed from the Event Server for security reasons. Protocol integrations should instead use the secure Central/AlarmService2 API. Please refer to the Alarm List sample for an example of how to utilize this interface.
The Search API has changed between MIP SDK 2019 R2 and 2019 R3. This could cause search agents that were developed using MIP SDK 2019 R2 to no longer compile.

The following methods are no longer available in MIP SDK 2019 R3:
- VideoOS.Platform.Search.SearchDefinition.GetFilterDisplayValue
- VideoOS.Platform.Search.FilterValues.SelectionFilterValue.SetDisplayValue
This method’s return type has been changed from ICollection<Guid> to IReadOnlyCollection<Guid> in MIP SDK 2019 R3:
- VideoOS.Platform.Search.FilterValues.SelectionFilterValue.get_SelectedIds
The following abstract methods have been introduced in MIP SDK 2019 R3:
- VideoOS.Platform.Search.FilterValues.FilterValueBase.Serialize
- VideoOS.Platform.Search.FilterValues.FilterValueBase.Deserialize
- VideoOS.Platform.Search.ISearchManager.DestroySearchDefinition

This release introduces a new framework for developing device drivers as plug-ins for XProtect Recording Servers. The framework simplifies the development of drivers to support all the functionality one would expect from a device that is integrated with XProtect. This includes support for all device types (camera, microphone, speaker, I/O and metadata), all codecs, PTZ, events and Edge storage retrieval.

Adaptive streaming for standalone ImageViewerControl and ImageViewerWpfControl: Adaptive streaming improves the decoding capability and performance of the computer running the viewing client. This is particularly useful when you view multiple live video streams in the same view. To take advantage of adaptive streaming, your cameras must have multiple streams defined with different resolutions.

The StableFPS test driver has been updated with new features for running multiple video stream and using custom commands. Please note that StableFPS now requires device pack 10.4 or later to be installed on the system.

Demo Driver sample has been added, showing how to create a device driver using the MIP Driver Framework. The sample includes all supported device types - i.e., cameras, microphones, speakers, inputs, outputs, and metadata. The sample comes with an application, Demo Driver Device, that simulates an actual hardware device.

ImageViewerControl would in certain situations throw System.InvalidOperationException when run in debug mode in Visual Studio 2019.
If the ImageViewerWpfControl was created on another thread than the main UI thread, it would throw an exception telling that it had been accessed from a thread different from the one that created it.
If message communication registration was done in the Init method of an Event Server background plugin, it would fail.
OutgoingAudioErrorTextEvent on OutgoingSpeakerController and DirectSpeakerController would in certain scenarios be fired even though OutgoingAudioErrorText had not changed.
ServerMonitor would always report that the server was online if incorrect credentials were provided. It will now fail instead, and the actual problem can be seen from the LastException property.