Pelco SDK Migration Guide
This document provides recommendations for integration developers who use a version of the Pelco SDK earlier than 4.0.
Pelco SDK 3.0 introduced an Object Model that reduced reliance on the pre-built components in the SDK. Subsequent releases expand the functionality of the Object Model. The language support has not changed; the SDK directly supports C# and C++.
SDK 4.0 removes all of the pre-built components and replaces them with Object Model equivalents.
The following chart lists the SDK components, their Object Model equivalents, and the SDK version in which the Object(s) first appeared.
|Capability||SDK 2.x Component||SDK 4.x Object Model Equivalent||SDK Version|
|View Video||API Viewer||A combination of Display, Stream, and Camera objects||3.1|
|Pan-Tilt-Zoom||PTZ wrapper||PTZ object||4.0|
|Export Video||Endura Exporter||Exporter and Clip objects||4.0|
|Motion Detection and other information||Metadata Parser||No direct replacement but some information is available using the MediaFrame class.||4.0|
|Event Notification||Event Manager||The various Event classes||4.0|
|Event Arbiter||The various Event classes||4.0|
|Device and Service Discovery||SM Wrapper||The System Object and its internal system/device cache, and the Device object.||3.0|
|RTSP Streaming||RTSP Server||The Object Model selects a default method of transport that can be modified by the developer. RTSP is one option.||3.1|
|Manage Device Cache||N/A||Administrator object||3.4|
|Display video on a network monitor||N/A||NetworkDisplay, Channel, and Camera objects||3.2|
Upgrading from a Previous SDK Version
Uninstall the previous version of the SDK, then install the latest version as described in the SDK documentation. Refer to the version release notes and the Pelco SDK Programming Guide for details. Existing integrations may require modification and rebuilding after installing SDK 4.0.
Using the Pelco API
For Pelco API implementations, no changes should be necessary since the use of the Pelco SDK does not impact use of the Pelco API. Both may be used in the same application. The Pelco SDK may simplify integration development compared to developing solely with the Pelco API.