Represents a controller for a device that has pan, tilt, and/or zoom functionality. More...

#include <IVxPtzController.h>

Public Member Functions
virtual VxResult::Value	AbsoluteMove (int positionX, int positionY) const =0
	Moves to the absolute position of the given coordinates. More...

virtual VxResult::Value	AbsoluteMove (int positionX, int positionY, int positionZ) const =0
	Moves to the absolute position of the given coordinates. More...

virtual VxResult::Value	AbsolutePan (int positionX) const =0
	Pans to the absolute position of the given coordinate. More...

virtual VxResult::Value	AbsoluteTilt (int positionY) const =0
	Tilts to the absolute position of the given coordinate. More...

virtual VxResult::Value	AbsoluteZoom (int positionZ) const =0
	Zooms to the absolute position of the given coordinates. More...

virtual VxResult::Value	AddPreset (int index) const =0
	Creates a new preset using the current PTZ spatial coordinates. More...

virtual VxResult::Value	ContinuousFocus (VxFocusDirection::Value nearFar) const =0
	Continuously focuses near or far. More...

virtual VxResult::Value	ContinuousIris (VxIrisDirection::Value openClose) const =0
	Continuously opens or closes the iris. More...

virtual VxResult::Value	ContinuousMove (int speedX, int speedY, VxZoomDirection::Value inOut) const =0
	Continuously moves the field of view at the given speed until stopped. More...

virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeletePreset (IVxPreset &preset) const =0
	Deletes a preset from the system. More...

virtual VxResult::Value	GetPatterns (VxCollection< IVxPattern ** > &patternCollection) const =0
	Gets the available patterns. More...

virtual VxResult::Value	GetPosition (int &positionX, int &positionY, int &positionZ) const =0
	Gets the current absolute position coordinates. More...

virtual VxResult::Value	GetPresets (VxCollection< IVxPreset ** > &presetCollection) const =0
	Gets the available presets. More...

virtual VxResult::Value	GetPtzLimits (VxPtzLimits *&ptzLimits) const =0
	Gets the value limits for this PTZ controller. More...

virtual VxResult::Value	GetPtzLock (IVxPtzLock *&ptzLock) const =0
	Gets the IVxPtzLock for this IVxPtzController. More...

virtual VxResult::Value	PtzStop () const =0
	Stops all PTZ actions. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	RelativeMove (int deltaX, int deltaY, int deltaZ) const =0
	Moves the camera position relative to the current position. More...

virtual VxResult::Value	RelativePercentageMove (int percentageX, int percentageY) const =0
	Moves the camera position within a percentage relative to the device�s current field of view. More...

virtual VxResult::Value	RepositionPreset (IVxPreset &preset) const =0
	Repositions a preset to the current PTZ spatial coordinates. More...

virtual VxResult::Value	TriggerPattern (IVxPattern &pattern) const =0
	Triggers a pattern. More...

virtual VxResult::Value	TriggerPreset (int index) const =0
	Triggers a preset by index. More...

virtual VxResult::Value	TriggerPreset (IVxPreset &preset) const =0
	Triggers a preset. More...

virtual VxResult::Value	TriggerRefresh ()=0
	Triggers a refresh of this IVxPtzController on the VideoXpert system; updating its patterns and presets based on the current camera configuration. More...

Public Attributes
bool	isLocked
	Indicates whether the PTZ control is locked. More...

int	lockExpireTime
	The time remaining (in seconds) until the PTZ lock expires. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a controller for a device that has pan, tilt, and/or zoom functionality.

Definition at line 17 of file IVxPtzController.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxPtzController::AbsoluteMove	(	int	positionX,
		int	positionY
	)		const

pure virtual

Moves to the absolute position of the given coordinates.

Parameters

positionX	The X coordinate absolute position (pan).
positionY	The Y coordinate absolute position (tilt).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::AbsoluteMove	(	int	positionX,
		int	positionY,
		int	positionZ
	)		const

pure virtual

Moves to the absolute position of the given coordinates.

Parameters

positionX	The X coordinate absolute position (pan).
positionY	The Y coordinate absolute position (tilt).
positionZ	The Z coordinate absolute position (zoom).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::AbsolutePan ( int positionX ) const

pure virtual

Pans to the absolute position of the given coordinate.

Parameters

positionX The X coordinate absolute position (pan).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::AbsoluteTilt ( int positionY ) const

pure virtual

Tilts to the absolute position of the given coordinate.

Parameters

positionY The Y coordinate absolute position (tilt).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::AbsoluteZoom ( int positionZ ) const

pure virtual

Zooms to the absolute position of the given coordinates.

Parameters

positionZ The Z coordinate absolute position (zoom).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::AddPreset ( int index ) const

pure virtual

Creates a new preset using the current PTZ spatial coordinates.

Parameters

index The unique index value for the new preset.

