ZoomVideoSDKSubSessionHelper Class Reference

Subsession helper interface. More...

#include <ZoomVideoSDKSubSessionHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- addSubSessionToPreList:
	Add a subsession name to prepared list.
(ZoomVideoSDKError)	- removeSubSessionFromPreList:
	Remove a subsession name from prepared list.
(ZoomVideoSDKError)	- clearSubSessionPreList
	Clear the prepared list.
(NSArray< NSString * > *_Nullable)	- getSubSessionPreList
	Get the subsession name prepared list.
(ZoomVideoSDKError)	- commitSubSessionList
	Withdraw all committed subsession list and commit the prepared list.
(NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable)	- getCommittedSubSessionList
	Get the commited subsession list.
(ZoomVideoSDKError)	- withdrawSubSessionList
	Withdraw 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

Add a subsession name to prepared list.

Returns

If the function succeeds, the return value is Errors_Success, otherwise not.

clearSubSessionPreList

- (ZoomVideoSDKError) clearSubSessionPreList

Clear the prepared list.

Returns

If the function succeeds, the return value is Errors_Success, otherwise not.

commitSubSessionList

- (ZoomVideoSDKError) commitSubSessionList

Withdraw all committed subsession list and commit the prepared list.

Returns

If the function succeeds, the return value is Errors_Success, otherwise not.

Note

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

getCommittedSubSessionList

- (NSArray< ZoomVideoSDKSubSessionKit * > *_Nullable) getCommittedSubSessionList

Get the commited subsession list.

Returns

If the function succeeds, it returns an array of ISubSessionKit. Otherwise returns NULL.

getSubSessionPreList

- (NSArray< NSString * > *_Nullable) getSubSessionPreList

Get the subsession name prepared list.

Returns

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

removeSubSessionFromPreList:

- (ZoomVideoSDKError) removeSubSessionFromPreList:

(NSArray< NSString * > *_Nonnull)

subSessionNames

Remove a subsession name from prepared list.

Returns

If the function succeeds, the return value is Errors_Success, otherwise not.

withdrawSubSessionList

- (ZoomVideoSDKError) withdrawSubSessionList

Withdraw all committed subsession list.

Returns

If the function succeeds, the return value is Errors_Success, otherwise not.

Note

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