Nx Witness VMS Developer Tools


A brief overview of the FREE developer tools for Nx Witness VMS - and some examples of what you can build with them.

Video Source SDK

Integrate 3rd party IP Video devices and archives – including IP cameras, DVRs, NVRs, I/O Devices, and Audio interfaces.

Metadata SDK

Create Plugins to seamlessly integrate object-oriented video analytics – with bounding boxes, metadata tags, and more.

Storage SDK

Integrate 3rd party storage devices (like Veracity’s Cold Store) and/or cloud-based storage locations for live archiving or backup.

Nx Server API

A RESTful API that enables fast (in minutes!) integration of 3rd party devices and systems using HTTP/S Requests.

Generic Events Generator

Generate CreateEvent API calls (aka “Generic Events”) which can be used to create custom automations in the Rules Engine.

Camera Details Panel

A special panel in the Server Web Client which provides camera ID and stream info that makes it easier to develop integrations.

Zapier

Zapier is a cloud automation service that can be used to integrate Nx Witness with 1000’s of other web-based applications and services.

Video Source SDK


Integrate live or recorded video sources, I/O, and audio devices.

Video Source SDK


The Video Source SDK (Software Developer Kit) enables integration of any video source (live or archived) into the system.

With the SDK it’s possible to create a method for auto-discovering, displaying, analyzing, and recording video from virtually any live or recorded video source – IP Cameras, encoders, NVR’s, DVR’s, and more.

The Video Source SDK also allows for the integration of device I/O’s (inputs & outputs) and 3rd party motion detection metadata.

What can you integrate with the Video Source SDK?


IP Video Sources


The Nx Video Source SDK can be used to integrate 3rd party IP cameras, NVRs, and DVRs with Nx Witness VMS to allow capture, control, management, and even search of device video, I/O, and audio capabilities.

IoT Devices


The Nx Video Source SDK can be used to integrate 3rd party I/O and IoT (Internet of Things) devices, extending an operator’s ability to monitor and control physical devices (lighting, alarm, HVAC, Fire, etc) in a system.

Audio Interfaces


The Nx Video Source SDK can also be used to integrate two way audio devices to capture audio and allow operators to talk through these devices in Nx Witness.


Getting the Video Source SDK

Download & Install Nx Witness VMS

  • Right click on a Server in the Resource Panel of the Nx Desktop client and choose Server Web Page to open the Server Web Admin interface in a browser.
  • Click on the For Developers tab and scroll until you see Video Source SDK.

My Nx

  • The Video Source SDK can also be downloaded at My Nx in the Download section
  • Scroll to the bottom and look for Cross-Platform SDK
  • Click on Video Source SDK to download.

Metadata SDK


The Metadata SDK enables seamless integration of object-driven 3rd party video analytics applications as Plugins.

Metadata SDK


The Metadata SDK is used to create Plugins which are installed on the Nx Server application.

  • Enables seamless integration of object-oriented video analytics into Nx Witness VMS
  • Transmit bounding box and metadata attributes for objects detected into a special object database in Nx Witness VMS
  • Display bounding boxes over live or recorded video
  • Display detected object attributes over live or recorded video
  • Generate custom Plugin Events (e.g. Face Recognized) and Plugin Health Events (e.g. Service disconnected) which can be used by system operators to create automated system reactions in the Rules Engine.
  • Create Config Panel for users to configure how the two systems link together (optional)

What can you integrate with the Metadata SDK?


Face Recognition


The Metadata SDK can be used to integrate Nx Witness with A.I. powered intelligent video analytics like VisionLabs LUNA identification platform to create hands free high flow access control solutions, blacklist solutions, and more.

Traffic Management


The Nx Metadata SDK can be used to integrate Nx Witness with A.I. powered intelligent automobile recognition solutions – including License Plate Recognition (ALPR, LPR) – to create intelligent parking, automobile tracking, and traffic management solutions.

Behavioral Analytics


The Nx Metadata SDK can also be used to integrate with deep learning solutions which detect and analyze human behavior – e.g. people counting, heat mapping, queue management, fall detection, and even violence detection – like Senturian’s Neurolytics solution.


Getting the Metadata SDK

My Nx

  • The Metadata SDK for the latest release of Nx Witness VMS can be downloaded at My Nx in the Download section
  • Scroll to the bottom and look for Cross-Platform SDK section -> Metadata SDK.

Meta Early Access

Storage SDK


The Storage SDK enables the integration of 3rd party hardware and software based storage solutions.

Storage SDK


The Storage SDK enables the integration of 3rd party storage hardware (like Veracity’s Cold Store hardware) and/or cloud or network-based storage for live archiving or backup of existing captured video.

What can be integrated using the Storage SDK?


Unique Storage Hardware


The Storage SDK can be used to integrate Nx Witness with unique 3rd party storage solutions like Veracity’s Cold Store hardware with its Sequential Filing System and Linear Array of Idle Disks.

Private Cloud Storage


Developers can use the Storage SDK to integrate with private cloud-based storage (e.g. FTP) enabling redundant concurrent recording to offsite storage locations for data continuity and more.

Public Cloud Storage


The Storage SDK can be used to integrate Nx Witness with public cloud storage solutions like Amazon AWS, Microsoft Azure, and Google Cloud.


Getting the Storage SDK

Download & Install Nx Witness VMS

  • Right click on a Server in the Resource Panel of the Nx Desktop client and choose Server Web Page to open the Server Web Admin interface in a browser.
  • Click on the For Developers tab and scroll until you see Storage SDK.

