Clarifications about the configuration API

MIP
, , , ,
1

Hello,

We need to do an app that will add new hardware into recorders programmatically. I already know about https://doc.developer.milestonesys.com/html/samples/configApiImport.html and https://developer.milestonesys.com/s/question/0D50O00003fr6ZpSAI/new-sample-add-cameras-configuration-api

It looks like I can call “AddHardware” using different APIs:

  1. VideoOS.ConfigurationAPI.ConfigurationItem
  2. VideoOS.Platform.ConfigurationItems.RecordingServer

Also https://doc.developer.milestonesys.com/html/gettingstarted/intro_configurationapi.html and the PDF “Integration for Configuration Automation MIP SDK Decision Guide” both say “The Configuration API is available for XProtect Corporate and XProtect Expert.”

So, after this introduction here are my questions:

  • Is the configuration API really only available in Corporate and Expert?
  • What is the difference between api 1 & 2?
  • Is API 2 always available (also on essential+ pro+ etc?)

Kind regards,

Philippe

2

Ok I think I may have it figured out.

  • “VideoOS.Platform.ConfigurationItems.RecordingServer” is to access RecordingServer direcly.
  • “VideoOS.ConfigurationAPI.ConfigurationItem” is for when you want to deal with the configuration in a generic manner, using “ItemType” to differentiate items etc.

Did I get this right? If yes what remains is then my question about Corporate/Expert.

3

Let me start by referring to the announcement:

-–

Introduction to MIP SDK 2017 R3

--

Strongly typed classes are now available for easier use of the Configuration API. Under the namespace VideoOS.Platform.ConfigurationItems (located in VideoOS.Platform.dll) any standalone application or MIP plugin can now access all the configuration items through these approximately 75 classes.

-–

So there is a generic API as described in https://doc.developer.milestonesys.com/html/gettingstarted/intro_configurationapi.html

At the same time there is an implementation of the API that uses strongly typed classes. Comparing the samples you will find these two “styles”..

Configuration API is available on all c-code XProtect, at one point in history that was XProtect Corporate and Expert, now newer c-code XProtect products include XProtect Professional+, Express+ and Essential+. What is not supported is the e-code XProtect Professional, Express and discontinued Enterprise. Please note that the + (PLUS) today shows which code-base these products are.

4

Thanks!

I think you’d update the doc/pdf so it’s more clear that it’s available for all C-Code products.

Also maybe consider using a + in all C-Code products names for simpler disambiguation :wink: Having to mentally say “All names with + and Expert and Corporate” is annoying at first, then you get used to it.

Kind regards,

Philippe