InMeetingRemoteController (Zoom.us SDK API Document)

public interface InMeetingRemoteController

Remote controller interface in meeting.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`InMeetingRemoteController.InMeetingRemoteControlListener`
`static class`	`InMeetingRemoteController.MobileRTCRemoteControlInputType` Type of operations when the user is in remote controlling.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(InMeetingRemoteController.InMeetingRemoteControlListener listener)` Register a listener for remote control event.
`MobileRTCSDKError`	`grabRemoteControl()` Set to enable remote control.
`boolean`	`hasRemoteControlPrivilegeWithUserId(long userID)` Query if the current user has the remote control privilege.
`boolean`	`isRemoteController()` Query if the current user gets the remote control privilege.
`MobileRTCSDKError`	`remoteControlCharInput(java.lang.String str)` Simulate keyboard input.
`MobileRTCSDKError`	`remoteControlDoubleScroll(float x, float y)` Simulate a mouse scroll with two fingers scrolling up and down.
`MobileRTCSDKError`	`remoteControlDoubleTap(float x, float y)` Simulate a mouse double-click with a finger clicking twice successively on the screen.
`MobileRTCSDKError`	`remoteControlKeyInput(InMeetingRemoteController.MobileRTCRemoteControlInputType keyType)` Simulate an Enter key or Delete key on the keyboard.
`MobileRTCSDKError`	`remoteControlLongPress(float x, float y)` Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds.
`MobileRTCSDKError`	`remoteControlSingleMove(float x, float y)` Move remote cursor by dragging mouse icon on phone.
`MobileRTCSDKError`	`remoteControlSingleTap(float x, float y)` Simulate a mouse click with a finger clicking once on the screen.
`void`	`removeListener(InMeetingRemoteController.InMeetingRemoteControlListener listener)` Unregister the listener for remote control event.
`MobileRTCSDKError`	`startRemoteControl()` Set to start remote controlling.

- Method Detail
  - addListener
```
void addListener(InMeetingRemoteController.InMeetingRemoteControlListener listener)
```
    Register a listener for remote control event.
    
    Parameters:
    
    listener - The listener instance defined in InMeetingRemoteController.InMeetingRemoteControlListener.
  - removeListener
```
void removeListener(InMeetingRemoteController.InMeetingRemoteControlListener listener)
```
    Unregister the listener for remote control event.
    
    Parameters:
    
    listener - The listener instance defined in InMeetingRemoteController.InMeetingRemoteControlListener.
  - hasRemoteControlPrivilegeWithUserId
```
boolean hasRemoteControlPrivilegeWithUserId(long userID)
```
    Query if the current user has the remote control privilege.
    
    Parameters:
    
    userID - The ID of current user who has the remote control privilege in meeting.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - startRemoteControl
```
MobileRTCSDKError startRemoteControl()
```
    Set to start remote controlling.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - isRemoteController
```
boolean isRemoteController()
```
    Query if the current user gets the remote control privilege.
    
    Returns:
    
    TRUE means that the user got the remote control privilege. FALSE not.
  - grabRemoteControl
```
MobileRTCSDKError grabRemoteControl()
```
    Set to enable remote control. User should tap the screen icon once received the privilege to control one's screen remotely.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlSingleTap
```
MobileRTCSDKError remoteControlSingleTap(float x,
                                         float y)
```
    Simulate a mouse click with a finger clicking once on the screen.
    
    Parameters:
    
    x - The value of x coordinate of the shared content window. When user clicks on phone screen, the value of the x coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that of monitor.
    
    y - The value of y coordinate of the shared content window. When user clicks on phone screen, the value of the y coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlDoubleTap
```
MobileRTCSDKError remoteControlDoubleTap(float x,
                                         float y)
```
    Simulate a mouse double-click with a finger clicking twice successively on the screen.
    
    Parameters:
    
    x - The value of x coordinate of the shared content window. When user clicks on phone screen, the value of the x coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    y - The value of y coordinate of the shared content window. When user clicks on phone screen, the value of the y coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlLongPress
```
MobileRTCSDKError remoteControlLongPress(float x,
                                         float y)
```
    Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds.
    
    Parameters:
    
    x - The value of x coordinate of the shared content window. When user clicks on phone screen, the value of the x coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    y - The value of y coordinate of the shared content window. When user clicks on phone screen, the value of the y coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlDoubleScroll
```
MobileRTCSDKError remoteControlDoubleScroll(float x,
                                            float y)
```
    Simulate a mouse scroll with two fingers scrolling up and down.
    
    Parameters:
    
    x - The value of x coordinate of the shared content window. When user clicks on phone screen, the value of the x coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    y - The value of y coordinate of the shared content window. When user clicks on phone screen, the value of the y coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlSingleMove
```
MobileRTCSDKError remoteControlSingleMove(float x,
                                          float y)
```
    Move remote cursor by dragging mouse icon on phone.
    
    Parameters:
    
    x - The value of x coordinate of the shared content window. When user clicks on phone screen, the value of the x coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    y - The value of y coordinate of the shared content window. When user clicks on phone screen, the value of the y coordinate on the phone is not as same as that of sharing monitor. The former will be converted by Api to that on the monitor.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlCharInput
```
MobileRTCSDKError remoteControlCharInput(java.lang.String str)
```
    Simulate keyboard input.
    
    Parameters:
    
    str - The characters input in remote control.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.
  - remoteControlKeyInput
```
MobileRTCSDKError remoteControlKeyInput(InMeetingRemoteController.MobileRTCRemoteControlInputType keyType)
```
    Simulate an Enter key or Delete key on the keyboard.
    
    Parameters:
    
    keyType - The types of button defined in InMeetingRemoteController.MobileRTCRemoteControlInputType.
    
    Returns:
    
    If the function succeeds, the return value is SDKErr_Success. Otherwise failed, for more details, see MobileRTCSDKError.

Interface InMeetingRemoteController

Nested Class Summary

Method Summary

Method Detail

addListener

removeListener

hasRemoteControlPrivilegeWithUserId

startRemoteControl

isRemoteController

grabRemoteControl

remoteControlSingleTap

remoteControlDoubleTap

remoteControlLongPress

remoteControlDoubleScroll

remoteControlSingleMove

remoteControlCharInput

remoteControlKeyInput