Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSubSessionParticipant Class Reference

SubSession attendee helper interface. More...

#include <ZoomVideoSDKSubSessionHelper.h>

Inherits NSObject.

Instance Methods

(ZoomVideoSDKError) - returnToMainSession
 Returns to main session.
(ZoomVideoSDKError) - requestForHelp
 Requests for help.
(NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable) - getMainSessionUserList
 Gets main-session users with stable GUID and node ID information.

Detailed Description

SubSession attendee helper interface.

Definition at line 133 of file ZoomVideoSDKSubSessionHelper.h.

Method Documentation

◆ getMainSessionUserList

- (NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable) getMainSessionUserList

Gets main-session users with stable GUID and node ID information.

Returns
A snapshot of the current main-session user list, or nil when unavailable.

References getMainSessionUserList.

Referenced by getMainSessionUserList.

◆ requestForHelp

- (ZoomVideoSDKError) requestForHelp

Requests for help.

Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.
Note
'onSubSessionUserHelpRequestResult' is the corresponding callback notification.

References requestForHelp.

Referenced by requestForHelp.

◆ returnToMainSession

- (ZoomVideoSDKError) returnToMainSession

Returns to main session.

Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

References returnToMainSession.

Referenced by returnToMainSession.