Introduction

Component integrations

• Environment.AddServerOAuth(bool, Uri, ITokenCache, bool) method has been removed. Use Environment.AddServerOAuth(bool, Uri, IMipTokenCache, bool) instead.

Driver framework

• Virtual GetStreamInformation method has been added to SessionEnabledStreamManager in order to support adaptive streaming. Override this method in order to provide information about current resolution provided by the stream.

Configuration API

• Mail notification profiles can now be added, updated, and removed, and mail server settings can be configured.
• Bookmarks can now be added, read, updated, and removed.
• Registered services can now be added, read, and removed.
• Task for removing a recording server has been added.
• Evidence lock profiles can now be added, updated, and removed.
• Underlying view can be read for a video wall monitor.
• Items of type ValueTypes.DateTimeType has been aligned to all use the standard round-trip pattern (e.g. 2009-06-15T13:45:30.0000000Z).

RESTful APIs

• RESTful Config API:
  • Tasks for going to PTZ presets, activating, deactivating and triggering outputs, and getting and setting the absolute position of cameras have been added.

  • Two endpoints for reading what permissions you have on XProtect have been added:

    The endpoint /securityNamespaces is used to see what security namespaces are defined, e.g. what the ID is and what security actions exists and their bit position (as it is used in the effectivePermissions API).

    The endpoint /effectivePermissions is used to see what permissions the caller has, when combining the settings from the overall security settings and multiple role settings. The result is a dictionary of object IDs and a bitmask of permissions within the security namespace being asked for, e.g. 'cameras'. Only the object IDs the caller has read access to are returned.

  • The endpoint /registeredServices for managing registered services has been added.
• RESTful APIs for tagging video sequences have been added:
  • The endpoint /bookmarks for managing bookmarks.
  • The endpoint /evidenceLocks for managing evidence locks.
• No longer in beta:
  • RESTful Events API
  • RESTful Alarms API

WebSocket APIs

• No longer in beta:
  • WebSocket Messages API

Smart Client

• ImageViewerAddOn extended with property StreamId providing access to reading and changing the selected stream. Similarly ViewItem instance items returned by Configuration.GetItems will contain CurrentStreamId readonly property in the Properties dictionary.

Samples

The following samples have been changed:

• Smart Client ImageViewerAddOn has been extended with functionality that demonstrates reading and changing the selected stream of the currently selected camera view item.
• Demo Driver has been extended with support for adaptive streaming.
• Config Updated has been removed. Instead use the Configuration Access sample. The Configuration Access sample shows the recommended method of keeping the configuration updated automatically in a MIP SDK application, automatically updating the configuration without requiring an restart.

Fixed issues

• Matching of HTTP headers for the WebRTC signaling were case-sensitive.
• Calling Save method twice on same ConfigurationItems.View object would cause an ArgumentMIPException to be thrown.