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
	Gets the current controlled user ID.
(BOOL)	- canControlCamera
	Determines whether the camera can be controlled or not.
(MobileRTCSDKError)	- requestControlRemoteCamera
	Requests to control the remote camera.
(MobileRTCSDKError)	- giveUpControlRemoteCamera
	Gives up control of the remote camera.
(MobileRTCSDKError)	- turnLeft:
	Turns the camera to the left.
(MobileRTCSDKError)	- turnRight:
	Turns the camera to the right.
(MobileRTCSDKError)	- turnUp:
	Turns the camera up.
(MobileRTCSDKError)	- turnDown:
	Turns the camera down.
(MobileRTCSDKError)	- zoomIn:
	Zooms the camera in.
(MobileRTCSDKError)	- zoomOut:
	Zooms 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 50 of file MobileRTCCameraControlService.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, delegate, getUserId, giveUpControlRemoteCamera, and requestControlRemoteCamera.

Referenced by canControlCamera.

getUserId

- (NSInteger) getUserId

Gets the current controlled user ID.

Returns

The current controlled user ID.

Referenced by canControlCamera.

giveUpControlRemoteCamera

- (MobileRTCSDKError) giveUpControlRemoteCamera

Gives up control of the remote camera.

Returns

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

Referenced by canControlCamera.

requestControlRemoteCamera

- (MobileRTCSDKError) requestControlRemoteCamera

Requests to control the remote camera.

Returns

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

Referenced by canControlCamera.

turnDown:

- (MobileRTCSDKError) turnDown:

(NSInteger)

range

Turns the camera down.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

turnLeft:

- (MobileRTCSDKError) turnLeft:

(NSInteger)

range

Turns the camera to the left.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

turnRight:

- (MobileRTCSDKError) turnRight:

(NSInteger)

range

Turns the camera to the right.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

turnUp:

- (MobileRTCSDKError) turnUp:

(NSInteger)

range

Turns the camera up.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

zoomIn:

- (MobileRTCSDKError) zoomIn:

(NSInteger)

range

Zooms the camera in.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

zoomOut:

- (MobileRTCSDKError) zoomOut:

(NSInteger)

range

Zooms the camera out.

Parameters

range

Rotation range, range is between 10 and 100.

Returns

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

Property Documentation

delegate

- (id<MobileRTCCameraControlDelegate> _Nullable) delegate

readwritenonatomicweak

Callback event of receiving camera control.

Definition at line 55 of file MobileRTCCameraControlService.h.

Referenced by canControlCamera.