MobileRTCCameraControlService Class Reference

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

#include <MobileRTCCameraControlService.h>

Inherits NSObject.

Instance Methods
(NSInteger)	- getUserId
	The current controlled user id.
(BOOL)	- canControlCamera
	Used to determine whether the camera can be controlled or not.
(MobileRTCSDKError)	- requestControlRemoteCamera
	Request to control remote camera.
(MobileRTCSDKError)	- giveUpControlRemoteCamera
	Give up control of the remote camera.
(MobileRTCSDKError)	- turnLeft:
	Turn the camera to the left.
(MobileRTCSDKError)	- turnRight:
	Turn the camera to the right.
(MobileRTCSDKError)	- turnUp:
	Turn the camera up.
(MobileRTCSDKError)	- turnDown:
	Turn the camera down.
(MobileRTCSDKError)	- zoomIn:
	Zoom the camera in.
(MobileRTCSDKError)	- zoomOut:
	Zoom the camera out.

Properties
id< MobileRTCCameraControlDelegate > _Nullable	delegate
	Callback event of receiving camera control.

Detailed Description

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

Definition at line 53 of file MobileRTCCameraControlService.h.

Method Documentation

canControlCamera

- (BOOL) canControlCamera

Used to determine whether the camera can be controlled or not.

Returns

YES means can control camera.

References canControlCamera, delegate, getUserId, giveUpControlRemoteCamera, and requestControlRemoteCamera.

Referenced by canControlCamera.

getUserId

- (NSInteger) getUserId

The current controlled user id.

Returns

The current controlled user id.

Referenced by canControlCamera.

giveUpControlRemoteCamera

- (MobileRTCSDKError) giveUpControlRemoteCamera

Give up control of the remote camera.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

Referenced by canControlCamera.

requestControlRemoteCamera

- (MobileRTCSDKError) requestControlRemoteCamera

Request to control remote camera.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

Referenced by canControlCamera.

turnDown:

- (MobileRTCSDKError) turnDown:

(NSInteger)

range

Turn the camera down.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

turnLeft:

- (MobileRTCSDKError) turnLeft:

(NSInteger)

range

Turn the camera to the left.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

turnRight:

- (MobileRTCSDKError) turnRight:

(NSInteger)

range

Turn the camera to the right.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

turnUp:

- (MobileRTCSDKError) turnUp:

(NSInteger)

range

Turn the camera up.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

zoomIn:

- (MobileRTCSDKError) zoomIn:

(NSInteger)

range

Zoom the camera in.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

zoomOut:

- (MobileRTCSDKError) zoomOut:

(NSInteger)

range

Zoom the camera out.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

If the function succeeds, the return value is MobileRTCSDKError.

Property Documentation

delegate

- (id<MobileRTCCameraControlDelegate> _Nullable) delegate

readwritenonatomicweak

Callback event of receiving camera control.

Definition at line 58 of file MobileRTCCameraControlService.h.

Referenced by canControlCamera.