Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKRemoteCameraControlHelper Class Reference

Remote camera control helper object interface. More...

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors) - requestControlRemoteCamera
 Requests to control remote camera.
(ZMVideoSDKErrors) - giveUpControlRemoteCamera
 Give up control of the remote camera.
(ZMVideoSDKErrors) - turnLeft:
 Turn the camera to the left.
(ZMVideoSDKErrors) - turnRight:
 Turn the camera to the right.
(ZMVideoSDKErrors) - turnUp:
 Turn the camera up.
(ZMVideoSDKErrors) - turnDown:
 Turn the camera down.
(ZMVideoSDKErrors) - zoomIn:
 Zoom the camera in.
(ZMVideoSDKErrors) - zoomOut:
 Zoom the camera out.

Detailed Description

Remote camera control helper object interface.

Definition at line 343 of file ZMVideoSDKUserHelper.h.

Method Documentation

◆ giveUpControlRemoteCamera

- (ZMVideoSDKErrors) giveUpControlRemoteCamera

Give up control of the remote camera.

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

References giveUpControlRemoteCamera.

Referenced by giveUpControlRemoteCamera.

◆ requestControlRemoteCamera

- (ZMVideoSDKErrors) requestControlRemoteCamera

Requests to control remote camera.

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

References requestControlRemoteCamera.

Referenced by requestControlRemoteCamera.

◆ turnDown:

- (ZMVideoSDKErrors) turnDown: (unsigned int) range

Turn the camera down.

Parameters
rangeRotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ turnLeft:

- (ZMVideoSDKErrors) turnLeft: (unsigned int) range

Turn the camera to the left.

Parameters
rangeThe rotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ turnRight:

- (ZMVideoSDKErrors) turnRight: (unsigned int) range

Turn the camera to the right.

Parameters
rangeRotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ turnUp:

- (ZMVideoSDKErrors) turnUp: (unsigned int) range

Turn the camera up.

Parameters
rangeRotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ zoomIn:

- (ZMVideoSDKErrors) zoomIn: (unsigned int) range

Zoom the camera in.

Parameters
rangeRotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ zoomOut:

- (ZMVideoSDKErrors) zoomOut: (unsigned int) range

Zoom the camera out.

Parameters
rangeRotation range, 10 <= range <= 100.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.