Represents a lock for a PTZ controller. More...

#include <IVxPtzLock.h>

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

virtual VxResult::Value	GetExpireTime (int &expireTime) const =0
	Gets the amount of time (in seconds) that the PTZ lock will be held. More...

virtual VxResult::Value	GetLockState (bool &isLocked) const =0
	Gets the current state of the PTZ lock. More...

virtual VxResult::Value	GetOwner (char *owner, int &size) const =0
	Gets the name of the user that has locked the PTZ controller, if any. More...

virtual VxResult::Value	Lock (int expireTime) const =0
	Locks the PTZ control. 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	Unlock () const =0
	Unlocks the PTZ control. More...

Public Attributes
char	id [64]
	The unique identifier of the PTZ lock. More...

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

Detailed Description

Represents a lock for a PTZ controller.

Definition at line 12 of file IVxPtzLock.h.

Member Function Documentation

void VxSdk::IVxPtzLock::Clear ( )

inlineprotected

Clears this instance.

Definition at line 64 of file IVxPtzLock.h.

                      {
             VxZeroArray(this->id);
         }

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

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxPtzLock::GetExpireTime ( int & expireTime ) const

pure virtual

Gets the amount of time (in seconds) that the PTZ lock will be held.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzLock::GetLockState ( bool & isLocked ) const

pure virtual

Gets the current state of the PTZ lock.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzLock::GetOwner	(	char *	owner,
		int &	size
	)		const

pure virtual

Gets the name of the user that has locked the PTZ controller, if any.

Parameters

owner	The PTZ lock owner.
size	The size of owner .

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzLock::Lock ( int expireTime ) const

pure virtual

Locks the PTZ control.

Parameters

expireTime The amount of time (in seconds) that the PTZ lock will be held. The lock will not expire until it is explicitly unlocked if set to 0.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxPtzLock::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::IVxPtzLock::Unlock ( ) const

pure virtual

Unlocks the PTZ control.

Returns: The Result of the request.

Member Data Documentation

char VxSdk::IVxPtzLock::id[64]

The unique identifier of the PTZ lock.

Definition at line 58 of file IVxPtzLock.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation