Detailed Description

Accessing PTZ on cameras connected to the remote PTZ The PTZ Stream component is used to control steerable cameras that are attached to remote Encoders.

The component provides commands to pan, tilt, zoom, change camera input and go to stored preset positions.

The Encoder supports a wide range of protocols for controlling steerable cameras and performs translation from generic PTZ commands generated by the SDK into the specific protocols required to control the camera. Not all cameras operate the same way, for example some have different numbers of presets available. In this version of the SDK the client application needs to have prior knowledge of the type of camera they are communicating with to know how many camera inputs there are and how many presets are supported by the camera.

Some Encoders may also support Virtual PTZ (VPTZ). This mode allows pan, tilt and zoom operations to occur digitally without requiring that a PTZ camera is connected. The zoom occurs within the image.

The PTZ Stream can only be used by one client application at a time. While the PTZ Stream is held open by one user other users will not be able to open the stream. When designing applications around PTZ please bear this in mind. For example, it may be beneficial to add a feature which will automatically close the PTZ Stream if the user has not used it for a while.

Sample applications

Full sample applications are available demonstrating the capabilities of the SDK

See Sample applications

Files
file	PTZTypes.h

Classes
struct	PTZPresetInfo
	Defines a PTZ Preset. More...

struct	PTZCustomCommand
	Content for PTZ Custom command. More...

struct	PTZTourInfo
	Content of the PTZ Tour. More...

class	EdgeVisDecoderSDK::PTZStream
	The PTZStream is used to send movement commands to a PTZ camera. More...

class	EdgeVisDecoderSDK::VPTZData
	Class describing the are currently being sent as VPTZ. More...

Typedefs
typedef enum PTZSteeringSpeed	PTZSteeringSpeed
	The PTZ steering speed to set the camera to

typedef enum PTZCommandType	PTZCommandType
	PTZ command types for basic PTZ commands (focus, iris, backlight), Custom commands and Aux commands. More...

Enumerations

Typedef Documentation

typedef enum PTZCommandType PTZCommandType

PTZ command types for basic PTZ commands (focus, iris, backlight), Custom commands and Aux commands.

Note that the supported commands depend on the camera PTZ protocol in use.

Enumeration Type Documentation

enum PTZSteeringSpeed

The PTZ steering speed to set the camera to

Enumerator
PTZ_speed_slow	PTZ Slow speed.
PTZ_speed_normal	PTZ Normal speed.
PTZ_speed_fast	PTZ Fast speed.

enum PTZCommandType