03/2016PLUG-IN GUIDE

VideoXpert OCC Popup On Alarm Plug-in Guide

Contents

Overview of the Popup On Alarm Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Pre-requisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Limitations and Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Installing the Popup On Alarm Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Uninstalling the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Running the Popup On Alarm Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Running the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Event List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Appendix: Ops Center Client Plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Overlay Plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Additional Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1

Overview of the Popup On Alarm Plug-inThe Popup On Alarm plug-in for Ops Center Client (OCC) automatically displays video when events are received for associated devices.

This guide shows how to install and run the Popup On Alarm plug-in for Pelco VideoXpert.

FeaturesThe Popup On Alarm plug-in supports the following features:

• It subscribes to all Situations and waits for corresponding events on all available devices/cameras

• On receiving an event, the event details are added to the list in the plug-in and the live video display launches on screen

• On shutdown, the plug-in will unsubscribe from all Situations

Pre-requisitesThe Popup On Alarm plug-in requires the following:

• VideoXpert 1.9 or higher

Limitations and Known IssuesThe This version of the Popup On Alarm plug-in has the following limitations:

• Subscribes to all events. There is no option to unsubscribe from specific events.

• Only shows live, not recorded, video on receiving an event.

Installing the Popup On Alarm Plug-inInstallation

Download the plug-in installer and double-click on it to start the installation process.

Follow the prompts of the plug-in installer.

There are no user-configurable options so the installation should proceed until complete.

When the installation completes press Finish to dismiss the installer.

2

All plug-in files are placed in C:\ProgramData\Pelco\OpsCenter\Plugins\Pelco\PopOnAlarm.

There is no configuration required for the plug-in.

Uninstalling the Plug-inThe plug-in can be uninstalled via the Programs and Features section of the Windows Control Panel.

3

Running the Popup On Alarm Plug-inRunning the Plug-in

Once installed, the Popup On Alarm plug-in appears in the VideoXpert list of Content plug-ins. To launch the plug-in, click on Plug-ins > Content in the OCC Mission Control dialog.

The Popup On Alarm plug-in can be dragged into any Ops Center cell.

4

Event ListEvents received by the plug-in are displayed in a table in the cell.

5

Appendix: Ops Center Client Plug-insThe Pelco VideoXpert Ops Center provides a dynamic user interface that allows you to customize the workspace to suit your needs. For example, you can display a 2x2 arrangement of video streams and third party plug-ins. These plug-ins may stand alone in the cell or overlay the video stream. Stand alone plug-ins are "Applet" plug-ins; those that share space with a video stream are "Overlay" plug-ins.

The figure below shows the Ops Center with the “Prime” window on the left. The Prime window contains the Video Source (camera) list, dropdown menus that list available plug--ins, and buttons for creating workspaces and desktops. To the right of the Prime window is a 4up “Workspace” containing four “Cells”. Each Cell may contain one of the following

• an Applet plug-in

• a video stream

• an Overlay plug-in AND a video stream

In the Ops Center instance shown below, the upper-left cell contains an Applet plug-in (specifically, a map), while the lower-left cell contains a video stream from one of the listed cameras along with an Overlay plug-in.

Overlay Plug-insA plug-in may be configured to be an Overlay. An Overlay plug-in occupies the same cell as a video stream. An Overlay is intended to annotate the video stream in some way. The overlay may contain scrolling text, buttons, a title, flyout menu, and so on. Refer to the Overlay Plug-In Guidelines for content and style details.

In the following figure an Overlay plug-in is aligned on the right side of the cell.

6

Additional FeaturesOther features of the plug-in architecture and deployment environment include:

• Lightweight security. A plug-in is required to provide a "key", issued by Pelco, when requested by the Ops Center during launch. The use of keys is intended to help Pelco to work more closely with plug-in providers and to discourage unauthorized plug-ins. Plug-ins without a valid key will not be launched by the Ops Center.

• Discovery. Plug-ins are discovered by the Ops Center using .NET reflection.

• Easy installation. To install a plug-in, the DLL or EXE must be copied to a directory beneath the “Plugins” directory for the Ops Center Client. The location pointing to the installation directory for the Ops Center Client will be stored in a registry key. A plug-in provider (company) can create its own subfolder and a folder for each plug-in.

• Temporary data. A plug-in may use a directory that it creates to store temporary data while the plug-in is running.

• Persistent configuration. The Ops Center supports saving plug-in state as part of saving a workspace. If the workspace is opened again at some time in the future or on some other Ops Center, the Ops Center will pass to the plug-in the state data that it retrieved earlier. The plug-in can then apply the state that was passed.

7

Pelco, the Pelco logo, and other trademarks associated with Pelco products referred to in this publication are trademarks of Pelco, Inc. or its affiliates. © Copyright 2015, Pelco, Inc. ONVIF and the ONVIF logo are trademarks of ONVIF Inc. All other product names and services are the property of their respective companies. All rights reserved.Product specifications and availability are subject to change without notice.

Pelco by Schneider Electric3500 Pelco Way Clovis, California 93612 USA(800) 289-9100 Tel (800) 289-9150 Fax+1 (559) 292-1981 International Tel+1 (559) 348-1120 International Faxwww.pelco.com