Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKCameraControlHelper Class Reference

#include <ZoomSDKCameraControlHelper.h>

Inherits NSObject.

Instance Methods

(unsigned int) - getUserId
 Gets the controlled user ID.
 
(BOOL) - canControlCamera
 Determine 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

Definition at line 5 of file ZoomSDKCameraControlHelper.h.

Method Documentation

◆ canControlCamera

- (BOOL) canControlCamera

Determine whether the camera can be controlled or not.

Returns
YES means that the camera can be controlled.

◆ getUserId

- (unsigned int) getUserId

Gets the controlled user ID.

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

◆ giveUpControlRemoteCamera

- (ZoomSDKError) giveUpControlRemoteCamera

Give up control of the remote camera.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ requestControlRemoteCamera

- (ZoomSDKError) requestControlRemoteCamera

Request to control remote camera.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ turnDown:

- (ZoomSDKError) turnDown: (int) range

Turn the camera down.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ turnLeft:

- (ZoomSDKError) turnLeft: (int) range

Turn the camera to the left.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ turnRight:

- (ZoomSDKError) turnRight: (int) range

Turn the camera to the right.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ turnUp:

- (ZoomSDKError) turnUp: (int) range

Turn the camera up.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ zoomIn:

- (ZoomSDKError) zoomIn: (int) range

Zoom the camera in.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ zoomOut:

- (ZoomSDKError) zoomOut: (int) range

Zoom the camera out.

Parameters
rangeRotation range, between 10 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.