Subsession helper interface. More...

#include <ZoomVideoSDKSubSessionHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- addSubSessionToPreList:
	Adds a subsession name to prepared list.

(ZoomVideoSDKError)	- removeSubSessionFromPreList:
	Removes a subsession name from prepared list.

(ZoomVideoSDKError)	- clearSubSessionPreList
	Clears the prepared list.

(NSArray< NSString * > *_Nullable)	- getSubSessionPreList
	Gets the subsession name prepared list.

(ZoomVideoSDKError)	- commitSubSessionList
	Withdraws all committed subsession list and commits the prepared list.

(NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable)	- getCommittedSubSessionList
	Gets the committed subsession list.

(ZoomVideoSDKError)	- withdrawSubSessionList
	Withdraws all committed subsession list.

Detailed Description

Subsession helper interface.

Note: Only session host and manager can get this helper.

Definition at line 142 of file ZoomVideoSDKSubSessionHelper.h.

Method Documentation

◆ addSubSessionToPreList:

- (ZoomVideoSDKError) addSubSessionToPreList: (NSArray< NSString * > *_Nonnull) subSessionNames

Adds a subsession name to prepared list.

Parameters

subSessionNames The array of subsession names to add.

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

◆ clearSubSessionPreList

- (ZoomVideoSDKError) clearSubSessionPreList

Clears the prepared list.

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

◆ commitSubSessionList

- (ZoomVideoSDKError) commitSubSessionList

Withdraws all committed subsession list and commits the prepared list.

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

Note: If the function succeeds, the prepared list will be cleared, 'onSubSessionListUpdate' is the corresponding callback notification.

◆ getCommittedSubSessionList

- (NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable) getCommittedSubSessionList

Gets the committed subsession list.

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKSubSessionKit objects. Otherwise, this function fails and returns nil.

◆ getSubSessionPreList

- (NSArray< NSString * > *_Nullable) getSubSessionPreList

Gets the subsession name prepared list.

Returns: If the function succeeds, it returns an array of SubSession name.

◆ removeSubSessionFromPreList:

- (ZoomVideoSDKError) removeSubSessionFromPreList: (NSArray< NSString * > *_Nonnull) subSessionNames

Removes a subsession name from prepared list.

Parameters

subSessionNames The array of subsession names to remove.

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

◆ withdrawSubSessionList

- (ZoomVideoSDKError) withdrawSubSessionList

Withdraws all committed subsession list.

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

Note: If the function succeeds, the prepared list will be cleared, 'onSubSessionStatusChanged' is the corresponding callback notification.

Instance Methods