Remote controller interface in meeting. More...

Data Structures
interface	InMeetingRemoteControlListener

enum	MobileRTCRemoteControlInputType
	Type of operations when the user is in remote controlling. More...

Public Member Functions
void	addListener (InMeetingRemoteControlListener listener)
	Register a listener for remote control event.

void	removeListener (InMeetingRemoteControlListener listener)
	Unregister the listener for remote control event.

boolean	hasRemoteControlPrivilege (long shareSourceID)
	Query if the current user has the remote control privilege.

MobileRTCSDKError	startRemoteControl (long shareSourceID)
	Set to start remote controlling.

boolean	isRemoteController (long shareSourceID)
	Query if the current user gets the remote control privilege.

MobileRTCSDKError	grabRemoteControl (long shareSourceID)
	Set to enable remote control. User should tap the screen icon once received the privilege to control one's screen remotely.

MobileRTCSDKError	remoteControlSingleTap (long shareSourceID, float x, float y)
	Simulate a mouse click with a finger clicking once on the screen.

MobileRTCSDKError	remoteControlDoubleTap (long shareSourceID, float x, float y)
	Simulate a mouse double-click with a finger clicking twice successively on the screen.

MobileRTCSDKError	remoteControlLongPress (long shareSourceID, float x, float y)
	Simulate a mouse right-click with a finger pressing phone screen for more than 3 seconds.

MobileRTCSDKError	remoteControlDoubleScroll (long shareSourceID, float x, float y)
	Simulate a mouse scroll with two fingers scrolling up and down.

MobileRTCSDKError	remoteControlSingleMove (long shareSourceID, float x, float y)
	Move remote cursor by dragging mouse icon on phone.

MobileRTCSDKError	remoteControlCharInput (long shareSourceID, String str)
	Simulate keyboard input.

MobileRTCSDKError	remoteControlKeyInput (long shareSourceID, InMeetingRemoteController.MobileRTCRemoteControlInputType keyType)
	Simulate an Enter key or Delete key on the keyboard.

Detailed Description

Remote controller interface in meeting.

Definition at line 8 of file InMeetingRemoteController.java.

Member Function Documentation

◆ addListener()

void us.zoom.sdk.InMeetingRemoteController.addListener ( InMeetingRemoteControlListener listener )

Register a listener for remote control event.

Parameters

listener The listener instance.

◆ grabRemoteControl()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.grabRemoteControl ( long shareSourceID )

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

Parameters

shareSourceID shareSourceID The source ID of user to be controlled.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ hasRemoteControlPrivilege()

boolean us.zoom.sdk.InMeetingRemoteController.hasRemoteControlPrivilege ( long shareSourceID )

Query if the current user has the remote control privilege.

Parameters

shareSourceID shareSourceID The source ID of user to be checked.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ isRemoteController()

boolean us.zoom.sdk.InMeetingRemoteController.isRemoteController ( long shareSourceID )

Query if the current user gets the remote control privilege.

Parameters

shareSourceID shareSourceID The source ID of user to be checked.

Returns: TRUE means that the user got the remote control privilege. FALSE not.

◆ remoteControlCharInput()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlCharInput	(	long	shareSourceID,
		String	str )

Simulate keyboard input.

Parameters

str	The characters input in remote control.
shareSourceID	The source ID of user to be controlled.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlDoubleScroll()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlDoubleScroll	(	long	shareSourceID,
		float	x,
		float	y )

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

Parameters

shareSourceID	The source ID of user to be controlled.
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, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlDoubleTap()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlDoubleTap	(	long	shareSourceID,
		float	x,
		float	y )

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

Parameters

shareSourceID	The source ID of user to be controlled.
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, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlKeyInput()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlKeyInput	(	long	shareSourceID,
		InMeetingRemoteController.MobileRTCRemoteControlInputType	keyType )

Simulate an Enter key or Delete key on the keyboard.

Parameters

shareSourceID	The source ID of user to be controlled.
keyType	The types of button.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlLongPress()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlLongPress	(	long	shareSourceID,
		float	x,
		float	y )

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

Parameters

shareSourceID	The source ID of user to be controlled.
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, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlSingleMove()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlSingleMove	(	long	shareSourceID,
		float	x,
		float	y )

Move remote cursor by dragging mouse icon on phone.

Parameters

shareSourceID	The source ID of user to be controlled.
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, it will return SDKERR_SUCCESS. Otherwise failed.

◆ remoteControlSingleTap()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.remoteControlSingleTap	(	long	shareSourceID,
		float	x,
		float	y )

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

Parameters

shareSourceID	The source ID of user to be controlled.
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, it will return SDKERR_SUCCESS. Otherwise failed.

◆ removeListener()

void us.zoom.sdk.InMeetingRemoteController.removeListener ( InMeetingRemoteControlListener listener )

Unregister the listener for remote control event.

Parameters

listener The listener instance.

◆ startRemoteControl()

MobileRTCSDKError us.zoom.sdk.InMeetingRemoteController.startRemoteControl ( long shareSourceID )

Set to start remote controlling.

Parameters

shareSourceID shareSourceID The source ID of user to be controlled.

Returns: If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

Data Structures

Public Member Functions

Detailed Description

Member Function Documentation

◆ addListener()

◆ grabRemoteControl()

◆ hasRemoteControlPrivilege()

◆ isRemoteController()

◆ remoteControlCharInput()

◆ remoteControlDoubleScroll()

◆ remoteControlDoubleTap()

◆ remoteControlKeyInput()

◆ remoteControlLongPress()

◆ remoteControlSingleMove()

◆ remoteControlSingleTap()

◆ removeListener()

◆ startRemoteControl()