Skip to main content
All CollectionsEdgeVis encodersEncoder user guideUsing ONVIF Profile M support
Viewing ONVIF profile M metadata in Milestone XProtect
Viewing ONVIF profile M metadata in Milestone XProtect

Configuring Milestone XProtect to stream video and metadata from a VMS Gateway VOD

Updated over a month ago

Introduction

EdgeVis supports publishing analytics triggers and metadata to third-party VMS using VMS Gateway. These analytics can come from a number of sources:

Below are the steps needed to get ONVIF Profile M data from an encoder into Milestone.

Prerequisites

To perform these steps you will need:

  • A working version of Milestone XProtect.

  • Administration accounts to use and configure Milestone XProtect Management Client and Milestone XProtect Smart Client.

  • A running EdgeVis system with EdgeVis Server and encoders connected, with Object Detector enabled.

  • VMS Gateway connected to the EdgeVis Server and at least one published VOD visible on the same network as your Milestone system. For an example of connecting a camera to an EdgeVis encoder, creating an associated output stream and then publishing it as a VOD please refer to Using EdgeVis to connect an ONVIF Profile M camera to Milestone.

  • From VMS Gateway for each published VOD.

    • Its IP address.

    • The credentials needed to connect to the VOD.

Adding the VMS Gateway VOD data to Milestone

Here are the steps to follow to add the VOD data to Milestone:

  1. Open the Milestone XProtect Management Client and select your Recording Server.

    Select the recording server

  2. From the Action menu select Add Hardware.

    Select the Action menu Add Hardware item

  3. In the Add Hardware wizard select the Manual option and click Next.

    Select the Manual option in the Add Hardware wizard

  4. Click the Add button to create some new user credentials for accessing your VOD.

    Click the Add button to create new user credentials

  5. Enter the User name, which in VMS Gateway defaults to root, and the Password then click Next.

    Set the User name and Password

  6. Ensure that the ONVIF driver is selected, as that is how the VOD will be detected, and click Next.

    Ensure that the ONVIF driver is selected

  7. Enter the IP Address for the VOD, and ensure that Use HTTPS is not selected, unless you have configured your VOD to use HTTPS, then click Next.

    Enter the IP Address for the VOD

  8. The next screen will show Milestone performing a scan and discovering your VOD. The Hardware model for the discovered device will be Digital Barriers Ltd. VMS Gateway (ONVIF). Click Next to continue.

    The hardware scan completed

  9. The next screen shows Milestone connecting to the discovered hardware and collecting information. When this has finished, click Next to continue.

    Data collection completed

  10. The next screen shows information that has been retrieved from the VOD, checking the Enabled box next to each entry will select that information to be added to Milestone. In the case of ONVIF Profile M metadata you'll need to check the box next to the Metadata port entry in addition to the Hardware and Camera ports. Click Next when this is done.

    Select Metadata port

  11. The next screen lets you select any previously defined Milestone groups to add the data to. In our example we leave all these as the default and click Finish to close the Add Hardware wizard.

    Accept the default groups and click Finish

Confirming the data is being received

When the Add Hardware wizard has finished you should then confirm that the data is being received from the VOD.

  1. The video stream from the VOD displayed in the Preview panel of the Milestone XProtect Management Client.

    The video stream is displayed

  2. Now confirm that the metadata is being received. In the navigation tree on the left-hand side of the interface select Metadata under the Devices node.

  3. Expand the Metadata node on the Devices panel and click on Digital Barriers Ltd. VMS Gateway...

  4. The Preview panel will show an animation indicating that metadata is being received.

    The Metadata stream working

Enabling metadata search

So everything seems to be working, but before you can use the metadata to search for events in the Milestone XProtect Smart Client, there are a few extra steps that you need to perform.

  1. In the navigation tree on the left-hand side of the interface scroll down and select the Metadata Search node under Metadata Use.

    The Metadata Search node

  2. In the Metadata Search panel you'll see three Search Categories: Location, People and Vehicles. The Object Detector is only applicable to People and Vehicles.

  3. Select People, you'll then see some checkboxes in the Visibility in XProtect Smart Client panel.

  4. Select the first of these, People, the other checkboxes will then be enabled but you don't need to select them as the Object Detector does not currently support Age, Face, Gender or Height. This will enable you to search in the client using the general category People but not clutter the interface by presenting the sub-categories that don't apply.

    Select check People category checkbox but not the sub-categories

  5. Now select Vehicles in the Metadata Search panel. This will display a response box asking if you want to save the changes you made to the People Search Category. Click Yes to continue.

    Do you want to save the changes made to the People Search Category?

  6. In the Visibility in XProtect Smart Client panel check only the Vehicles checkbox, as the Object Detector does not currently support Color, License plate, Vehicle speed or Vehicle type.

    The Vehicles search category selected but not the sub-categories

  7. After selecting the Vehicles checkbox it is important that you navigate to another node in the Metadata Search panel, as this is the only way to display the response box asking if you want to save the changes. Click Yes in the response box to successfully save the changes to the Vehicles metadata.

    Do you want to save your changes to the Vehicles Search Category?

