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

Represents a subsession instance. More...

#include <ZoomVideoSDKSubSessionHelper.h>

Inherits NSObject.

Instance Methods

(NSString *_Nullable) - getSubSessionName
 Gets the subsession's name.
 
(NSString *_Nullable) - getSubSessionID
 Gets the subsession's ID.
 
(NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable) - getSubSessionUserList
 Gets the user list in this subsession.
 
(ZoomVideoSDKError- joinSubSession
 Joins this subsession.
 

Detailed Description

Represents a subsession instance.

Definition at line 62 of file ZoomVideoSDKSubSessionHelper.h.

Method Documentation

◆ getSubSessionID

- (NSString *_Nullable) getSubSessionID

Gets the subsession's ID.

Returns
The subsession ID.

◆ getSubSessionName

- (NSString *_Nullable) getSubSessionName

Gets the subsession's name.

Returns
The subsession name.

◆ getSubSessionUserList

- (NSArray< ZoomVideoSDKSubSessionUser * > *_Nullable) getSubSessionUserList

Gets the user list in this subsession.

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

◆ joinSubSession

- (ZoomVideoSDKError) joinSubSession

Joins this subsession.

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