My Nx

  • The Video Source SDK can also be downloaded at My Nx in the Download section
  • Scroll to the bottom and look for Cross-Platform SDK
  • Click on Storage SDK to download.

Nx Server API


The Storage SDK enables easy integration of any potential storage.

Server API


The Nx Witness Server API is a RESTful API that provides developers the ability to access nearly every feature available in the system’s thick client, including – but not limited to – the ability to query/manage system resources (servers, cameras, users), manage users and permissions, pull live or recorded video out of the system, generate events, create rules, control PTZ cameras, and more.

Integrate anything with the Nx Server API.


Access Control & Alarm Systems Integration


The Server API gives developers the ability to pull live or archived video and their related metadata from Nx Witness into 3rd party Access Control / Alarm systems (like ICT Protege) to playback event-driven video.

Health Monitoring / Reporting Platforms


The Server API can also be used to integrate with custom 3rd party health monitoring and reporting solutions like CheckMyCCTV, SmartCloudMonitor or Remote IT.

PSIM Platforms


The Server API gives any PSIM application – like Vidsys –  the ability to integrate seamlessly with Nx Witness VMS to view, monitor, and manage connected devices and their related video.


Accessing the Server API

Download & Install Nx Witness VMS

  • Right click on a Server in the Resource Panel of the Nx Desktop client and choose Server Web Page to open the Server Web Admin interface in a browser.
  • Click on the For Developers tab and scroll until you see Server API.

Access the Server API on the Nx Demo System

  • Head to http://demo.networkoptix.com:7001/ in the browser of your choice
  • Login with the credentials below and click on the For Developers tab
    • Username: demo@networkoptix.com
    • Password: NxDemoUser

HTTP Events & Actions


Create simple, fast integrations with Nx Witness VMS using HTTP Generic Events & Do HTTP Request Actions.

HTTP Events & Actions


Nx Witness can send and receive HTTP or HTTPS requests, allowing fast, simple integrations and automation with any integrated system or device.

What can you integrate quickly using HTTP Events & Actions?


Quick Access Control / Alarm Systems Integrations


Use HTTP Events & Actions to quickly integrate Access Control / Alarm systems to tag critical video events in Nx Witness or trigger system actions and to allow operators to open Access Control doors or trigger alarm system inputs.

Manage & Control IoT Devices


The Do HTTP Request action in the Nx Witness Rules Engine allows developers to quickly integrate with 3rd party IoT devices like GJD’s Clarius lightning devices for seamless control of video-adjacent devices.

Integrate with Building Automation Systems


Combine intelligent video with building automation platforms to reduce energy usage, monitor critical building systems (like HVAC, elevators, escalators, and more), and enhance system operators situational awareness.


Accessing Generic Event Generator & Do HTTP Request Features


First, download & install Nx Witness VMS on a Windows or Ubuntu Linux computer.

Finding the Generic Events Generator:

  • Right click on a Server in the Resource Panel of the Nx Desktop client and choose Server Web Page to open the Server Web Admin interface in a browser.
  • Click on the For Developers tab and scroll until you see Generic Events Generator.

To set up a Do HTTP Request action:

  • Download Nx Witness VMS and open the Nx Desktop client.
  • Check out the Action: Do HTTP Request article in the Nx Support Portal.

Camera Details Panel


A special panel in the Nx Web Client that exposes camera information for developers.

Camera Details Panel


The Camera Details Panel is a special panel in the Nx Web Client (located in the Server Web Page) designed to make it easier for developers to get information about cameras in Nx Witness during integration to 3rd party systems.

The Camera Details Panel exposes camera information to developers in the Nx Server Web Admin interface (Server Web Page).


Camera Name
The name of the camera in Nx Witness VMS.

CameraID
CameraID is a unique identifier for a camera often used in API calls. CameraID can be modified by developers in the Expert Settings tab of the Camera Settings dialog in the Nx Desktop client.

CameraIP Address
The IP Address of the camera (e.g. 192.168.44.15)

Camera Vew
A link to the camera in the Nx Web Client.

Download Links
Direct download links for High / Low res streams with configurable duration (sec) and resolution (e.g. 1080p).

Link Settings
Authentication settings for direct downloads from the Camera Details Panel – temporary key / credentials.

High Res Stream
URL for the camera’s high resolution stream (e.g. 1920 x 1080, 4K)

Trans-coded Streams
URLs for any available trans-coded streams in RTSP, MJPEG, WEBM formats.


Accessing the Camera Details Panel

Download & Install Nx Witness VMS

  • Right click on a Server in the Resource Panel of the Nx Desktop client and choose Server Web Page to open the Server Web Admin interface in a browser.
  • Click on the View tab and choose a camera to view
  • Click on the settings icon (upper right hand cog on the camera) and select Camera Details.

Integrate with Zapier


Connect thousands of applications and automate workflows.

What is Zapier?

Zapier is an online automation tool that connects your favorite apps, such as Gmail, Slack, Mailchimp, and over 1,500 more. You can connect two or more apps to automate repetitive tasks without coding or relying on developers to build the integration. It’s easy enough that anyone can build their own app workflows with just a few clicks.

Automate Anything with Zapier


Sign Up

Sign Up to Zapier and click on this link to access the Nx Cloud Zapier invite (still in Beta mode!).

Check out an Example

We put together a little video to show how you can integrate your Nx Witness system with Zapier.

Create your own Zap

Check out the 1500+ different web apps that you can integrate with Zapier - and create your own automation.