Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCRemoteControlService Class Reference

It provides Remote Control Service. 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. More...

#import <MobileRTCRemoteControlService.h>

Inherits NSObject.

Instance Methods

(BOOL) - isHaveRemoteControlRight
 Query if current user have control privilege. You can have this right after be assigned to the remote control.
 
(BOOL) - isRemoteController
 Query if the current user gets the remote control privilege.
 
(MobileRTCRemoteControlError- grabRemoteControl:
 Set to enable remote control. User should tap the screen icon once received the privilege to control one's screen remotely.

 
(MobileRTCRemoteControlError- remoteControlSingleTap:
 Simulate a mouse click with a finger clicking once on the screen.
 
(MobileRTCRemoteControlError- remoteControlDoubleTap:
 Simulate a mouse double-click with a finger clicking twice successively on the screen.
 
(MobileRTCRemoteControlError- remoteControlLongPress:
 Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds.
 
(MobileRTCRemoteControlError- remoteControlDoubleScroll:
 Simulate a mouse scroll with two fingers scrolling up and down.
 
(MobileRTCRemoteControlError- remoteControlSingleMove:
 Move remote cursor by dragging mouse icon on phone screen.
 
(MobileRTCRemoteControlError- remoteControlMouseLeftDown:
 Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds. This method is used to simulate a mouse left-click, such as long press on mouse icon.
 
(MobileRTCRemoteControlError- remoteControlMouseLeftUp:
 Simulate release the left mouse button.
 
(MobileRTCRemoteControlError- remoteControlMouseLeftDrag:
 Simulate a mouse left-click and drag. User clicks the mouse icon on the screen for 3s and drag it.
 
(MobileRTCRemoteControlError- remoteControlCharInput:
 Simulate a keyboard to input text.
 
(MobileRTCRemoteControlError- remoteControlKeyInput:
 Simulate Enter key or delete key of the keyboard.
 

Properties

id< MobileRTCRemoteControlDelegate > _Nonnull delegate
 Callback event of receiving remote control.
 

Detailed Description

It provides Remote Control Service. 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

◆ grabRemoteControl:

- (MobileRTCRemoteControlError) grabRemoteControl: (UIView *_Nonnull)  remoteShareView

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

Parameters
remoteShareViewThe remote shared view.
Returns
The result of grabbing the remote control.

◆ isHaveRemoteControlRight

- (BOOL) isHaveRemoteControlRight

Query if current user have control privilege. You can have this right after be assigned to the remote control.

Returns
YES means that the user got the remote control privilege. Otherwise not.

◆ isRemoteController

- (BOOL) isRemoteController

Query if the current user gets the remote control privilege.

Returns
YES means that the user got the remote control privilege. Otherwise not.

◆ remoteControlCharInput:

- (MobileRTCRemoteControlError) remoteControlCharInput: (NSString *_Nonnull)  str

Simulate a keyboard to input text.

Parameters
strInput text from keyboard.
Returns
The result of the operation.

◆ remoteControlDoubleScroll:

- (MobileRTCRemoteControlError) remoteControlDoubleScroll: (CGPoint)  point

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

Parameters
pointIt is recommended to pass the arguments: CGPointMake(0, -1) for scrolling up, It is recommended to pass the arguments: CGPointMake(0, 1) for scrolling down.
Returns
The result of the operation.

◆ remoteControlDoubleTap:

- (MobileRTCRemoteControlError) remoteControlDoubleTap: (CGPoint)  point

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

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

◆ remoteControlKeyInput:

Simulate Enter key or delete key of the keyboard.

Parameters
keyA value of the enumeration of MobileRTCRemoteControlInputType.
Returns
The result of the operation.

◆ remoteControlLongPress:

- (MobileRTCRemoteControlError) remoteControlLongPress: (CGPoint)  point

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

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

◆ remoteControlMouseLeftDown:

- (MobileRTCRemoteControlError) remoteControlMouseLeftDown: (CGPoint)  point

Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds. This method is used to simulate a mouse left-click, such as long press on mouse icon.

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

◆ remoteControlMouseLeftDrag:

- (MobileRTCRemoteControlError) remoteControlMouseLeftDrag: (CGPoint)  point

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

Parameters
pointThe trajectory of the simulated mouse.
Returns
The result of the operation.

◆ remoteControlMouseLeftUp:

- (MobileRTCRemoteControlError) remoteControlMouseLeftUp: (CGPoint)  point

Simulate release the left mouse button.

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

◆ remoteControlSingleMove:

- (MobileRTCRemoteControlError) remoteControlSingleMove: (CGPoint)  point

Move remote cursor by dragging mouse icon on phone screen.

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

◆ remoteControlSingleTap:

- (MobileRTCRemoteControlError) remoteControlSingleTap: (CGPoint)  point

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

Parameters
pointThe point where user clicks corresponds to the location of the content.
Returns
The result of the operation.

Property Documentation

◆ delegate

- (id<MobileRTCRemoteControlDelegate> _Nonnull) delegate
readwritenonatomicassign

Callback event of receiving remote control.

Definition at line 33 of file MobileRTCRemoteControlService.h.