Introduction

Introduction to MIP SDK 2025 R2

From MIP SDK 2025 R3 VideoOS.Platform.SDK.RemoteRetrievalTasks.dll including RetrievalTaskManager will no longer be part of the MilestoneSystems.VideoOS.Platform.SDK NuGet package. We recommend using the RESTful API or VideoOS.Platform.ConfigurationItems.Camera.RetrieveEdgeStorage instead.
MIP message MessageId.Server.NewAlarmAsEventCommand is no longer supported. Instead, use MessageId.Server.NewEventCommand.
The endpoint /ServerAPI/ServerCommandService.asmx has been removed. Instead, use /ManagementServer/ServerCommandServiceOAuth.svc or /ManagementServer/ServerCommandService.svc.
The view items TextViewItem and ImageViewItem have been deprecated and removed. These have been replaced by the new TextImageViewItem, which combines text and image functionality while also being structured as a MIP plug-in.
The MIP SDK templates are no longer supported for Visual Studio 2017. They are now only available for Visual Studio 2019 and later versions.

DBExporter now has a property, FailOnInvalidSignature, that if set to true (default) will cause the export to fail if signing is enabled and any sign errors are detected in the data during export. If the property is set to false the export will succeed but the property SignErrorsDetected will be set once export is completed.

Previously, the use of multiple user controls was only supported for Admin plugins that could add multiple items (ItemsAllowed.Many). This functionality has now been extended to support plugins that can add only a single item (ItemsAllowed.One).

A new TextImageViewItem has been introduced, replacing both the TextViewItem and ImageViewItem.
Previous TextViewItems and ImageViewItems will be migrated to the new view item.

ACUnit has a new string property called GisPosition. When set, this property represents the geographical coordinates of the ACUnit in the format "latitude, longitude"
ACUnit has two additional constructors. One which can now also accept latitude and longitude arguments and one which can accept latitude, longitude and unsupportedCommandTypeIds together. Passing both latitude and longitude to the new ACUnit constructors will set the GisPoint property of the ACUnit class. Alternatively the GisPoint property can also be set by calling the SetPosition() method of the ACUnit class and passing latitude and longitude as parameters.
The coordinates of Access Control units can be synchronised with the Access Control System, if the plugin overrides the AccessControlUnitPositionChanged function in the ACConfigurationManager implementation.
If the system does not support coordinates, then synchronization should not be implemented and the changing of coordinates in Smart Client will not affect the plugin.

RESTful Config API:
- Events for Access Control, Transact, LPR and System Monitor are now supported in alarm definitions.
- Tasks for applying content of another view to a view, for clearing a view, and for clearing a view item has been added to the views endpoint.
- View items returned by the views endpoint now contains an id property.

Video codec support has been extended to include both MJPEG and H.265 streaming in WebRTC, as well as the existing H.264.
- MJPEG: Support video with only YUV components.
- H.265: Support for single NAL unit packets, aggregated packets as well as fragmentation unit packets. Does not support PACI packets.
Support for Audio streaming in WebRTC.
- Support for audio has been added to the WebRTC streaming. Streaming now supports audio or video or both. The includeAudio parameter is used to specify whether audio should be included in the stream. The default value is true. If set to false, only video will be streamed.
CameraId changed to deviceId in WebRTC.
- The parameter cameraId has been replaced with the parameter deviceId. The deviceId can be either a cameraId or a microphoneId.
The request object for WebSockets-based signaling has been aligned with the ONVIF protocol. The ApiVersion parameter is deprecated and has been replaced with jsonrpc. The version of jsonrpc has been updated from 1.0 to 2.0. This is done to follow the JSON-RPC 2.0 specifications.

The following samples have been added:

WebRTC - .NET Client has been added to showcase a .NET solution for WebRTC streaming MJPEG using SIP Sorcery.
Admin Multi-tab: A sample that demonstrates how to create a multi-tab plug-in that can be used to display multiple tabs in the Admin client.

The following samples have been changed:

DemoAccessControlPlugin has been extended to show support for Latitude and Longitude coordinates for the ACUnit class and to show how to support coordinate synchronisation.
RemoteretrievalTask has been changed to use VideoOS.Platform.ConfigurationItems.Camera.RetrieveEdgeStorage and VideoOS.Platform.ConfigurationItems.ManagementServer.LoadTasks instead of RetrievalTaskManager.
DemoACServerApplication has been extended to show support for Latitude and Longitude door coordinates. When adding or editing a door you can now insert latitude and longitude coordinates. The coordinates of each door can also be seen on the door management screen. The DemoACServerApplication is supplied with the DemoAccessControlPlugin. Changing the coordinates of a door in the Smart Client is also reflected in the coordinates of doors in the application.
ExportSample has been updated to showcase the two new DBExporter properties, FailOnInvalidSignature and SignErrorsDetected.
VideoPreview has been updated to work correctly in floating windows and other workspaces than the main one.
WebRTC - JavaScript client has been extended to support audio streaming.

If multicast was enabled for a camera, the ImageViewerWpfControl would fail showing the video and a log stating "Error: MulticastConfig (): The calling thread cannot access this object because a different thread owns it." would be made.
When a view item plug-in defined an embedded camera either by setting the EmbeddedCameraFQID setting in the ViewItemManager.Properties dictionary or adding it to ViewItemManager.RelatedCameraIds, a related microphone or speaker of the camera would not automatically be selected in the Smart Client when the view item was selected.
For some plug-in types the plug-in binaries were not included in Smart Client exports despite PluginDefinition.IncludeInExport being set to true.
Image viewers in floating windows and other workspaces than the primary would not always follow the correct mode of the workspace.

There is a new release of the MilestoneSystems.VideoOS.Platform.SDK NuGet package. This release includes the following bug fixes:

ImageViewerWpfControl and ImageViewerControl would in some cases show just a black image and add the following to the logs: "Error: MulticastConfig(): The calling thread cannot access this object because another thread owns it." This issue has been fixed.

There is a new release of the MilestoneSystems.VideoOS.Platform NuGet package. This release includes the following bug fixes:

RetrieveEdgeStorage would remove milliseconds from both start and stop times before retrieving data from the Event Server. This has now been fixed.