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

Represents a subsession instance. More...

#include <ZMVideoSDKSubsessionHelper.h>

Inherits NSObject.

Instance Methods

(NSArray< ZMVideoSDKSubSessionUser * > *_Nullable) - getSubSessionUserList
 Gets the list of users in this subsession.
 
(ZMVideoSDKErrors- joinSubSession
 Joins this subsession.
 

Properties

NSString * subSessionName
 Gets the subsession's name.
 
NSString * subSessionID
 Gets the subsession's ID.
 

Detailed Description

Represents a subsession instance.

Definition at line 31 of file ZMVideoSDKSubsessionHelper.h.

Method Documentation

◆ getSubSessionUserList

- (NSArray< ZMVideoSDKSubSessionUser * > *_Nullable) getSubSessionUserList

Gets the list of users in this subsession.

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

◆ joinSubSession

- (ZMVideoSDKErrors) joinSubSession

Joins this subsession.

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

Property Documentation

◆ subSessionID

- (NSString*) subSessionID
readnonatomiccopy

Gets the subsession's ID.

Definition at line 39 of file ZMVideoSDKSubsessionHelper.h.

◆ subSessionName

- (NSString*) subSessionName
readnonatomiccopy

Gets the subsession's name.

Definition at line 35 of file ZMVideoSDKSubsessionHelper.h.