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

Helper class for managing subsessions. More...

#include <ZMVideoSDKSubsessionHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- commitSubSessionList:
 Withdraw all committed subsessions and commit the new list.
 
(ZMVideoSDKErrors- withdrawSubSessionList
 Withdraw all committed subsessions.
 
(NSArray< ZMVideoSDKSubSessionKit * > *_Nullable) - getCommittedSubSessionList
 Gets the list of commited subsessions.
 

Detailed Description

Helper class for managing subsessions.

Note
Only available to session hosts and managers.

Definition at line 139 of file ZMVideoSDKSubsessionHelper.h.

Method Documentation

◆ commitSubSessionList:

- (ZMVideoSDKErrors) commitSubSessionList: (NSArray< NSString * > *) subSessionList

Withdraw all committed subsessions and commit the new list.

Parameters
subSessionListCreate subsession name list.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getCommittedSubSessionList

- (NSArray< ZMVideoSDKSubSessionKit * > *_Nullable) getCommittedSubSessionList

Gets the list of commited subsessions.

Returns
If the function succeeds, it returns an array of ZMVideoSDKSubSessionKit. Otherwise, this function fails and returns nil.

◆ withdrawSubSessionList

- (ZMVideoSDKErrors) withdrawSubSessionList

Withdraw all committed subsessions.

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