#include <ZoomSDKRemoteControllerHelper.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- canRequestRemoteControl:
	Determine if the current user to request to control others remotely.

(ZoomSDKError)	- haveRemoteControlPrivilege:
	Determine if user has privilege to control the specified user remotely.

(ZoomSDKError)	- isInRemoteControlling:
	Determine if the current user is controlling the specified user remotely.

(ZoomSDKError)	- startRemoteControl:
	Start remotely controlling the specified user's computer.

(ZoomSDKError)	- stopRemoteControl:
	Stop controlling remotely.

(ZoomSDKError)	- requestRemoteControl:
	Request remotely control the specified user.

(ZoomSDKError)	- giveUpRemoteControl:
	Give up remotely controlling the specified user.

(ZoomSDKError)	- giveRemoteControlPrivilegeTo:
	Give the remote control privilege to the specified user.

(ZoomSDKError)	- declineRemoteControlRequest:
	Refuse the request to remote control from the specified user.

(ZoomSDKError)	- revokeRemoteControl
	Get back the authority of remote control.

(ZoomSDKError)	- getCurrentRemoteController:
	Get the identity of current controller.

(ZoomSDKError)	- sendRemoteControlEvent:ShareView:
	Send remote control action.

(BOOL)	- IsAutoAcceptRemoteControlFeatureEnabled
	Determine if the auto accept remote control requests feature is enabled in the meeting.

(ZoomSDKError)	- canEnableAutoAcceptRemoteControlFeature
	Whether the current user can enable the auto accept remote control requests feature.

(ZoomSDKError)	- enableAutoAcceptRemoteControlFeature:
	Enable or disable auto accept remote control requests feature.

Protected Attributes
id< ZoomSDKRemoteControllerDelegate >	_delegate

Properties
id< ZoomSDKRemoteControllerDelegate >	delegate

Detailed Description

Definition at line 24 of file ZoomSDKRemoteControllerHelper.h.

Method Documentation

◆ canEnableAutoAcceptRemoteControlFeature

- (ZoomSDKError) canEnableAutoAcceptRemoteControlFeature

Whether the current user can enable the auto accept remote control requests feature.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ canRequestRemoteControl:

- (ZoomSDKError) canRequestRemoteControl: (unsigned int) shareSourceID

Determine if the current user to request to control others remotely.

Parameters

shareSourceID The source ID of the user to be controlled remotely.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: For custom style mode, this interface is only valid after subscribing the sharing content from the specified user by successfully calling "- (ZoomSDKError)createShareElement:(ZoomSDKShareElement**)element" and set the share element userid.

◆ declineRemoteControlRequest:

- (ZoomSDKError) declineRemoteControlRequest: (unsigned int) userid

Refuse the request to remote control from the specified user.

Parameters

userid The ID of demander.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ enableAutoAcceptRemoteControlFeature:

- (ZoomSDKError) enableAutoAcceptRemoteControlFeature: (BOOL) enable

Enable or disable auto accept remote control requests feature.

Parameters

enable YES means that auto accept remote control requests are enabled, NO means disabled.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: Before using this interface, it is necessary to give the app accessibility permissions in the System Settings.

◆ getCurrentRemoteController:

- (ZoomSDKError) getCurrentRemoteController: (unsigned int *) userid

Get the identity of current controller.

Parameters

userid The pointer to unsigned int. If the function calls successfully, it will return the user id of current remote controller.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ giveRemoteControlPrivilegeTo:

- (ZoomSDKError) giveRemoteControlPrivilegeTo: (unsigned int) userid

Give the remote control privilege to the specified user.

Parameters

userid The ID of user that you ask to control yourself remotely.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ giveUpRemoteControl:

- (ZoomSDKError) giveUpRemoteControl: (unsigned int) shareSourceID

Give up remotely controlling the specified user.

Parameters

shareSourceID The source ID of user that was remotely controlled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

◆ haveRemoteControlPrivilege:

- (ZoomSDKError) haveRemoteControlPrivilege: (unsigned int) shareSourceID

Determine if user has privilege to control the specified user remotely.

Parameters

shareSourceID The source ID of user to be checked.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

◆ IsAutoAcceptRemoteControlFeatureEnabled

- (BOOL) IsAutoAcceptRemoteControlFeatureEnabled

Determine if the auto accept remote control requests feature is enabled in the meeting.

Returns: YES means that the feature enabled, NO means that the feature isn't enabled.

◆ isInRemoteControlling:

- (ZoomSDKError) isInRemoteControlling: (unsigned int) shareSourceID

Determine if the current user is controlling the specified user remotely.

Parameters

shareSourceID The source ID of user to be checked.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

◆ requestRemoteControl:

- (ZoomSDKError) requestRemoteControl: (unsigned int) shareSourceID

Request remotely control the specified user.

Parameters

shareSourceID The source ID of user to be controlled.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

◆ revokeRemoteControl

- (ZoomSDKError) revokeRemoteControl

Get back the authority of remote control.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ sendRemoteControlEvent:ShareView:

- (ZoomSDKError) sendRemoteControlEvent:		(NSEvent *)	theEvent
ShareView:		(NSView *)	shareView

Send remote control action.

Parameters

theEvent	The mouse or keyboard event.
shareView	The view that you want to control remotely.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ startRemoteControl:

- (ZoomSDKError) startRemoteControl: (unsigned int) shareSourceID

Start remotely controlling the specified user's computer.

Parameters

shareSourceID The source ID of user to be controlled remotely.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

◆ stopRemoteControl:

- (ZoomSDKError) stopRemoteControl: (unsigned int) shareSourceID

Stop controlling remotely.

Parameters

shareSourceID The source ID of user who is controlled remotely by the current user.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise the function fails.

Field Documentation

◆ _delegate

- (id<ZoomSDKRemoteControllerDelegate>) _delegate

protected

Definition at line 26 of file ZoomSDKRemoteControllerHelper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKRemoteControllerDelegate>) delegate

readwritenonatomicassign

Definition at line 29 of file ZoomSDKRemoteControllerHelper.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ canEnableAutoAcceptRemoteControlFeature

◆ canRequestRemoteControl:

◆ declineRemoteControlRequest:

◆ enableAutoAcceptRemoteControlFeature:

◆ getCurrentRemoteController:

◆ giveRemoteControlPrivilegeTo:

◆ giveUpRemoteControl:

◆ haveRemoteControlPrivilege:

◆ IsAutoAcceptRemoteControlFeatureEnabled

◆ isInRemoteControlling:

◆ requestRemoteControl:

◆ revokeRemoteControl

◆ sendRemoteControlEvent:ShareView:

◆ startRemoteControl:

◆ stopRemoteControl:

Field Documentation

◆ _delegate

Property Documentation

◆ delegate