Introduction to the NiceVision SDK

Transcription

1 INSIGHT FROM INTERACTIONS Solution Overview Introduction to the NiceVision SDK Revision: 1.0 All contents of this document are: Copyright 2009 NICE Systems Ltd. All rights reserved.

2 Table of Contents 1. Overview The Player Component The Database API The Core API How Can the NiceVision SDK Be Used? NiceVision Application Suite Front-End rd Party Software Front-end Supported Features Supported Technologies NiceVision SDK Package Contents Support... 5 Introduction to the NiceVision SDK

3

4 1. Overview The NiceVision SDK is a Software Development Kit that enables developers to connect and interact with NiceVision system components. The NiceVision SDK is composed of the following Application Programming Interfaces (API): 1.1 The Player Component The player component is exposed as a powerful ActiveX control representing a channel, and enables your application to get video and audio streams (live and playback) as well as other channel-related operations such as PTZ control and Level of Service. 1.2 The Database API The Database API is exposed as a.net assembly that enables your application to retrieve configuration data from the NiceVision Database, such as the list of servers, channels, etc. 1.3 The Core API The Core API is a low-level native API that enables working directly with a Recorder, retrieving information and performing operations on the Recorder and its internal entities, such as its channels and triggers. 2. How Can the NiceVision SDK Be Used? NiceVision SDK supports the most common integration scenarios: 2.1 NiceVision Application Suite Front-End With NiceVision Application Suite at the front-end, it is possible to receive data from the NiceVision system (e.g. statuses, triggers, alarms) and send commands to the NiceVision system (e.g. control PTZ, change recording setup). In addition it is possible to activate NiceVision triggers, which can execute NiceVision automatic tasks (such as event recording, pop-up video, execute a macro etc) rd Party Software Front-end With 3 rd part software at the front-end, the most common capability required is showing live and playback video. In addition it is possible to send triggers, alarms, send commands such as PTZ control etc.

5 3. Supported Features Examples for features that the NiceVision SDK supports: Alarm Integration: 3rd party systems can send/receive alarms to/from NiceVision using the API trigger. Live Video Integration: View live video in 3rd party applications. Recorded Video Integration: Show video playback upon alarm in 3rd party applications. PTZ Integration: Control PTZ cameras, from 3 rd party client applications or from a server module. Video Analytics Integration: 3 rd party systems can receive a video analytics alarm. VMX Integration: o Show any camera (live/playback) on any monitor (NVD1002/NVD5004). o Send API trigger - The API trigger can be pre-configured via SiteBuilder to activate a Tour, Salvo or Macro. Raw Video Integration: 3 rd party systems can receive standard MPEG4 video over UDP unicast or multicast using Automatic Streaming. Decoded Video Frames Integration: 3 rd party systems can receive RGB/YUV/JPEG frames for showing video in their own player. Note: Can be used as bridge between different operating systems. HTML Solution: 3 rd party systems can wrap NiceVision s Player ActiveX with another ActiveX supporting the browser environment. 4. Supported Technologies The NiceVision SDK is windows based and supports Windows platforms. The player component is exposed as an ActiveX control and can be used in COM-client environments. This component can be wrapped with a Java COM wrapper to be used in a Java environment. The Database API is a.net dll which can be exposed as a COM object. The Core API is C++ based and can be used in all C++ supported environments. 5. NiceVision SDK Package Contents The SDK package includes the following: Binary files for the 3 SDK components for all supported languages (dll, tlb, lib, Borland lib). Comprehensive help files. C++ and C# source code samples for common integration scenarios. Working sample executables for all code samples. A redistributable package of the binary files for end-user installation. Release notes with details regarding SDK installation, file names, new features, etc.

6 6. Support When developing using a complicated system and environment such as NiceVision's, developers might confront issues which are not covered by the provided code samples and help files. NiceVision has SDK experts available for answering SDK related technical questions through the following address: NV.SDK@nice.com.