Returns: The Result of the request.

void VxSdk::IVxPtzController::Clear ( )

inlineprotected

Clears this instance.

Definition at line 203 of file IVxPtzController.h.

                      {
             this->isLocked = false;
             this->lockExpireTime = 0;
         }

virtual VxResult::Value VxSdk::IVxPtzController::ContinuousFocus ( VxFocusDirection::Value nearFar ) const

pure virtual

Continuously focuses near or far.

Parameters

nearFar The direction to focus.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::ContinuousIris ( VxIrisDirection::Value openClose ) const

pure virtual

Continuously opens or closes the iris.

Parameters

openClose The direction to change the iris.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::ContinuousMove	(	int	speedX,
		int	speedY,
		VxZoomDirection::Value	inOut
	)		const

pure virtual

Continuously moves the field of view at the given speed until stopped.

Parameters

speedX	Pan speed. Negative values pan left, positive values pan right.
speedY	Tilt speed. Negative values tilt downward, positive values tilt upward.
inOut	The direction to zoom.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxPtzController::DeletePreset ( IVxPreset & preset ) const

pure virtual

Deletes a preset from the system.

Parameters

preset The IVxPreset to delete.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::GetPatterns ( VxCollection< IVxPattern ** > & patternCollection ) const

pure virtual

Gets the available patterns.

Available filters: kModifiedSince.

Parameters

patternCollection A VxCollection of the associated patterns.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::GetPosition	(	int &	positionX,
		int &	positionY,
		int &	positionZ
	)		const

pure virtual

Gets the current absolute position coordinates.

Parameters

positionX	The X coordinate absolute position (pan).
positionY	The Y coordinate absolute position (tilt).
positionZ	The Z coordinate absolute position (zoom).

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::GetPresets ( VxCollection< IVxPreset ** > & presetCollection ) const

pure virtual

Gets the available presets.

Available filters: kModifiedSince.

Parameters

presetCollection A VxCollection of the associated presets.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::GetPtzLimits ( VxPtzLimits *& ptzLimits ) const

pure virtual

Gets the value limits for this PTZ controller.

Parameters

ptzLimits The PTZ limits.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::GetPtzLock ( IVxPtzLock *& ptzLock ) const

pure virtual

Gets the IVxPtzLock for this IVxPtzController.

Parameters

ptzLock The IVxPtzLock.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::PtzStop ( ) const

pure virtual

Stops all PTZ actions.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxPtzController::RelativeMove	(	int	deltaX,
		int	deltaY,
		int	deltaZ
	)		const

pure virtual

Moves the camera position relative to the current position.

Parameters

deltaX	The degree to pan relative to the current X position. Negative values pan left, positive values pan right.
deltaY	The degree to tilt relative to the current Y position. Negative values pan left, positive values pan right.
deltaZ	The magnification level relative to the current Z position. Negative values pan left, positive values pan right.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::RelativePercentageMove	(	int	percentageX,
		int	percentageY
	)		const

pure virtual

Moves the camera position within a percentage relative to the device�s current field of view.

The rotational x and y parameters are used to move within a percentage of the current field of view of the camera. For instance, if the x parameter were 50 and the y parameter were -50, the pan/tilt would move halfway to the edge of the field of view along the x axis and halfway to the field of view along the negative y axis from its present position.

Parameters

percentageX	Percentage of the current field of view of the camera (X axis). Positive values are to the right, negative values are to the left. Range: -100 to 100.
percentageY	Percentage of the current field of view of the camera (Y axis). Positive values are up, negative values are down. Range: -100 to 100.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::RepositionPreset ( IVxPreset & preset ) const

pure virtual

Repositions a preset to the current PTZ spatial coordinates.

Parameters

preset The IVxPreset to reposition.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::TriggerPattern ( IVxPattern & pattern ) const

pure virtual

Triggers a pattern.

Parameters

pattern The IVxPattern to trigger.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::TriggerPreset ( int index ) const

pure virtual

Triggers a preset by index.

Parameters

index The index of the preset to trigger.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::TriggerPreset ( IVxPreset & preset ) const

pure virtual

Triggers a preset.

Parameters

preset The IVxPreset to trigger.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzController::TriggerRefresh ( )

pure virtual

Triggers a refresh of this IVxPtzController on the VideoXpert system; updating its patterns and presets based on the current camera configuration.

Returns: The Result of refreshing the IVxPtzController.

Member Data Documentation

bool VxSdk::IVxPtzController::isLocked

Indicates whether the PTZ control is locked.

Definition at line 193 of file IVxPtzController.h.

int VxSdk::IVxPtzController::lockExpireTime

The time remaining (in seconds) until the PTZ lock expires.

Definition at line 197 of file IVxPtzController.h.

The documentation for this struct was generated from the following file:

C:/Git/VXSDK_M3/VxSdk/Include/IVxPtzController.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation