Pelco VideoXpert

The Pelco VideoXpert integrated system provides camera integration.

Definitions

Pan-Tilt-Zoom (PTZ) — A camera that is capable of remote directional and zoom control.

SSL — Secure Socket Layer. An SSL certificate is used to encrypt the connection to a server.

Setup

See the Data Servers page for information on configuring driver communication.

Note: Asset Multi-Select is not available for this integrated system.

Compatibility

The Pelco VideoXpert integrated system is compatible with software version 2.X.

Prerequisites

Software Minimum Version
.NET Framework 4.7.2

When completing your setup, be sure to have the Pelco documentation available for reference.

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required.

Address The IP Address of the Pelco VideoXpert server.
Port The Port number for the Pelco VideoXpert connection.
Username The Username of the desired user to log in as on the Pelco VideoXpert server. This is typically a user created specifically for the Runtime connection.
Password The Password of the desired user to log in as on the Pelco VideoXpert server.
Use SSL Check this box if the API requests are made to a website secured by an SSL certificate.
Note: Red X indicates an invalid or out of range value given for field.

Assets

Camera

This asset represents a camera in the Pelco VideoXpert system.

Required Property Grid Fields

Device Id The unique identifier of the camera.

View all properties

Supported States

No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Acknowledged An asset alarm has been acknowledged.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Recording The asset is recording video.
Motion Detected The asset detects motion.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Start Recording Begin recording with this asset.
Stop Recording Stop recording with this asset.
Trigger Output Activates the Output device.
  • Output Id — The identifier for the Output device being triggered.
Add Bookmark Adds a bookmark for the camera.
Table 1. For PTZ Capable Cameras
Command Description Parameters
Pan/Tilt Moves the camera in a vertical or horizontal direction.
  • Continuous until stop — This checkbox will define if Pan/Tilt commands will move continuously or relatively. Continuous movement will only stop unless instructed or until the camera is no longer capable of continuing to move in a direction.
  • Speed — (For continuous movement) The rate at which the movement will occur.
  • Movement — (For relative movement) The distance at which the movement will occur.
Zoom Focuses the lens to obtain a larger image or closer view.
  • Continuous until stop — This checkbox will define if Zoom commands will move continuously or relatively. Continuous movement will only stop when instructed or until the camera is no longer capable of continuing to move in a direction.
  • Speed — (For continuous movement) The rate at which the movement will occur.
  • Movement — (For relative movement) The distance at which the movement will occur.
PTZ Preset A user-defined location the camera can be pointed at.
  • Preset Number — The identifier for the user-defined preset location.
Stop Movement Stops any vertical or horizontal direction.
Stop Zoom Stops any lens focusing.

See the Command Tables page for more information on configuring command tables.

Input

This asset represents an input in the Pelco VideoXpert system.

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

System Asset

This asset represents the connection state of the system.

View all properties

Supported States

Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Bookmark

Adds a bookmark for a recorded video clip.

Camera Id The unique identifier for the camera.
Bookmark Date The date of the bookmark.
Header The name for the bookmarked timeline.
Description The Description of the bookmarked timeline.

Go To Preset

A user-defined location the camera can be pointed at.

Camera Id The identifier of the camera.
Preset Id The identifier of the user-defined Preset location.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.