MobileRTCRemoteControlService Class Reference

It provides Remote Control Service. More...

#include <MobileRTCRemoteControlService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isHaveRemoteControlRight:
	Queries if the current user has control privilege. You can have this after being assigned to have remote control privilege.
(BOOL)	- isRemoteController:
	Queries if the current user gets remote control privilege.
(MobileRTCRemoteControlError)	- grabRemoteControlView:
	Sets to enable remote control. User should tap the screen icon once received the privilege to control one's screen remotely.
(MobileRTCRemoteControlError)	- remoteControlSingleTap:
	Simulates a mouse click with a finger clicking once on the screen.
(MobileRTCRemoteControlError)	- remoteControlDoubleTap:
	Simulates a mouse double-click with a finger clicking twice successively on the screen.
(MobileRTCRemoteControlError)	- remoteControlLongPress:
	Simulates a mouse right-click with a finger pressing phone screen for more than 3 seconds.
(MobileRTCRemoteControlError)	- remoteControlDoubleScroll:
	Simulates a mouse scroll with two fingers scrolling up and down.
(MobileRTCRemoteControlError)	- remoteControlSingleMove:
	Moves remote cursor by dragging mouse icon on phone screen.
(MobileRTCRemoteControlError)	- remoteControlMouseLeftDown:
	Simulates a mouse left-click with a finger pressing phone screen for more than 3 seconds.
(MobileRTCRemoteControlError)	- remoteControlMouseLeftUp:
	Simulates releasing the left mouse button.
(MobileRTCRemoteControlError)	- remoteControlMouseLeftDrag:
	Simulates a mouse left-click and drag. User clicks the mouse icon on the screen for 3s and drags it.
(MobileRTCRemoteControlError)	- remoteControlCharInput:
	Simulates a keyboard to input text.
(MobileRTCRemoteControlError)	- remoteControlKeyInput:
	Simulates Enter key or delete key of the keyboard.

Properties
id< MobileRTCRemoteControlDelegate > _Nullable	delegate
	The callback event delegate of receiving remote control.

Detailed Description

It provides Remote Control Service.

Note

1.Be assigned be a remote control(Notify by "remoteControlPrivilegeChanged:" check with "isHaveRemoteControlRight").

2.Need to grab the currently control(Call "grabRemoteControl:", check with "isRemoteController").

3.Can do the remote action.

Definition at line 28 of file MobileRTCRemoteControlService.h.

Method Documentation

grabRemoteControlView:

- (MobileRTCRemoteControlError) grabRemoteControlView:

(MobileRTCActiveShareView *_Nonnull)

remoteShareView

Sets to enable remote control. User should tap the screen icon once received the privilege to control one's screen remotely.

Parameters

remoteShareView

The remote shared view.

Returns

The result of grabbing the remote control.

isHaveRemoteControlRight:

- (BOOL) isHaveRemoteControlRight:

(MobileRTCActiveShareView *_Nonnull)

remoteShareView

Queries if the current user has control privilege. You can have this after being assigned to have remote control privilege.

Parameters

remoteShareView

The remote shared view.

Returns

YES if the user got remote control privilege. Otherwise, NO.

Warning

In Zoom UI Mode, if remoteShareView is nil, that means the currently active Zoom Subscribe Share View.

isRemoteController:

- (BOOL) isRemoteController:

(MobileRTCActiveShareView *_Nonnull)

remoteShareView

Queries if the current user gets remote control privilege.

Parameters

remoteShareView

The remote shared view.

Returns

YES if the user got remote control privilege. Otherwise, NO.

Warning

In Zoom UI Mode, if remoteShareView is nil, that means the currently active Zoom Subscribe Share View.

remoteControlCharInput:

- (MobileRTCRemoteControlError) remoteControlCharInput:

(NSString *_Nonnull)

str

Simulates a keyboard to input text.

Parameters

str	The input text from keyboard.

Returns

The result of the operation.

remoteControlDoubleScroll:

- (MobileRTCRemoteControlError) remoteControlDoubleScroll:

(CGPoint)

point

Simulates a mouse scroll with two fingers scrolling up and down.

Parameters

point

It is recommended to pass the arguments: CGPointMake(0, -1) for scrolling up, CGPointMake(0, 1) for scrolling down.

Returns

The result of the operation.

remoteControlDoubleTap:

- (MobileRTCRemoteControlError) remoteControlDoubleTap:

(CGPoint)

point

Simulates a mouse double-click with a finger clicking twice successively on the screen.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

remoteControlKeyInput:

- (MobileRTCRemoteControlError) remoteControlKeyInput:

(MobileRTCRemoteControlInputType)

key

Simulates Enter key or delete key of the keyboard.

Parameters

key	A value of the enumeration of MobileRTCRemoteControlInputType.

Returns

The result of the operation.

remoteControlLongPress:

- (MobileRTCRemoteControlError) remoteControlLongPress:

(CGPoint)

point

Simulates a mouse right-click with a finger pressing phone screen for more than 3 seconds.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

remoteControlMouseLeftDown:

- (MobileRTCRemoteControlError) remoteControlMouseLeftDown:

(CGPoint)

point

Simulates a mouse left-click with a finger pressing phone screen for more than 3 seconds.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

Note

This method is used to simulate a mouse left-click, such as long press on mouse icon.

remoteControlMouseLeftDrag:

- (MobileRTCRemoteControlError) remoteControlMouseLeftDrag:

(CGPoint)

point

Simulates a mouse left-click and drag. User clicks the mouse icon on the screen for 3s and drags it.

Parameters

point

The trajectory of the simulated mouse.

Returns

The result of the operation.

remoteControlMouseLeftUp:

- (MobileRTCRemoteControlError) remoteControlMouseLeftUp:

(CGPoint)

point

Simulates releasing the left mouse button.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

remoteControlSingleMove:

- (MobileRTCRemoteControlError) remoteControlSingleMove:

(CGPoint)

point

Moves remote cursor by dragging mouse icon on phone screen.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

remoteControlSingleTap:

- (MobileRTCRemoteControlError) remoteControlSingleTap:

(CGPoint)

point

Simulates a mouse click with a finger clicking once on the screen.

Parameters

point

The point where user clicks corresponds to the location of the content.

Returns

The result of the operation.

Property Documentation

delegate

- (id<MobileRTCRemoteControlDelegate> _Nullable) delegate

readwritenonatomicweak

The callback event delegate of receiving remote control.

Definition at line 32 of file MobileRTCRemoteControlService.h.