New MIP SDK

Thursday, 8 June 2017

Author: Toyah Hunting

Company News

What's new?

Two larger features – and many small ones - have been added to the MIP SDK with the latest two Milestone Product Updates, R1 and R2.

  • Support for populating the timeline in the XProtect® Smart Client from a plugin, released with the 2017 R1 release of the Smart Client and the MIP SDK
  • Video wall support, released with the 2017 R2 release of XProtect® Corporate and the MIP SDK

"We have wanted to add these features for quite some time," says MIP SDK Team Lead Peter Posselt Vergmann. "We anticipate that they will enable our partners to enhance the functionality of existing integrations, but also to implement entirely new ones."

Populating the timeline in XProtect Smart Client

You can now implement a plugin for the Smart Client that populates the main timeline in the playback workspace.

A view item plugin can do it for itself, but it is also possible for a background plugin to do it for the built-in camera items.

Two types of data can be added; ribbon data and markers. The ribbon data can be used to indicate in what periods plugin data is available, while the markers typically indicates incidents or events.

The plugin controls the color for the ribbon data and the icon for the markers. It can also provide a preview for the markers.

Timeline population is implemented through overriding the TimelineSequenceSource class. The Smart Client Timeline sample in the SDK is an example of how it is done.

Please note that per default the Smart Client will not be showing neither the ribbon data nor the markers. The operator must enable it in the Settings panel under Timeline (Additional data and Additional markers). It can also be enabled by the administrator in the Smart Client Profiles.

Video wall support

The Smart Wall has been a blind spot in our SDK support for a long time. We are happy to say that this is no longer the case. With the 2017 R2 release, we now support configuring and controlling the Smart Wall. This makes it possible for our partners to implement their own video wall, controlling it with Smart Wall control mechanisms like the Smart Client Smart Wall plugin and the rule system.

Through the Configuration API you can add, remove, browse through and edit video walls, monitors and presets. Using standard MIP configuration access methods such as Configuration.Instance.GetItems and the ItemPickerForm you can browse through the video walls and their child objects.

Finally, using the MIP message communication you can send commands to control what is shown on a specific monitor, but also listen for messages telling when a video wall is updated, so that you can control your own video wall implementation.

The Video Wall Controller sample demonstrates how to do some of the above-mentioned functionality. A general overview of the new functionality is given in the Introduction to Video Wall Integration document in the MIP SDK.

Video wall SDK functionality is only supported on the VMS products that has Smart Wall support.

Download new MIP SDK