Pelco Developer Network (PDN)

Recommendations for Endura integration using the Pelco SDK

Starting Endura integration with PELCO SDK

The Pelco SDK pre-packages various functions, called components, to simplify integrating with the Endura video management system. As of version 3.0, the Pelco SDK also provides the Object Model to define a set of classes that make it even easier to integrate Pelco devices in your applications.

Object Model classes represent pieces of a Pelco video management system, such as cameras and other devices, and Pelco VMS products such as Endura, Pelco Aggregation, and Digital Sentry. Additional classes represent common functionality such as the Stream class to stream live and play recorded video. For more information, see the Pelco SDK Object Model.

Components include the System Manager Wrapper, Pelco API Viewer, PTZ Control Wrapper, Exporter, Metadata Parser, Event Arbiter and Event Manager.

Endura Permissions Required for SDK Integration

It is recommended that you use an administrator account when connecting to Endura for integration purposes. However, if you want to use a limited account for Endura integrations, the user must possess the following permissions for all devices:

  • System: View System Configuration
  • System: Search and Playback
  • System: Monitor Live Video

You must configure Endura users through the Endura Workstation software (WS5200). For SDK versions 3.4 and earlier, when attempting to perform device collection with a user account assigned a role containing access to individual devices, as opposed to all devices, device collection will fail.

Using the Pelco SDK Object Model Classes

To integrate with Pelco devices using classes, the first step is to connect to a video management system and get a list of available devices. You accomplish this by creating an instance of the System object. Then, create Camera, Display, and Stream objects to identify the video source, the monitor to display the video, and a stream to play live and recorded video.

Using the Pelco SDK Components

To integrate with Endura using components, the process is the same as with Object Model classes, but requires more coding. Start out by using the System Manager Wrapper to list all the Endura devices present in the system and begin communicating with them. Then, use the Pelco API Viewer to manage live streaming and playback from Pelco devices using RTP or RTSP.

Other Pelco API SDK components can then be used in your applications such as the PTZ Control Wrapper, Export, Event Arbiter Library, and Event Manager.

Using the Pelco API with Pelco SDK

To use the Pelco SDK with Pelco API implementations, no changes should be necessary since the use of the Pelco SDK does not impact the Pelco API. The Pelco SDK may help simplify your integration development, rather than developing directly against the Pelco API.

To implement some features, you may need to use the Pelco API in addition to the Pelco SDK.

Upgrading from a previous SDK version

Make sure that you uninstall the previous version of the Pelco SDK before installing the latest version as described in the SDK Quick Start Guide. With each version, the Pelco SDK implements new features but maintains backward compatibility. To learn more about the Pelco SDK, see Pelco SDK Programming Guide.