Helper class to manage remote control operations in Zoom meeting.
More...
#include <ZoomSDKRemoteControllerHelper.h>
Inherits NSObject.
Helper class to manage remote control operations in Zoom meeting.
Definition at line 35 of file ZoomSDKRemoteControllerHelper.h.
◆ canEnableAutoAcceptRemoteControlFeature
Whether the current user can enable the auto accept remote control requests feature.
- Returns
- If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ canRequestRemoteControl:
| - (ZoomSDKError) canRequestRemoteControl: |
|
(unsigned int) | shareSourceID |
|
Determines if the current user to request to control others remotely.
- Parameters
-
| shareSourceID | The user's source ID to be controlled remotely. |
- Returns
- If the function succeeds, it returns the
ZoomSDKError_Success. Otherwise, this function returns an error.
- 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ enableAutoAcceptRemoteControlFeature:
| - (ZoomSDKError) enableAutoAcceptRemoteControlFeature: |
|
(BOOL) | enable |
|
Enables or disable auto accept remote control requests feature.
- Parameters
-
| enable | YES if auto accept remote control requests are enabled, NO if disabled. |
- Returns
- If the function succeeds, it returns the
ZoomSDKError_Success. Otherwise, this function returns an error.
- Note
- Before using this interface, it is necessary to give the app accessibility permissions in the System Settings.
◆ getCurrentRemoteController:
| - (ZoomSDKError) getCurrentRemoteController: |
|
(unsigned int *) | userid |
|
Gets the identity of current controller.
- Parameters
-
| userid | The pointer to unsigned int. If the function calls successfully, it returns the user ID of current remote controller. |
- Returns
- If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ 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, this function returns an error.
◆ haveRemoteControlPrivilege:
| - (ZoomSDKError) haveRemoteControlPrivilege: |
|
(unsigned int) | shareSourceID |
|
Determines 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, this function returns an error.
◆ IsAutoAcceptRemoteControlFeatureEnabled
| - (BOOL) IsAutoAcceptRemoteControlFeatureEnabled |
|
|
|
Determines if the auto accept remote control requests feature is enabled in the meeting.
- Returns
- YES if the feature enabled. Otherwise, NO.
◆ isInRemoteControlling:
| - (ZoomSDKError) isInRemoteControlling: |
|
(unsigned int) | shareSourceID |
|
Determines 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, this function returns an error.
◆ 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, this function returns an error.
◆ revokeRemoteControl
Gets back the authority of remote control.
- Returns
- If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ sendRemoteControlEvent:ShareView:
| - (ZoomSDKError) sendRemoteControlEvent: |
|
(NSEvent *) | theEvent |
| ShareView: |
|
(NSView *) | shareView |
Sends 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.
◆ startRemoteControl:
| - (ZoomSDKError) startRemoteControl: |
|
(unsigned int) | shareSourceID |
|
Starts 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, this function returns an error.
◆ stopRemoteControl:
| - (ZoomSDKError) stopRemoteControl: |
|
(unsigned int) | shareSourceID |
|
Stops 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, this function returns an error.
◆ _delegate
◆ delegate
1.12.0