Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSubSessionParticipant Class Reference

Interface for subsession participants. More...

#include <ZMVideoSDKSubsessionHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors) - returnToMainSession
 Return to main session.
(ZMVideoSDKErrors) - requestForHelp
 Requests help.
(NSArray< ZMVideoSDKSubSessionUser * > *_Nullable) - getMainSessionUserList
 Gets lightweight users in the main session.

Detailed Description

Interface for subsession participants.

Definition at line 121 of file ZMVideoSDKSubsessionHelper.h.

Method Documentation

◆ getMainSessionUserList

- (NSArray< ZMVideoSDKSubSessionUser * > *_Nullable) getMainSessionUserList

Gets lightweight users in the main session.

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

References getMainSessionUserList.

Referenced by getMainSessionUserList.

◆ requestForHelp

- (ZMVideoSDKErrors) requestForHelp

Requests help.

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

References requestForHelp.

Referenced by requestForHelp.

◆ returnToMainSession

- (ZMVideoSDKErrors) returnToMainSession

Return to main session.

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

References returnToMainSession.

Referenced by returnToMainSession.