Summary

After these steps you will have completed everything you need to do, using the Milestone XProtect Management Client, to display video and metadata coming from the VOD.

  • Detected and added the VOD published by the VMS Gateway to Milestone XProtect.

  • Verified that Milestone XProtect is receiving both video and metadata from the VOD.

  • Enabled metadata search appropriate to the Object Detector analytics.

After this you need to configure the Milestone XProtect Smart Client to view the data and search for metadata.

Configuring the Milestone XProtect Smart Client

All of the setup needed to enable access to the video stream and metadata coming from the VMS Gateway VOD has been done. You now need to set up the view in Milestone XProtect Smart Client in exactly the same way as you would for any other type of camera.

Viewing the video stream and metadata from the VOD

  1. Start your Milestone XProtect Smart Client and login using an account with the appropriate administration permissions to manage views and access cameras.

  2. Once the Smart Client has loaded, in the navigation panel on the left-hand side of the interface select the view group where you want to configure the VOD camera view. In our example this is the Default view group.

    The Default group selected

  3. Click the Setup button on the right-hand side of the interface to enter into setup mode.

    Click the Setup button to enter setup mode

  4. In the Views section of the navigation panel, where the Default view group is selected, click on the Create new view tool at the bottom of the section. This displays a popup menu, where you can control how the view is formatted. In our example we choose a 4:3 horizontal ratio with a single view in it.

    The new view dimensions and configuration selected

  5. When the view is created double-click the name in the panel to change it to something appropriate to your system, in our example we call the view ACME Camera.

    The renamed view

  6. In the System overview panel, expand your recording server node to display Cameras, expand that node and then click and drag the Digital Barriers Ltd. VMS Gateway... camera onto the viewing pane.

    Drag and drop the camera onto the view
  7. When that's done, you should see a still from the current video feed from the camera. You've now finished configuring the view so you can click on the Setup button at the top-right of the screen to exit setup mode.

    A still from the camera feed displayed in the view in setup mode
  8. You should now see the live video stream from the camera overlaid with bounding boxes that show the objects being detected by the Object Detector.

    The video stream overlaid with Object Detector metadata bounding boxes.

Searching using the metadata

It's really useful to be able to search the video stream using the metadata, because it allows you to focus on just the moments where something is happening. Having configured the system earlier to allow search using the Object Detector metadata you should now be able to search on the People and Vehicle detection events.

  1. Click on the Search tab. All of your searches are configured here.

    The Search tab

  2. Click on Select camera.... You need to select the camera you are interested in searching.

    Click on Select camera...

  3. Select the Digital Barriers Ltd. VMS Gateway... camera. You will need to select the VOD camera with the metadata.

    Select the Digital Barriers camera

  4. Click on the Search for... button. You next need to select the type of metadata you want to search for.

    Click on the Search for... button

  5. Select the People metadata option and then click New search. This will constrain the search results to just those events where People were detected.

  6. The search results in a number of events where People have been detected. Clicking on one of these results, displays the video sequence associated with that occurrence.

  7. To search for vehicles instead, click the Search for... button, select Vehicles and then click New search.

  8. This search results in a number of events where Vehicles have been detected, clicking on one of these shows the video sequence related to that event.

Conclusion

In this article we've shown how to use Milestone XProtect Management Client to:

  • Get both video and analytics data from a VOD into Milestone XProtect.

  • Enable metadata search for the analytics data.

We've also shown how to use Milestone XProtect Smart Client to:

  • Configure a view to display the video stream from a VOD with the analytics object detection boxes overlay.

  • Perform metadata search to pinpoint object detection events and view the related video sequences.

Did this answer your question?