Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingRemoteSupportController Class Reference

Zoom SDK meeting remote support controller. More...

#include <ZoomSDKMeetingRemoteSupportController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSupportRemoteSupport
 Query Whether the meeting supports remote support.
 
(BOOL) - canRequestRemoteSupport
 Whether if the current user can request remote support.
 
(NSArray *) - getRemoteSupportUserList
 Get the list of users'IDs that can be supported remotely.
 
(ZoomSDKError- requestRemoteSupport:remoteSupportType:
 Send the request of remote support to the specified user.
 
(ZoomSDKError- stopRemoteSupport
 Stop the remote support to the specified user.
 
(ZoomSDKError- canSelectRemoteSupportScreen
 Whether if the current user is able to select remote support screen.
 
(ZoomSDKError- selectRemoteSupportScreen:
 Select the monitor of remote support to the specified user.
 

Properties

id< ZoomSDKMeetingRemoteSupportControllerDelegatedelegate
 The delegate object to receive remote support events.
 

Detailed Description

Zoom SDK meeting remote support controller.

This class provides APIs to request, grant, and manage remote support sessions during meetings.

Definition at line 100 of file ZoomSDKMeetingRemoteSupportController.h.

Method Documentation

◆ canRequestRemoteSupport

- (BOOL) canRequestRemoteSupport

Whether if the current user can request remote support.

Returns
YES means can request remote support, otherwise not.

◆ canSelectRemoteSupportScreen

- (ZoomSDKError) canSelectRemoteSupportScreen

Whether if the current user is able to select remote support screen.

Returns
If the function succeeds, it will return ZoomSDKError_Success.

◆ getRemoteSupportUserList

- (NSArray *) getRemoteSupportUserList

Get the list of users'IDs that can be supported remotely.

Returns
If the function succeeds, the return value is a pointer to the array object.

◆ isSupportRemoteSupport

- (BOOL) isSupportRemoteSupport

Query Whether the meeting supports remote support.

Returns
YES means supported, NO means not supported.

◆ requestRemoteSupport:remoteSupportType:

- (ZoomSDKError) requestRemoteSupport: (unsigned int) userId
remoteSupportType: (ZoomSDKRemoteSupportType) type 

Send the request of remote support to the specified user.

Parameters
userIdSpecify the user ID that you want to send the request.
typeSpecify category for remote support.
Returns
If the function succeeds, it will return ZoomSDKError_Success.

◆ selectRemoteSupportScreen:

- (ZoomSDKError) selectRemoteSupportScreen: (int) screenIndex

Select the monitor of remote support to the specified user.

Parameters
screenIndexSpecify the monitor index that you want to control.
Returns
If the function succeeds, it will return ZoomSDKError_Success.

◆ stopRemoteSupport

- (ZoomSDKError) stopRemoteSupport

Stop the remote support to the specified user.

Returns
If the function succeeds, it will return ZoomSDKError_Success.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingRemoteSupportControllerDelegate>) delegate
readwritenonatomicassign

The delegate object to receive remote support events.

Definition at line 105 of file ZoomSDKMeetingRemoteSupportController.h.