ZoomSDKCameraControlHelper Class Reference

Provides APIs to control the remote camera, including pan, tilt, and zoom operations. More...

#include <ZoomSDKCameraControlHelper.h>

Inherits NSObject.

Instance Methods
(unsigned int)	- getUserId
	Gets the controlled user ID.
(BOOL)	- canControlCamera
	Determines whether the camera can be controlled or not.
(ZoomSDKError)	- requestControlRemoteCamera
	Request to control remote camera.
(ZoomSDKError)	- giveUpControlRemoteCamera
	Give up control of the remote camera.
(ZoomSDKError)	- turnLeft:
	Turn the camera to the left.
(ZoomSDKError)	- turnRight:
	Turn the camera to the right.
(ZoomSDKError)	- turnUp:
	Turn the camera up.
(ZoomSDKError)	- turnDown:
	Turn the camera down.
(ZoomSDKError)	- zoomIn:
	Zoom the camera in.
(ZoomSDKError)	- zoomOut:
	Zoom the camera out.

Detailed Description

Provides APIs to control the remote camera, including pan, tilt, and zoom operations.

Definition at line 14 of file ZoomSDKCameraControlHelper.h.

Method Documentation

canControlCamera

- (BOOL) canControlCamera

Determines whether the camera can be controlled or not.

Returns

YES if the camera can be controlled. Otherwise, NO.

References canControlCamera.

Referenced by canControlCamera.

getUserId

- (unsigned int) getUserId

Gets the controlled user ID.

Returns

If the function succeeds, it returns the user ID. Otherwise return 0.

References getUserId.

Referenced by getUserId.

giveUpControlRemoteCamera

- (ZoomSDKError) giveUpControlRemoteCamera

Give up control of the remote camera.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References giveUpControlRemoteCamera.

Referenced by giveUpControlRemoteCamera.

requestControlRemoteCamera

- (ZoomSDKError) requestControlRemoteCamera

Request to control remote camera.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References requestControlRemoteCamera.

Referenced by requestControlRemoteCamera.

turnDown:

- (ZoomSDKError) turnDown:

(int)

range

Turn the camera down.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

turnLeft:

- (ZoomSDKError) turnLeft:

(int)

range

Turn the camera to the left.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

turnRight:

- (ZoomSDKError) turnRight:

(int)

range

Turn the camera to the right.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

turnUp:

- (ZoomSDKError) turnUp:

(int)

range

Turn the camera up.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

zoomIn:

- (ZoomSDKError) zoomIn:

(int)

range

Zoom the camera in.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

zoomOut:

- (ZoomSDKError) zoomOut:

(int)

range

Zoom the camera out.

Parameters

range

Rotation range, between 10 to 100.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.